feat(editor): add toolbar registry extension (#9572)
### 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`](c178debf2d/blocksuite/affine/shared/src/services/toolbar-service/config.ts). 1. Add toolbar configuration file to a block type, such as bookmark block: [`config.ts`](c178debf2d/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](c178debf2d/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](c178debf2d/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.
This commit is contained in:
@@ -157,14 +157,14 @@ test('should preview PDF in embed view', async ({ page }) => {
|
||||
await insertAttachment(page, fixturesDir.join('lorem-ipsum.pdf').value);
|
||||
|
||||
const attachment = page.locator('affine-attachment');
|
||||
await attachment.hover();
|
||||
await attachment.click();
|
||||
|
||||
const attachmentToolbar = page.locator('.affine-attachment-toolbar');
|
||||
await expect(attachmentToolbar).toBeVisible();
|
||||
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
||||
await expect(toolbar).toBeVisible();
|
||||
|
||||
// Switches to embed view
|
||||
await attachmentToolbar.getByRole('button', { name: 'Switch view' }).click();
|
||||
await attachmentToolbar.getByRole('button', { name: 'Embed view' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Switch view' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Embed view' }).click();
|
||||
|
||||
await page.waitForTimeout(500);
|
||||
|
||||
@@ -207,7 +207,6 @@ test('should preview PDF in embed view', async ({ page }) => {
|
||||
await doc1.click();
|
||||
|
||||
const inlineLink = page.locator('affine-reference').nth(0);
|
||||
const inlineToolbar = page.locator('reference-popup');
|
||||
const inlineTitle = inlineLink.locator('.affine-reference-title');
|
||||
|
||||
await expect(inlineTitle).toHaveText('PDF preview');
|
||||
@@ -219,10 +218,10 @@ test('should preview PDF in embed view', async ({ page }) => {
|
||||
await page.waitForTimeout(500);
|
||||
await page.mouse.click(bouding!.x - 50, bouding!.y + bouding!.height / 2);
|
||||
|
||||
await inlineLink.hover({ timeout: 500 });
|
||||
await inlineLink.hover();
|
||||
|
||||
// Edits title
|
||||
await inlineToolbar.getByRole('button', { name: 'Edit' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Edit' }).click();
|
||||
|
||||
// Title alias
|
||||
await page.keyboard.type('PDF embed preview');
|
||||
@@ -264,10 +263,10 @@ test('should sync name in pdf embed view', async ({ page }) => {
|
||||
await insertAttachment(page, fixturesDir.join('lorem-ipsum.pdf').value);
|
||||
|
||||
const attachment = page.locator('affine-attachment');
|
||||
await attachment.hover();
|
||||
await attachment.click();
|
||||
|
||||
const attachmentToolbar = page.locator('.affine-attachment-toolbar');
|
||||
await expect(attachmentToolbar).toBeVisible();
|
||||
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
||||
await expect(toolbar).toBeVisible();
|
||||
|
||||
const attachmentTitle = attachment.locator(
|
||||
'.affine-attachment-content-title-text'
|
||||
@@ -275,7 +274,7 @@ test('should sync name in pdf embed view', async ({ page }) => {
|
||||
await expect(attachmentTitle).toHaveText('lorem-ipsum.pdf');
|
||||
|
||||
// Renames
|
||||
await attachmentToolbar.getByRole('button', { name: 'Rename' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Rename' }).click();
|
||||
const input = page
|
||||
.locator('.affine-attachment-rename-input-wrapper')
|
||||
.locator('input');
|
||||
@@ -283,11 +282,11 @@ test('should sync name in pdf embed view', async ({ page }) => {
|
||||
await page.keyboard.press('Enter');
|
||||
await expect(attachmentTitle).toHaveText('What is Lorem Ipsum.pdf');
|
||||
|
||||
await attachment.hover();
|
||||
await attachment.click();
|
||||
|
||||
// Switches to embed view
|
||||
await attachmentToolbar.getByRole('button', { name: 'Switch view' }).click();
|
||||
await attachmentToolbar.getByRole('button', { name: 'Embed view' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Switch view' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Embed view' }).click();
|
||||
|
||||
await page.waitForTimeout(500);
|
||||
|
||||
@@ -298,10 +297,10 @@ test('should sync name in pdf embed view', async ({ page }) => {
|
||||
await page.waitForTimeout(500);
|
||||
await expect(portalName).toHaveText('What is Lorem Ipsum.pdf');
|
||||
|
||||
await attachment.hover();
|
||||
await attachment.click();
|
||||
|
||||
// Renames
|
||||
await attachmentToolbar.getByRole('button', { name: 'Rename' }).click();
|
||||
await toolbar.getByRole('button', { name: 'Rename' }).click();
|
||||
await input.fill('lorem-ipsum');
|
||||
await page.keyboard.press('Enter');
|
||||
await expect(portalName).toHaveText('lorem-ipsum.pdf');
|
||||
|
||||
Reference in New Issue
Block a user