Files
AFFiNE-Mirror/blocksuite/tests-legacy/e2e/utils/actions/drag.ts
fundon ec9bd1f383 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.
2025-03-06 06:46:03 +00:00

274 lines
6.8 KiB
TypeScript

import type { Page } from '@playwright/test';
import { assertImageOption } from '../asserts.js';
import { getIndexCoordinate, waitNextFrame } from './misc.js';
export async function dragBetweenCoords(
page: Page,
from: { x: number; y: number },
to: { x: number; y: number },
options?: {
beforeMouseUp?: () => Promise<void>;
steps?: number;
click?: boolean;
button?: 'left' | 'right' | 'middle';
}
) {
const steps = options?.steps ?? 20;
const button: 'left' | 'right' | 'middle' = options?.button ?? 'left';
const { x: x1, y: y1 } = from;
const { x: x2, y: y2 } = to;
options?.click && (await page.mouse.click(x1, y1));
await page.mouse.move(x1, y1);
await page.mouse.down({ button });
await page.mouse.move(x2, y2, { steps });
await options?.beforeMouseUp?.();
await page.mouse.up({ button });
}
export async function dragBetweenIndices(
page: Page,
[startRichTextIndex, startVIndex]: [number, number],
[endRichTextIndex, endVIndex]: [number, number],
startCoordOffSet: { x: number; y: number } = { x: 0, y: 0 },
endCoordOffSet: { x: number; y: number } = { x: 0, y: 0 },
options?: {
beforeMouseUp?: () => Promise<void>;
steps?: number;
click?: boolean;
}
) {
const finalOptions = {
steps: 50,
...options,
};
const startCoord = await getIndexCoordinate(
page,
[startRichTextIndex, startVIndex],
startCoordOffSet
);
const endCoord = await getIndexCoordinate(
page,
[endRichTextIndex, endVIndex],
endCoordOffSet
);
await dragBetweenCoords(page, startCoord, endCoord, finalOptions);
}
export async function dragOverTitle(page: Page) {
const { from, to } = await page.evaluate(() => {
const titleInput = document.querySelector(
'doc-title rich-text'
) as HTMLTextAreaElement;
const titleBound = titleInput.getBoundingClientRect();
return {
from: { x: titleBound.left + 1, y: titleBound.top + 1 },
to: { x: titleBound.right - 1, y: titleBound.bottom - 1 },
};
});
await dragBetweenCoords(page, from, to, {
steps: 5,
});
}
export async function dragEmbedResizeByTopRight(page: Page) {
const { from, to } = await page.evaluate(() => {
const bottomRightButton = document.querySelector(
'.top-right'
) as HTMLInputElement;
const bottomRightButtonBound = bottomRightButton.getBoundingClientRect();
const y = bottomRightButtonBound.top;
return {
from: { x: bottomRightButtonBound.left + 5, y: y + 5 },
to: { x: bottomRightButtonBound.left + 5 - 200, y },
};
});
await dragBetweenCoords(page, from, to, {
steps: 10,
});
}
export async function dragEmbedResizeByTopLeft(page: Page) {
const { from, to } = await page.evaluate(() => {
const bottomRightButton = document.querySelector(
'.top-left'
) as HTMLInputElement;
const bottomRightButtonBound = bottomRightButton.getBoundingClientRect();
const y = bottomRightButtonBound.top;
return {
from: { x: bottomRightButtonBound.left + 5, y: y + 5 },
to: { x: bottomRightButtonBound.left + 5 + 200, y },
};
});
await dragBetweenCoords(page, from, to, {
steps: 10,
});
}
export async function dragHandleFromBlockToBlockBottomById(
page: Page,
sourceId: string,
targetId: string,
bottom = true,
offset?: number,
beforeMouseUp?: () => Promise<void>
) {
const sourceBlock = await page
.locator(`[data-block-id="${sourceId}"]`)
.boundingBox();
const targetBlock = await page
.locator(`[data-block-id="${targetId}"]`)
.boundingBox();
if (!sourceBlock || !targetBlock) {
throw new Error();
}
await page.mouse.move(
sourceBlock.x + sourceBlock.width / 2,
sourceBlock.y + sourceBlock.height / 2
);
await waitNextFrame(page);
const dragHandleContainer = page.locator('.affine-drag-handle-container');
await dragHandleContainer.hover();
const handle = await dragHandleContainer.boundingBox();
if (!handle) {
throw new Error();
}
await page.mouse.move(
handle.x + handle.width / 2,
handle.y + handle.height / 2,
{ steps: 10 }
);
await page.mouse.down();
await page.mouse.move(
targetBlock.x,
targetBlock.y + (bottom ? targetBlock.height - 1 : 1),
{
steps: 50,
}
);
if (offset) {
await page.mouse.move(
targetBlock.x + offset,
targetBlock.y + (bottom ? targetBlock.height - 1 : 1),
{
steps: 50,
}
);
}
if (beforeMouseUp) {
await beforeMouseUp();
}
await page.mouse.up();
}
export async function dragBlockToPoint(
page: Page,
sourceId: string,
point: { x: number; y: number }
) {
const sourceBlock = await page
.locator(`[data-block-id="${sourceId}"]`)
.boundingBox();
if (!sourceBlock) {
throw new Error();
}
await page.mouse.move(
sourceBlock.x + sourceBlock.width / 2,
sourceBlock.y + sourceBlock.height / 2
);
const handle = await page
.locator('.affine-drag-handle-container')
.boundingBox();
if (!handle) {
throw new Error();
}
await page.mouse.move(
handle.x + handle.width / 2,
handle.y + handle.height / 2
);
await page.mouse.down();
await page.mouse.move(point.x, point.y, {
steps: 50,
});
await page.mouse.up();
}
export async function moveToImage(page: Page) {
const { x, y } = await page.evaluate(() => {
const bottomRightButton = document.querySelector(
'affine-image img'
) as HTMLElement;
const imageClient = bottomRightButton.getBoundingClientRect();
const y = imageClient.top;
return {
x: imageClient.left + 30,
y: y + 30,
};
});
await page.mouse.move(x, y);
}
export async function popImageMoreMenu(page: Page) {
await moveToImage(page);
await assertImageOption(page);
const moreButton = page.locator('.image-toolbar-button.more');
await moreButton.click();
const menu = page.locator('.image-more-popup-menu');
const turnIntoCardButton = page.locator('editor-menu-action', {
hasText: 'Turn into card view',
});
const copyButton = page.locator('editor-menu-action', {
hasText: 'Copy',
});
const duplicateButton = page.locator('editor-menu-action', {
hasText: 'Duplicate',
});
const deleteButton = page.locator('editor-menu-action', {
hasText: 'Delete',
});
return {
menu,
copyButton,
turnIntoCardButton,
duplicateButton,
deleteButton,
};
}
export async function clickBlockDragHandle(page: Page, blockId: string) {
const blockBox = await page
.locator(`[data-block-id="${blockId}"]`)
.boundingBox();
if (!blockBox) {
throw new Error();
}
await page.mouse.move(
blockBox.x + blockBox.width / 2,
blockBox.y + blockBox.height / 2
);
const handleBox = await page
.locator('.affine-drag-handle-container')
.boundingBox();
if (!handleBox) {
throw new Error();
}
await page.mouse.click(
handleBox.x + handleBox.width / 2,
handleBox.y + handleBox.height / 2
);
}