mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-02-15 05:37:32 +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.
135 lines
4.1 KiB
TypeScript
135 lines
4.1 KiB
TypeScript
import { test } from '@affine-test/kit/playwright';
|
|
import { locateFormatBar } from '@affine-test/kit/utils/editor';
|
|
import { openHomePage } from '@affine-test/kit/utils/load-page';
|
|
import {
|
|
clickNewPageButton,
|
|
waitForEmptyEditor,
|
|
} from '@affine-test/kit/utils/page-logic';
|
|
import { expect } from '@playwright/test';
|
|
|
|
function hexToRGB(hex: string) {
|
|
hex = hex.replace(/^#/, '');
|
|
const len = hex.length;
|
|
let arr: string[] = [];
|
|
|
|
if (len === 3 || len === 4) {
|
|
arr = hex.split('').map(s => s.repeat(2));
|
|
} else if (len === 6 || len === 8) {
|
|
arr = Array.from<number>({ length: len / 2 })
|
|
.fill(0)
|
|
.map((n, i) => n + i * 2)
|
|
.map(n => hex.substring(n, n + 2));
|
|
}
|
|
|
|
const values = arr
|
|
.map(s => parseInt(s, 16))
|
|
.map((n, i) => (i === 3 ? (n % 255) / 255 : n));
|
|
|
|
return `rgb${values.length === 4 ? 'a' : ''}(${values.join(', ')})`;
|
|
}
|
|
|
|
test.beforeEach(async ({ page }) => {
|
|
await openHomePage(page);
|
|
await clickNewPageButton(page);
|
|
await waitForEmptyEditor(page);
|
|
});
|
|
|
|
test.describe('Formatting', () => {
|
|
test('should change text color', async ({ page }) => {
|
|
await page.keyboard.press('Enter');
|
|
|
|
await page.keyboard.type('hello world');
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
|
|
const formatBar = locateFormatBar(page);
|
|
const highlightButton = formatBar.locator('affine-highlight-duotone-icon');
|
|
|
|
await highlightButton.click();
|
|
|
|
const fgGreenButton = formatBar.locator('[data-testid="foreground-green"]');
|
|
await fgGreenButton.click();
|
|
const fgColor = await fgGreenButton
|
|
.locator('affine-text-duotone-icon')
|
|
.evaluate(e => window.getComputedStyle(e).getPropertyValue('--color'));
|
|
|
|
const paragraph = page.locator('affine-paragraph');
|
|
const textSpan = paragraph
|
|
.locator('affine-text:has-text("rld")')
|
|
.locator('span')
|
|
.first();
|
|
|
|
await expect(textSpan).toBeVisible();
|
|
|
|
await expect(textSpan).toHaveCSS('color', hexToRGB(fgColor));
|
|
});
|
|
|
|
test('should change text background color', async ({ page }) => {
|
|
await page.keyboard.press('Enter');
|
|
|
|
await page.keyboard.type('hello world');
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
|
|
const formatBar = locateFormatBar(page);
|
|
const highlightButton = formatBar.locator('affine-highlight-duotone-icon');
|
|
|
|
await highlightButton.click();
|
|
|
|
const fgGreenButton = formatBar.locator('[data-testid="foreground-green"]');
|
|
await fgGreenButton.click();
|
|
|
|
await page.waitForTimeout(200);
|
|
|
|
const fgColor = await fgGreenButton
|
|
.locator('affine-text-duotone-icon')
|
|
.evaluate(e => window.getComputedStyle(e).getPropertyValue('--color'));
|
|
|
|
const paragraph = page.locator('affine-paragraph');
|
|
const textSpan1 = paragraph
|
|
.locator('affine-text:has-text("rld")')
|
|
.locator('span')
|
|
.first();
|
|
|
|
await expect(textSpan1).toHaveCSS('color', hexToRGB(fgColor));
|
|
|
|
await page.keyboard.press('ArrowRight');
|
|
|
|
for (let i = 0; i < 5; i++) {
|
|
await page.keyboard.press('Shift+ArrowLeft');
|
|
}
|
|
|
|
await highlightButton.click();
|
|
|
|
const yellow = 'var(--affine-text-highlight-yellow)';
|
|
const bgYellowButton = formatBar.locator(
|
|
'[data-testid="background-yellow"]'
|
|
);
|
|
await bgYellowButton.click();
|
|
|
|
const textSpan2 = paragraph
|
|
.locator('affine-text:has-text("wo")')
|
|
.locator('span')
|
|
.first();
|
|
|
|
await expect(textSpan2).toBeVisible();
|
|
|
|
const bgColor1 = await textSpan1.evaluate(e => e.style.backgroundColor);
|
|
const bgColor2 = await textSpan2.evaluate(e => e.style.backgroundColor);
|
|
|
|
expect(yellow).toBe(bgColor1);
|
|
expect(yellow).toBe(bgColor2);
|
|
|
|
const bgColor = await bgYellowButton
|
|
.locator('affine-text-duotone-icon')
|
|
.evaluate(e =>
|
|
window.getComputedStyle(e).getPropertyValue('--background')
|
|
);
|
|
|
|
await expect(textSpan1).toHaveCSS('background-color', hexToRGB(bgColor));
|
|
await expect(textSpan2).toHaveCSS('background-color', hexToRGB(bgColor));
|
|
});
|
|
});
|