mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-18 23:07:02 +08:00
### 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.
201 lines
6.1 KiB
TypeScript
201 lines
6.1 KiB
TypeScript
import { test } from '@affine-test/kit/playwright';
|
|
import {
|
|
clickEdgelessModeButton,
|
|
clickPageModeButton,
|
|
} from '@affine-test/kit/utils/editor';
|
|
import { openHomePage } from '@affine-test/kit/utils/load-page';
|
|
import {
|
|
clickNewPageButton,
|
|
createLinkedPage,
|
|
waitForEmptyEditor,
|
|
} from '@affine-test/kit/utils/page-logic';
|
|
import { expect } from '@playwright/test';
|
|
|
|
test.beforeEach(async ({ page }) => {
|
|
await openHomePage(page);
|
|
await clickNewPageButton(page);
|
|
await waitForEmptyEditor(page);
|
|
});
|
|
|
|
test('can open peek view via link popover', async ({ page }) => {
|
|
await page.keyboard.press('Enter');
|
|
await createLinkedPage(page, 'Test Page');
|
|
|
|
await page.locator('affine-reference').hover();
|
|
|
|
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
|
await expect(toolbar).toBeVisible();
|
|
|
|
// click more button
|
|
await toolbar.getByLabel('Open doc').click();
|
|
await toolbar.getByLabel('Open in center peek').click();
|
|
|
|
// verify peek view is opened
|
|
await expect(page.getByTestId('peek-view-modal')).toBeVisible();
|
|
await expect(page.getByTestId('peek-view-modal')).toContainText('Test Page');
|
|
|
|
// can use 'esc' to close peek view
|
|
await page.keyboard.press('Escape');
|
|
await expect(page.getByTestId('peek-view-modal')).not.toBeVisible();
|
|
});
|
|
|
|
test('can open peek view via shift+click link', async ({ page }) => {
|
|
await page.keyboard.press('Enter');
|
|
await createLinkedPage(page, 'Test Page');
|
|
|
|
await page.locator('affine-reference').click({ modifiers: ['Shift'] });
|
|
|
|
// verify peek view is opened
|
|
await expect(page.getByTestId('peek-view-modal')).toBeVisible();
|
|
await expect(page.getByTestId('peek-view-modal')).toContainText('Test Page');
|
|
|
|
// can use 'esc' to close peek view
|
|
await page.keyboard.press('Escape');
|
|
await expect(page.getByTestId('peek-view-modal')).not.toBeVisible();
|
|
});
|
|
|
|
test('can open peek view via db+click link card', async ({ page }) => {
|
|
await page.keyboard.press('Enter');
|
|
await createLinkedPage(page, 'Test Page');
|
|
|
|
await page.locator('affine-reference').hover();
|
|
|
|
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
|
await expect(toolbar).toBeVisible();
|
|
|
|
await toolbar.getByLabel('Switch view').click();
|
|
await toolbar.getByLabel('Card view').click();
|
|
|
|
await expect(
|
|
page.locator('affine-embed-linked-doc-block:has-text("Test Page")')
|
|
).toBeVisible();
|
|
|
|
// double click to open peek view
|
|
await page.locator('affine-embed-linked-doc-block').dblclick();
|
|
|
|
// verify peek view is opened
|
|
await expect(page.getByTestId('peek-view-modal')).toBeVisible();
|
|
await expect(page.getByTestId('peek-view-modal')).toContainText('Test Page');
|
|
|
|
// verify peek view can be closed by clicking close button
|
|
await page
|
|
.locator('[data-testid="peek-view-control"][data-action-name="close"]')
|
|
.click();
|
|
|
|
await expect(page.getByTestId('peek-view-modal')).not.toBeVisible();
|
|
|
|
// double click to open peek view
|
|
await page.locator('affine-embed-linked-doc-block').dblclick();
|
|
|
|
// check if open-in-new button works
|
|
await page
|
|
.locator('[data-testid="peek-view-control"][data-action-name="open"]')
|
|
.click();
|
|
|
|
// verify page is routed to the linked page
|
|
await expect(
|
|
page
|
|
.getByTestId('main-container')
|
|
.locator('doc-title:has-text("Test Page")')
|
|
).toBeVisible();
|
|
});
|
|
|
|
test('can open peek view for embedded frames', async ({ page }) => {
|
|
await page.keyboard.press('Enter');
|
|
|
|
// create a frame
|
|
await page.keyboard.insertText('```frame\nTest Frame\n```');
|
|
|
|
await clickEdgelessModeButton(page);
|
|
|
|
// select the note
|
|
await page
|
|
.locator('affine-edgeless-note:has-text("Test Frame")')
|
|
.click({ force: true });
|
|
// enter F to create a frame
|
|
await page.keyboard.press('f');
|
|
|
|
// close affine-banner
|
|
await page.locator('[data-testid=local-demo-tips-close-button]').click();
|
|
|
|
// insert the frame to page
|
|
await page
|
|
.locator('edgeless-change-frame-button:has-text("Insert into Page")')
|
|
.click();
|
|
|
|
// switch back to page mode
|
|
await clickPageModeButton(page);
|
|
|
|
// hover the frame to trigger surface-ref-toolbar
|
|
await page.locator('affine-surface-ref .affine-surface-ref').hover();
|
|
|
|
await page
|
|
.locator('.surface-ref-toolbar-container')
|
|
.locator('editor-icon-button[aria-label="Open doc"]')
|
|
.click();
|
|
|
|
await page
|
|
.locator('.surface-ref-toolbar-container')
|
|
.locator('editor-menu-action:has-text("center peek")')
|
|
.click();
|
|
|
|
// verify peek view is opened
|
|
await expect(page.getByTestId('peek-view-modal')).toBeVisible();
|
|
|
|
// check if page is in edgeless mode
|
|
await expect(
|
|
page.locator('edgeless-editor').locator('affine-frame')
|
|
).toBeInViewport();
|
|
|
|
// close peek view
|
|
await page.keyboard.press('Escape');
|
|
|
|
// check if can open peek view by shift+click
|
|
await page
|
|
.locator('affine-surface-ref .affine-surface-ref')
|
|
.click({ modifiers: ['Shift'] });
|
|
|
|
// check if page is in edgeless mode
|
|
await expect(
|
|
page.locator('edgeless-editor').locator('affine-frame')
|
|
).toBeInViewport();
|
|
|
|
// close peek view
|
|
await page.keyboard.press('Escape');
|
|
|
|
// check if can open peek view by double click
|
|
await page.locator('affine-surface-ref .affine-surface-ref').dblclick();
|
|
// check if page is in edgeless mode
|
|
await expect(
|
|
page.locator('edgeless-editor').locator('affine-frame')
|
|
).toBeInViewport();
|
|
|
|
// can close modal when navigate
|
|
await openHomePage(page);
|
|
await expect(page.getByTestId('peek-view-modal')).not.toBeVisible();
|
|
});
|
|
|
|
test.skip('can open peek view for fav link', async ({ page }) => {
|
|
// give current page a title
|
|
await page.keyboard.insertText('test page title');
|
|
await page.getByTestId('pin-button').click();
|
|
await expect(page.locator('[data-testid="pin-button"].active')).toBeVisible();
|
|
|
|
await page
|
|
.getByTestId('favourites')
|
|
.locator('[data-favourite-page-item]:has-text("test page title")')
|
|
.click({
|
|
modifiers: ['Shift'],
|
|
});
|
|
|
|
// verify peek view is opened
|
|
await expect(page.getByTestId('peek-view-modal')).toBeVisible();
|
|
await expect(page.getByTestId('peek-view-modal')).toContainText(
|
|
'test page title'
|
|
);
|
|
|
|
// can close modal when navigate
|
|
await openHomePage(page);
|
|
await expect(page.getByTestId('peek-view-modal')).not.toBeVisible();
|
|
});
|