mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-07-15 00:56:26 +08:00
ec9bd1f383
### What's Changed! #### Added Manage various types of toolbars uniformly in one place. * `affine-toolbar-widget` * `ToolbarRegistryExtension` The toolbar currently supports and handles several scenarios: 1. Select blocks: `BlockSelection` 2. Select text: `TextSelection` or `NativeSelection` 3. Hover a link: `affine-link` and `affine-reference` #### Removed Remove redundant toolbar implementations. * `attachment` toolbar * `bookmark` toolbar * `embed` toolbar * `formatting` toolbar * `affine-link` toolbar * `affine-reference` toolbar ### How to migrate? Here is an example that can help us migrate some unrefactored toolbars: Check out the more detailed types of [`ToolbarModuleConfig`](https://github.com/toeverything/AFFiNE/blob/c178debf2d49c40b753e1bcaa6f07270bdde7401/blocksuite/affine/shared/src/services/toolbar-service/config.ts). 1. Add toolbar configuration file to a block type, such as bookmark block: [`config.ts`](https://github.com/toeverything/AFFiNE/blob/c178debf2d49c40b753e1bcaa6f07270bdde7401/blocksuite/affine/block-bookmark/src/configs/toolbar.ts) ```ts export const builtinToolbarConfig = { actions: [ { id: 'a.preview', content(ctx) { const model = ctx.getCurrentModelBy(BlockSelection, BookmarkBlockModel); if (!model) return null; const { url } = model; return html`<affine-link-preview .url=${url}></affine-link-preview>`; }, }, { id: 'b.conversions', actions: [ { id: 'inline', label: 'Inline view', run(ctx) { }, }, { id: 'card', label: 'Card view', disabled: true, }, { id: 'embed', label: 'Embed view', disabled(ctx) { }, run(ctx) { }, }, ], content(ctx) { }, } satisfies ToolbarActionGroup<ToolbarAction>, { id: 'c.style', actions: [ { id: 'horizontal', label: 'Large horizontal style', }, { id: 'list', label: 'Small horizontal style', }, ], content(ctx) { }, } satisfies ToolbarActionGroup<ToolbarAction>, { id: 'd.caption', tooltip: 'Caption', icon: CaptionIcon(), run(ctx) { }, }, { placement: ActionPlacement.More, id: 'a.clipboard', actions: [ { id: 'copy', label: 'Copy', icon: CopyIcon(), run(ctx) { }, }, { id: 'duplicate', label: 'Duplicate', icon: DuplicateIcon(), run(ctx) { }, }, ], }, { placement: ActionPlacement.More, id: 'b.refresh', label: 'Reload', icon: ResetIcon(), run(ctx) { }, }, { placement: ActionPlacement.More, id: 'c.delete', label: 'Delete', icon: DeleteIcon(), variant: 'destructive', run(ctx) { }, }, ], } as const satisfies ToolbarModuleConfig; ``` 2. Add configuration extension to a block spec: [bookmark's spec](https://github.com/toeverything/AFFiNE/blob/c178debf2d49c40b753e1bcaa6f07270bdde7401/blocksuite/affine/block-bookmark/src/bookmark-spec.ts) ```ts const flavour = BookmarkBlockSchema.model.flavour; export const BookmarkBlockSpec: ExtensionType[] = [ ..., ToolbarModuleExtension({ id: BlockFlavourIdentifier(flavour), config: builtinToolbarConfig, }), ].flat(); ``` 3. If the bock type already has a toolbar configuration built in, we can customize it in the following ways: Check out the [editor's config](https://github.com/toeverything/AFFiNE/blob/c178debf2d49c40b753e1bcaa6f07270bdde7401/packages/frontend/core/src/blocksuite/extensions/editor-config/index.ts#L51C4-L54C8) file. ```ts // Defines a toolbar configuration for the bookmark block type const customBookmarkToolbarConfig = { actions: [ ... ] } as const satisfies ToolbarModuleConfig; // Adds it into the editor's config ToolbarModuleExtension({ id: BlockFlavourIdentifier('custom:affine:bookmark'), config: customBookmarkToolbarConfig, }), ``` 4. If we want to extend the global: ```ts // Defines a toolbar configuration const customWildcardToolbarConfig = { actions: [ ... ] } as const satisfies ToolbarModuleConfig; // Adds it into the editor's config ToolbarModuleExtension({ id: BlockFlavourIdentifier('custom:affine:*'), config: customWildcardToolbarConfig, }), ``` Currently, only most toolbars in page mode have been refactored. Next is edgeless mode.
93 lines
2.7 KiB
TypeScript
93 lines
2.7 KiB
TypeScript
import {
|
|
type ToolbarAction,
|
|
ToolbarContext,
|
|
} from '@blocksuite/affine-shared/services';
|
|
import {
|
|
PropTypes,
|
|
requiredProperties,
|
|
ShadowlessElement,
|
|
} from '@blocksuite/block-std';
|
|
import { SignalWatcher } from '@blocksuite/global/utils';
|
|
import { ArrowDownSmallIcon } from '@blocksuite/icons/lit';
|
|
import type { ReadonlySignal, Signal } from '@preact/signals-core';
|
|
import { property } from 'lit/decorators.js';
|
|
import { html } from 'lit-html';
|
|
import { ifDefined } from 'lit-html/directives/if-defined.js';
|
|
import { repeat } from 'lit-html/directives/repeat.js';
|
|
|
|
@requiredProperties({
|
|
actions: PropTypes.array,
|
|
context: PropTypes.instanceOf(ToolbarContext),
|
|
viewType$: PropTypes.object,
|
|
})
|
|
export class ViewDropdownMenu extends SignalWatcher(ShadowlessElement) {
|
|
@property({ attribute: false })
|
|
accessor actions!: ToolbarAction[];
|
|
|
|
@property({ attribute: false })
|
|
accessor context!: ToolbarContext;
|
|
|
|
@property({ attribute: false })
|
|
accessor viewType$!: Signal<string> | ReadonlySignal<string>;
|
|
|
|
@property({ attribute: false })
|
|
accessor toggle: ((e: CustomEvent<boolean>) => void) | undefined;
|
|
|
|
override render() {
|
|
const {
|
|
actions,
|
|
context,
|
|
toggle,
|
|
viewType$: { value: viewType },
|
|
} = this;
|
|
|
|
return html`
|
|
<editor-menu-button
|
|
@toggle=${toggle}
|
|
.contentPadding="${'8px'}"
|
|
.button=${html`
|
|
<editor-icon-button
|
|
aria-label="Switch view"
|
|
.justify="${'space-between'}"
|
|
.labelHeight="${'20px'}"
|
|
.iconContainerWidth="${'110px'}"
|
|
>
|
|
<span class="label">${viewType}</span>
|
|
${ArrowDownSmallIcon()}
|
|
</editor-icon-button>
|
|
`}
|
|
>
|
|
<div data-size="small" data-orientation="vertical">
|
|
${repeat(
|
|
actions.filter(action => {
|
|
if (typeof action.when === 'function')
|
|
return action.when(context);
|
|
return action.when ?? true;
|
|
}),
|
|
action => action.id,
|
|
({ id, label, disabled, run }) => html`
|
|
<editor-menu-action
|
|
aria-label="${label}"
|
|
data-testid="${`link-to-${id}`}"
|
|
?data-selected="${label === viewType}"
|
|
?disabled="${ifDefined(
|
|
typeof disabled === 'function' ? disabled(context) : disabled
|
|
)}"
|
|
@click=${() => run?.(context)}
|
|
>
|
|
${label}
|
|
</editor-menu-action>
|
|
`
|
|
)}
|
|
</div>
|
|
</editor-menu-button>
|
|
`;
|
|
}
|
|
}
|
|
|
|
declare global {
|
|
interface HTMLElementTagNameMap {
|
|
'affine-view-dropdown-menu': ViewDropdownMenu;
|
|
}
|
|
}
|