mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-13 21:05:19 +00: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.
277 lines
9.0 KiB
TypeScript
277 lines
9.0 KiB
TypeScript
import type { DatabaseBlockModel } from '@blocksuite/affine-model';
|
|
import { expect, type Page } from '@playwright/test';
|
|
|
|
import { switchEditorMode } from './utils/actions/edgeless.js';
|
|
import { getLinkedDocPopover } from './utils/actions/linked-doc.js';
|
|
import {
|
|
enterPlaygroundRoom,
|
|
focusRichText,
|
|
initEmptyEdgelessState,
|
|
initEmptyParagraphState,
|
|
waitNextFrame,
|
|
} from './utils/actions/misc.js';
|
|
import { test } from './utils/playwright.js';
|
|
|
|
test.describe('Embed synced doc', () => {
|
|
test.beforeEach(async ({ page }) => {
|
|
await enterPlaygroundRoom(page);
|
|
});
|
|
|
|
async function createAndConvertToEmbedSyncedDoc(page: Page) {
|
|
const { createLinkedDoc } = getLinkedDocPopover(page);
|
|
const linkedDoc = await createLinkedDoc('page1');
|
|
const lickedDocBox = await linkedDoc.boundingBox();
|
|
if (!lickedDocBox) {
|
|
throw new Error('lickedDocBox is not found');
|
|
}
|
|
await page.mouse.move(
|
|
lickedDocBox.x + lickedDocBox.width / 2,
|
|
lickedDocBox.y + lickedDocBox.height / 2
|
|
);
|
|
|
|
await waitNextFrame(page, 200);
|
|
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
|
await expect(toolbar).toBeVisible();
|
|
|
|
const switchButton = toolbar.getByRole('button', { name: 'Switch view' });
|
|
await switchButton.click();
|
|
|
|
const embedSyncedDocBtn = toolbar.getByRole('button', {
|
|
name: 'Embed view',
|
|
});
|
|
await expect(embedSyncedDocBtn).toBeVisible();
|
|
|
|
await embedSyncedDocBtn.click();
|
|
await waitNextFrame(page, 200);
|
|
|
|
const embedSyncedBlock = page.locator('affine-embed-synced-doc-block');
|
|
expect(await embedSyncedBlock.count()).toBe(1);
|
|
}
|
|
|
|
test('can change linked doc to embed synced doc', async ({ page }) => {
|
|
await initEmptyParagraphState(page);
|
|
await focusRichText(page);
|
|
|
|
await createAndConvertToEmbedSyncedDoc(page);
|
|
});
|
|
|
|
test('can change embed synced doc to card view', async ({ page }) => {
|
|
await initEmptyParagraphState(page);
|
|
await focusRichText(page);
|
|
|
|
await createAndConvertToEmbedSyncedDoc(page);
|
|
|
|
const syncedDoc = page.locator(`affine-embed-synced-doc-block`);
|
|
const syncedDocBox = await syncedDoc.boundingBox();
|
|
if (!syncedDocBox) {
|
|
throw new Error('syncedDocBox is not found');
|
|
}
|
|
await page.mouse.click(
|
|
syncedDocBox.x + syncedDocBox.width / 2,
|
|
syncedDocBox.y + syncedDocBox.height / 2
|
|
);
|
|
|
|
await waitNextFrame(page, 200);
|
|
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
|
await expect(toolbar).toBeVisible();
|
|
|
|
const switchBtn = toolbar.getByRole('button', { name: 'Switch view' });
|
|
await expect(switchBtn).toBeVisible();
|
|
|
|
await switchBtn.click();
|
|
await waitNextFrame(page, 200);
|
|
|
|
const cardBtn = toolbar.getByRole('button', { name: 'Card view' });
|
|
await cardBtn.click();
|
|
await waitNextFrame(page, 200);
|
|
|
|
const embedSyncedBlock = page.locator('affine-embed-linked-doc-block');
|
|
expect(await embedSyncedBlock.count()).toBe(1);
|
|
});
|
|
|
|
test.fixme(
|
|
'drag embed synced doc to whiteboard should fit in height',
|
|
async ({ page }) => {
|
|
await initEmptyEdgelessState(page);
|
|
await focusRichText(page);
|
|
|
|
await createAndConvertToEmbedSyncedDoc(page);
|
|
|
|
// Focus on the embed synced doc
|
|
const embedSyncedBlock = page.locator('affine-embed-synced-doc-block');
|
|
let embedSyncedBox = await embedSyncedBlock.boundingBox();
|
|
if (!embedSyncedBox) {
|
|
throw new Error('embedSyncedBox is not found');
|
|
}
|
|
await page.mouse.click(
|
|
embedSyncedBox.x + embedSyncedBox.width / 2,
|
|
embedSyncedBox.y + embedSyncedBox.height / 2
|
|
);
|
|
|
|
// Switch to edgeless mode
|
|
await switchEditorMode(page);
|
|
await waitNextFrame(page, 200);
|
|
|
|
// Double click on note to enter edit status
|
|
const noteBlock = page.locator('affine-edgeless-note');
|
|
const noteBlockBox = await noteBlock.boundingBox();
|
|
if (!noteBlockBox) {
|
|
throw new Error('noteBlockBox is not found');
|
|
}
|
|
await page.mouse.dblclick(noteBlockBox.x + 10, noteBlockBox.y + 10);
|
|
await waitNextFrame(page, 200);
|
|
|
|
// Drag the embed synced doc to whiteboard
|
|
embedSyncedBox = await embedSyncedBlock.boundingBox();
|
|
if (!embedSyncedBox) {
|
|
throw new Error('embedSyncedBox is not found');
|
|
}
|
|
const height = embedSyncedBox.height;
|
|
await page.mouse.move(embedSyncedBox.x - 10, embedSyncedBox.y - 100);
|
|
await page.mouse.move(embedSyncedBox.x - 10, embedSyncedBox.y + 10);
|
|
await waitNextFrame(page);
|
|
await page.mouse.down();
|
|
await page.mouse.move(100, 200, { steps: 30 });
|
|
await page.mouse.up();
|
|
|
|
// Check the height of the embed synced doc portal, it should be the same as the embed synced doc in note
|
|
const EmbedSyncedDocBlock = page.locator(
|
|
'affine-embed-edgeless-synced-doc-block'
|
|
);
|
|
const EmbedSyncedDocBlockBox = await EmbedSyncedDocBlock.boundingBox();
|
|
const border = 1;
|
|
if (!EmbedSyncedDocBlockBox) {
|
|
throw new Error('EmbedSyncedDocBlockBox is not found');
|
|
}
|
|
expect(EmbedSyncedDocBlockBox.height).toBeCloseTo(height + 2 * border, 1);
|
|
}
|
|
);
|
|
|
|
test('nested embed synced doc should be rendered as card when depth >=1', async ({
|
|
page,
|
|
}) => {
|
|
await page.evaluate(() => {
|
|
const { doc, collection } = window;
|
|
const rootId = doc.addBlock('affine:page', {
|
|
title: new window.$blocksuite.store.Text(),
|
|
});
|
|
|
|
const noteId = doc.addBlock('affine:note', {}, rootId);
|
|
doc.addBlock('affine:paragraph', {}, noteId);
|
|
|
|
const doc2 = collection.createDoc({ id: 'doc2' });
|
|
doc2.load();
|
|
const rootId2 = doc2.addBlock('affine:page', {
|
|
title: new window.$blocksuite.store.Text('Doc 2'),
|
|
});
|
|
|
|
const noteId2 = doc2.addBlock('affine:note', {}, rootId2);
|
|
doc2.addBlock(
|
|
'affine:paragraph',
|
|
{
|
|
text: new window.$blocksuite.store.Text('Hello from Doc 2'),
|
|
},
|
|
noteId2
|
|
);
|
|
|
|
const doc3 = collection.createDoc({ id: 'doc3' });
|
|
doc3.load();
|
|
const rootId3 = doc3.addBlock('affine:page', {
|
|
title: new window.$blocksuite.store.Text('Doc 3'),
|
|
});
|
|
|
|
const noteId3 = doc3.addBlock('affine:note', {}, rootId3);
|
|
doc3.addBlock(
|
|
'affine:paragraph',
|
|
{
|
|
text: new window.$blocksuite.store.Text('Hello from Doc 3'),
|
|
},
|
|
noteId3
|
|
);
|
|
|
|
doc2.addBlock(
|
|
'affine:embed-synced-doc',
|
|
{
|
|
pageId: 'doc3',
|
|
},
|
|
noteId2
|
|
);
|
|
doc.addBlock(
|
|
'affine:embed-synced-doc',
|
|
{
|
|
pageId: 'doc2',
|
|
},
|
|
noteId
|
|
);
|
|
});
|
|
expect(await page.locator('affine-embed-synced-doc-block').count()).toBe(2);
|
|
expect(await page.locator('affine-paragraph').count()).toBe(2);
|
|
expect(await page.locator('affine-embed-synced-doc-card').count()).toBe(1);
|
|
expect(await page.locator('editor-host').count()).toBe(2);
|
|
});
|
|
|
|
test.describe('synced doc should be readonly', () => {
|
|
test('synced doc should be readonly', async ({ page }) => {
|
|
await initEmptyParagraphState(page);
|
|
await focusRichText(page);
|
|
await createAndConvertToEmbedSyncedDoc(page);
|
|
|
|
const locator = page.locator('affine-embed-synced-doc-block');
|
|
await expect(locator).toBeVisible();
|
|
await locator.click();
|
|
|
|
const toolbar = page.locator('affine-toolbar-widget editor-toolbar');
|
|
const openMenu = toolbar.getByRole('button', { name: 'Open doc' });
|
|
await openMenu.click();
|
|
|
|
const button = toolbar.getByRole('button', { name: 'Open this doc' });
|
|
await button.click();
|
|
|
|
await page.evaluate(async () => {
|
|
const { collection } = window;
|
|
const getDocCollection = () => {
|
|
for (const [id, doc] of collection.docs.entries()) {
|
|
if (id === 'doc:home') {
|
|
continue;
|
|
}
|
|
return doc;
|
|
}
|
|
return null;
|
|
};
|
|
|
|
const doc2Collection = getDocCollection();
|
|
const doc2 = doc2Collection!.getStore();
|
|
const [noteBlock] = doc2!.getBlocksByFlavour('affine:note');
|
|
const noteId = noteBlock.id;
|
|
|
|
const databaseId = doc2.addBlock(
|
|
'affine:database',
|
|
{
|
|
title: new window.$blocksuite.store.Text('Database 1'),
|
|
},
|
|
noteId
|
|
);
|
|
const model = doc2.getBlockById(databaseId) as DatabaseBlockModel;
|
|
const datasource =
|
|
new window.$blocksuite.blocks.DatabaseBlockDataSource(model);
|
|
datasource.viewManager.viewAdd('table');
|
|
});
|
|
|
|
// go back to previous doc
|
|
await page.evaluate(() => {
|
|
const { collection, editor } = window;
|
|
editor.doc = collection.getDoc('doc:home')!;
|
|
});
|
|
|
|
const databaseFirstCell = page.locator(
|
|
'.affine-database-column-header.database-row'
|
|
);
|
|
await databaseFirstCell.click({ force: true });
|
|
const selectedCount = await page
|
|
.locator('.affine-embed-synced-doc-container.selected')
|
|
.count();
|
|
expect(selectedCount).toBe(1);
|
|
});
|
|
});
|
|
});
|