refactor(editor): move frame toolbar config and components to its package (#11084)

This commit is contained in:
Saul-Mirone
2025-03-21 16:47:40 +00:00
parent f5fb5c848e
commit c1d426d8e9
27 changed files with 82 additions and 53 deletions
@@ -16,6 +16,7 @@
"@blocksuite/affine-model": "workspace:*", "@blocksuite/affine-model": "workspace:*",
"@blocksuite/affine-rich-text": "workspace:*", "@blocksuite/affine-rich-text": "workspace:*",
"@blocksuite/affine-shared": "workspace:*", "@blocksuite/affine-shared": "workspace:*",
"@blocksuite/affine-widget-edgeless-toolbar": "workspace:*",
"@blocksuite/block-std": "workspace:*", "@blocksuite/block-std": "workspace:*",
"@blocksuite/global": "workspace:*", "@blocksuite/global": "workspace:*",
"@blocksuite/icons": "^2.2.6", "@blocksuite/icons": "^2.2.6",
@@ -2,7 +2,7 @@ import { EdgelessTextBlockModel } from '@blocksuite/affine-model';
import { type ToolbarModuleConfig } from '@blocksuite/affine-shared/services'; import { type ToolbarModuleConfig } from '@blocksuite/affine-shared/services';
import { createTextActions } from '@blocksuite/affine-widget-edgeless-toolbar'; import { createTextActions } from '@blocksuite/affine-widget-edgeless-toolbar';
export const builtinEdgelessTextToolbarConfig = { export const edgelessTextToolbarConfig = {
// No need to adjust element bounds, which updates itself using ResizeObserver // No need to adjust element bounds, which updates itself using ResizeObserver
actions: createTextActions(EdgelessTextBlockModel, 'edgeless-text'), actions: createTextActions(EdgelessTextBlockModel, 'edgeless-text'),
@@ -0,0 +1 @@
export * from './config';
@@ -1,3 +1,4 @@
export * from './commands'; export * from './commands';
export * from './edgeless-text-block.js'; export * from './edgeless-text-block.js';
export * from './edgeless-text-spec.js'; export * from './edgeless-text-spec.js';
export * from './edgelss-toolbar';
@@ -13,6 +13,7 @@
{ "path": "../../model" }, { "path": "../../model" },
{ "path": "../../rich-text" }, { "path": "../../rich-text" },
{ "path": "../../shared" }, { "path": "../../shared" },
{ "path": "../../widgets/widget-edgeless-toolbar" },
{ "path": "../../../framework/block-std" }, { "path": "../../../framework/block-std" },
{ "path": "../../../framework/global" }, { "path": "../../../framework/global" },
{ "path": "../../../framework/store" } { "path": "../../../framework/store" }
@@ -14,6 +14,7 @@
"@blocksuite/affine-components": "workspace:*", "@blocksuite/affine-components": "workspace:*",
"@blocksuite/affine-model": "workspace:*", "@blocksuite/affine-model": "workspace:*",
"@blocksuite/affine-shared": "workspace:*", "@blocksuite/affine-shared": "workspace:*",
"@blocksuite/affine-widget-edgeless-toolbar": "workspace:*",
"@blocksuite/affine-widget-frame-title": "workspace:*", "@blocksuite/affine-widget-frame-title": "workspace:*",
"@blocksuite/block-std": "workspace:*", "@blocksuite/block-std": "workspace:*",
"@blocksuite/global": "workspace:*", "@blocksuite/global": "workspace:*",
@@ -1,8 +1,8 @@
import { EdgelessFrameManagerIdentifier } from '@blocksuite/affine-block-frame';
import { menu } from '@blocksuite/affine-components/context-menu'; import { menu } from '@blocksuite/affine-components/context-menu';
import type { DenseMenuBuilder } from '@blocksuite/affine-widget-edgeless-toolbar';
import { FrameIcon } from '@blocksuite/icons/lit'; import { FrameIcon } from '@blocksuite/icons/lit';
import type { DenseMenuBuilder } from '../common/type.js'; import { EdgelessFrameManagerIdentifier } from '../frame-manager.js';
import { FrameConfig } from './config.js'; import { FrameConfig } from './config.js';
export const buildFrameDenseMenu: DenseMenuBuilder = (edgeless, gfx) => export const buildFrameDenseMenu: DenseMenuBuilder = (edgeless, gfx) =>
@@ -22,6 +22,7 @@ export const buildFrameDenseMenu: DenseMenuBuilder = (edgeless, gfx) =>
name: `Slide ${config.name}`, name: `Slide ${config.name}`,
select: () => { select: () => {
const frame = edgeless.std.get(EdgelessFrameManagerIdentifier); const frame = edgeless.std.get(EdgelessFrameManagerIdentifier);
// @ts-expect-error FIXME: resolve after gfx tool refactor
gfx.tool.setTool('default'); gfx.tool.setTool('default');
frame.createFrameOnViewportCenter(config.wh); frame.createFrameOnViewportCenter(config.wh);
}, },
@@ -1,9 +1,9 @@
import { EdgelessFrameManagerIdentifier } from '@blocksuite/affine-block-frame';
import { EdgelessToolbarToolMixin } from '@blocksuite/affine-widget-edgeless-toolbar'; import { EdgelessToolbarToolMixin } from '@blocksuite/affine-widget-edgeless-toolbar';
import type { GfxToolsFullOptionValue } from '@blocksuite/block-std/gfx'; import type { GfxToolsFullOptionValue } from '@blocksuite/block-std/gfx';
import { css, html, LitElement } from 'lit'; import { css, html, LitElement } from 'lit';
import { repeat } from 'lit/directives/repeat.js'; import { repeat } from 'lit/directives/repeat.js';
import { EdgelessFrameManagerIdentifier } from '../frame-manager.js';
import { FrameConfig } from './config.js'; import { FrameConfig } from './config.js';
export class EdgelessFrameMenu extends EdgelessToolbarToolMixin(LitElement) { export class EdgelessFrameMenu extends EdgelessToolbarToolMixin(LitElement) {
@@ -84,6 +84,7 @@ export class EdgelessFrameMenu extends EdgelessToolbarToolMixin(LitElement) {
(item, index) => html` (item, index) => html`
<div <div
@click=${() => { @click=${() => {
// @ts-expect-error FIXME: resolve after gfx tool refactor
gfx.tool.setTool('default'); gfx.tool.setTool('default');
frameManager.createFrameOnViewportCenter(item.wh); frameManager.createFrameOnViewportCenter(item.wh);
}} }}
@@ -0,0 +1,5 @@
export * from './config';
export * from './frame-dense-menu';
export * from './frame-menu';
export * from './frame-tool-button';
export * from './quick-tool';
@@ -0,0 +1,15 @@
import { QuickToolExtension } from '@blocksuite/affine-widget-edgeless-toolbar';
import { html } from 'lit';
import { buildFrameDenseMenu } from './frame-dense-menu';
export const frameQuickTool = QuickToolExtension('frame', ({ block, gfx }) => {
return {
type: 'frame',
content: html`<edgeless-frame-tool-button
.edgeless=${block}
></edgeless-frame-tool-button>`,
menu: buildFrameDenseMenu(block, gfx),
enable: !block.doc.readonly,
};
});
@@ -1,5 +1,16 @@
import { EdgelessFrameMenu, EdgelessFrameToolButton } from './edgeless-toolbar';
import { FrameBlockComponent } from './frame-block'; import { FrameBlockComponent } from './frame-block';
export function effects() { export function effects() {
customElements.define('affine-frame', FrameBlockComponent); customElements.define('affine-frame', FrameBlockComponent);
customElements.define('edgeless-frame-tool-button', EdgelessFrameToolButton);
customElements.define('edgeless-frame-menu', EdgelessFrameMenu);
}
declare global {
interface HTMLElementTagNameMap {
'affine-frame': FrameBlockComponent;
'edgeless-frame-tool-button': EdgelessFrameToolButton;
'edgeless-frame-menu': EdgelessFrameMenu;
}
} }
@@ -1,6 +1,7 @@
import type { FrameTool } from './frame-tool'; import type { FrameTool } from './frame-tool';
import type { PresentTool, PresentToolOption } from './preset-tool'; import type { PresentTool, PresentToolOption } from './preset-tool';
export * from './edgeless-toolbar';
export * from './frame-block'; export * from './frame-block';
export * from './frame-highlight-manager'; export * from './frame-highlight-manager';
export * from './frame-manager'; export * from './frame-manager';
@@ -11,6 +11,7 @@
{ "path": "../../components" }, { "path": "../../components" },
{ "path": "../../model" }, { "path": "../../model" },
{ "path": "../../shared" }, { "path": "../../shared" },
{ "path": "../../widgets/widget-edgeless-toolbar" },
{ "path": "../../widgets/widget-frame-title" }, { "path": "../../widgets/widget-frame-title" },
{ "path": "../../../framework/block-std" }, { "path": "../../../framework/block-std" },
{ "path": "../../../framework/global" }, { "path": "../../../framework/global" },
@@ -1,11 +0,0 @@
import type { MenuConfig } from '@blocksuite/affine-components/context-menu';
import type { BlockComponent } from '@blocksuite/block-std';
import type { GfxController } from '@blocksuite/block-std/gfx';
/**
* Helper function to build a menu configuration for a tool in dense mode
*/
export type DenseMenuBuilder = (
edgeless: BlockComponent,
gfx: GfxController
) => MenuConfig;
@@ -1,14 +1,13 @@
import { menu } from '@blocksuite/affine-components/context-menu'; import { menu } from '@blocksuite/affine-components/context-menu';
import { ConnectorMode } from '@blocksuite/affine-model'; import { ConnectorMode } from '@blocksuite/affine-model';
import { EditPropsStore } from '@blocksuite/affine-shared/services'; import { EditPropsStore } from '@blocksuite/affine-shared/services';
import type { DenseMenuBuilder } from '@blocksuite/affine-widget-edgeless-toolbar';
import { import {
ConnectorCIcon, ConnectorCIcon,
ConnectorEIcon, ConnectorEIcon,
ConnectorLIcon, ConnectorLIcon,
} from '@blocksuite/icons/lit'; } from '@blocksuite/icons/lit';
import type { DenseMenuBuilder } from '../common/type.js';
export const buildConnectorDenseMenu: DenseMenuBuilder = (edgeless, gfx) => { export const buildConnectorDenseMenu: DenseMenuBuilder = (edgeless, gfx) => {
const prevMode = const prevMode =
edgeless.std.get(EditPropsStore).lastProps$.value.connector.mode; edgeless.std.get(EditPropsStore).lastProps$.value.connector.mode;
@@ -1,7 +1,7 @@
import { menu } from '@blocksuite/affine-components/context-menu'; import { menu } from '@blocksuite/affine-components/context-menu';
import { LassoMode } from '@blocksuite/affine-shared/types'; import { LassoMode } from '@blocksuite/affine-shared/types';
import type { DenseMenuBuilder } from '@blocksuite/affine-widget-edgeless-toolbar';
import type { DenseMenuBuilder } from '../common/type.js';
import { LassoFreeHandIcon, LassoPolygonalIcon } from './icons.js'; import { LassoFreeHandIcon, LassoPolygonalIcon } from './icons.js';
export const buildLassoDenseMenu: DenseMenuBuilder = (_, gfx) => { export const buildLassoDenseMenu: DenseMenuBuilder = (_, gfx) => {
@@ -2,8 +2,7 @@ import { insertLinkByQuickSearchCommand } from '@blocksuite/affine-block-bookmar
import { menu } from '@blocksuite/affine-components/context-menu'; import { menu } from '@blocksuite/affine-components/context-menu';
import { LinkIcon } from '@blocksuite/affine-components/icons'; import { LinkIcon } from '@blocksuite/affine-components/icons';
import { TelemetryProvider } from '@blocksuite/affine-shared/services'; import { TelemetryProvider } from '@blocksuite/affine-shared/services';
import type { DenseMenuBuilder } from '@blocksuite/affine-widget-edgeless-toolbar';
import type { DenseMenuBuilder } from '../common/type.js';
export const buildLinkDenseMenu: DenseMenuBuilder = edgeless => export const buildLinkDenseMenu: DenseMenuBuilder = edgeless =>
menu.action({ menu.action({
@@ -1,10 +1,11 @@
import { frameQuickTool } from '@blocksuite/affine-block-frame';
import { shapeSeniorTool } from '@blocksuite/affine-gfx-shape';
import { import {
QuickToolExtension, QuickToolExtension,
SeniorToolExtension, SeniorToolExtension,
} from '@blocksuite/affine-widget-edgeless-toolbar'; } from '@blocksuite/affine-widget-edgeless-toolbar';
import { html } from 'lit'; import { html } from 'lit';
import { buildFrameDenseMenu } from './frame/frame-dense-menu.js';
import { buildLinkDenseMenu } from './link/link-dense-menu.js'; import { buildLinkDenseMenu } from './link/link-dense-menu.js';
const defaultQuickTool = QuickToolExtension('default', ({ block }) => { const defaultQuickTool = QuickToolExtension('default', ({ block }) => {
@@ -16,17 +17,6 @@ const defaultQuickTool = QuickToolExtension('default', ({ block }) => {
}; };
}); });
const frameQuickTool = QuickToolExtension('frame', ({ block, gfx }) => {
return {
type: 'frame',
content: html`<edgeless-frame-tool-button
.edgeless=${block}
></edgeless-frame-tool-button>`,
menu: buildFrameDenseMenu(block, gfx),
enable: !block.doc.readonly,
};
});
const connectorQuickTool = QuickToolExtension('connector', ({ block }) => { const connectorQuickTool = QuickToolExtension('connector', ({ block }) => {
return { return {
type: 'connector', type: 'connector',
@@ -69,19 +59,6 @@ const penSeniorTool = SeniorToolExtension('pen', ({ block }) => {
}; };
}); });
const shapeSeniorTool = SeniorToolExtension(
'shape',
({ block, toolbarContainer }) => {
return {
name: 'Shape',
content: html`<edgeless-shape-tool-button
.edgeless=${block}
.toolbarContainer=${toolbarContainer}
></edgeless-shape-tool-button>`,
};
}
);
const mindMapSeniorTool = SeniorToolExtension( const mindMapSeniorTool = SeniorToolExtension(
'mindMap', 'mindMap',
({ block, toolbarContainer }) => { ({ block, toolbarContainer }) => {
@@ -1,3 +1,4 @@
import { edgelessTextToolbarConfig } from '@blocksuite/affine-block-edgeless-text';
import { frameToolbarExtension } from '@blocksuite/affine-block-frame'; import { frameToolbarExtension } from '@blocksuite/affine-block-frame';
import { textToolbarConfig } from '@blocksuite/affine-gfx-text'; import { textToolbarConfig } from '@blocksuite/affine-gfx-text';
import { ToolbarModuleExtension } from '@blocksuite/affine-shared/services'; import { ToolbarModuleExtension } from '@blocksuite/affine-shared/services';
@@ -6,7 +7,6 @@ import type { ExtensionType } from '@blocksuite/store';
import { builtinBrushToolbarConfig } from './brush'; import { builtinBrushToolbarConfig } from './brush';
import { builtinConnectorToolbarConfig } from './connector'; import { builtinConnectorToolbarConfig } from './connector';
import { builtinEdgelessTextToolbarConfig } from './edgeless-text';
import { builtinGroupToolbarConfig } from './group'; import { builtinGroupToolbarConfig } from './group';
import { builtinMindmapToolbarConfig } from './mindmap'; import { builtinMindmapToolbarConfig } from './mindmap';
import { builtinLockedToolbarConfig, builtinMiscToolbarConfig } from './misc'; import { builtinLockedToolbarConfig, builtinMiscToolbarConfig } from './misc';
@@ -42,7 +42,7 @@ export const EdgelessElementToolbarExtension: ExtensionType[] = [
ToolbarModuleExtension({ ToolbarModuleExtension({
id: BlockFlavourIdentifier('affine:surface:edgeless-text'), id: BlockFlavourIdentifier('affine:surface:edgeless-text'),
config: builtinEdgelessTextToolbarConfig, config: edgelessTextToolbarConfig,
}), }),
ToolbarModuleExtension({ ToolbarModuleExtension({
@@ -36,8 +36,6 @@ import { EdgelessConnectorMenu } from './edgeless/components/toolbar/connector/c
import { EdgelessConnectorToolButton } from './edgeless/components/toolbar/connector/connector-tool-button.js'; import { EdgelessConnectorToolButton } from './edgeless/components/toolbar/connector/connector-tool-button.js';
import { EdgelessDefaultToolButton } from './edgeless/components/toolbar/default/default-tool-button.js'; import { EdgelessDefaultToolButton } from './edgeless/components/toolbar/default/default-tool-button.js';
import { EdgelessEraserToolButton } from './edgeless/components/toolbar/eraser/eraser-tool-button.js'; import { EdgelessEraserToolButton } from './edgeless/components/toolbar/eraser/eraser-tool-button.js';
import { EdgelessFrameMenu } from './edgeless/components/toolbar/frame/frame-menu.js';
import { EdgelessFrameToolButton } from './edgeless/components/toolbar/frame/frame-tool-button.js';
import { EdgelessLassoToolButton } from './edgeless/components/toolbar/lasso/lasso-tool-button.js'; import { EdgelessLassoToolButton } from './edgeless/components/toolbar/lasso/lasso-tool-button.js';
import { EdgelessLinkToolButton } from './edgeless/components/toolbar/link/link-tool-button.js'; import { EdgelessLinkToolButton } from './edgeless/components/toolbar/link/link-tool-button.js';
import { MindMapPlaceholder } from './edgeless/components/toolbar/mindmap/mindmap-importing-placeholder.js'; import { MindMapPlaceholder } from './edgeless/components/toolbar/mindmap/mindmap-importing-placeholder.js';
@@ -157,7 +155,6 @@ function registerEdgelessToolbarComponents() {
'edgeless-eraser-tool-button', 'edgeless-eraser-tool-button',
EdgelessEraserToolButton EdgelessEraserToolButton
); );
customElements.define('edgeless-frame-tool-button', EdgelessFrameToolButton);
customElements.define('edgeless-link-tool-button', EdgelessLinkToolButton); customElements.define('edgeless-link-tool-button', EdgelessLinkToolButton);
customElements.define('edgeless-lasso-tool-button', EdgelessLassoToolButton); customElements.define('edgeless-lasso-tool-button', EdgelessLassoToolButton);
customElements.define( customElements.define(
@@ -170,7 +167,6 @@ function registerEdgelessToolbarComponents() {
// Menus // Menus
customElements.define('edgeless-brush-menu', EdgelessBrushMenu); customElements.define('edgeless-brush-menu', EdgelessBrushMenu);
customElements.define('edgeless-connector-menu', EdgelessConnectorMenu); customElements.define('edgeless-connector-menu', EdgelessConnectorMenu);
customElements.define('edgeless-frame-menu', EdgelessFrameMenu);
customElements.define('edgeless-mindmap-menu', EdgelessMindmapMenu); customElements.define('edgeless-mindmap-menu', EdgelessMindmapMenu);
customElements.define('edgeless-note-menu', EdgelessNoteMenu); customElements.define('edgeless-note-menu', EdgelessNoteMenu);
customElements.define('edgeless-slide-menu', EdgelessSlideMenu); customElements.define('edgeless-slide-menu', EdgelessSlideMenu);
@@ -301,8 +297,6 @@ declare global {
'edgeless-connector-tool-button': EdgelessConnectorToolButton; 'edgeless-connector-tool-button': EdgelessConnectorToolButton;
'edgeless-default-tool-button': EdgelessDefaultToolButton; 'edgeless-default-tool-button': EdgelessDefaultToolButton;
'edgeless-eraser-tool-button': EdgelessEraserToolButton; 'edgeless-eraser-tool-button': EdgelessEraserToolButton;
'edgeless-frame-menu': EdgelessFrameMenu;
'edgeless-frame-tool-button': EdgelessFrameToolButton;
'edgeless-lasso-tool-button': EdgelessLassoToolButton; 'edgeless-lasso-tool-button': EdgelessLassoToolButton;
'edgeless-link-tool-button': EdgelessLinkToolButton; 'edgeless-link-tool-button': EdgelessLinkToolButton;
'mindmap-import-placeholder': MindMapPlaceholder; 'mindmap-import-placeholder': MindMapPlaceholder;
@@ -1,3 +1,4 @@
export * from './config'; export * from './config';
export * from './icons'; export * from './icons';
export * from './senior-tool';
export * from './shape-menu-config'; export * from './shape-menu-config';
@@ -0,0 +1,15 @@
import { SeniorToolExtension } from '@blocksuite/affine-widget-edgeless-toolbar';
import { html } from 'lit';
export const shapeSeniorTool = SeniorToolExtension(
'shape',
({ block, toolbarContainer }) => {
return {
name: 'Shape',
content: html`<edgeless-shape-tool-button
.edgeless=${block}
.toolbarContainer=${toolbarContainer}
></edgeless-shape-tool-button>`,
};
}
);
@@ -1,3 +1,6 @@
import type { MenuConfig } from '@blocksuite/affine-components/context-menu';
import type { BlockComponent } from '@blocksuite/block-std';
import type { GfxController } from '@blocksuite/block-std/gfx';
import type { TemplateResult } from 'lit'; import type { TemplateResult } from 'lit';
export type MenuItem<T> = { export type MenuItem<T> = {
@@ -15,3 +18,11 @@ export type Menu<T> = {
currentValue: T; currentValue: T;
onPick: (value: T) => void; onPick: (value: T) => void;
}; };
/**
* Helper function to build a menu configuration for a tool in dense mode
*/
export type DenseMenuBuilder = (
edgeless: BlockComponent,
gfx: GfxController
) => MenuConfig;
+2
View File
@@ -171,6 +171,7 @@ export const PackageList = [
'blocksuite/affine/model', 'blocksuite/affine/model',
'blocksuite/affine/rich-text', 'blocksuite/affine/rich-text',
'blocksuite/affine/shared', 'blocksuite/affine/shared',
'blocksuite/affine/widgets/widget-edgeless-toolbar',
'blocksuite/framework/block-std', 'blocksuite/framework/block-std',
'blocksuite/framework/global', 'blocksuite/framework/global',
'blocksuite/framework/store', 'blocksuite/framework/store',
@@ -200,6 +201,7 @@ export const PackageList = [
'blocksuite/affine/components', 'blocksuite/affine/components',
'blocksuite/affine/model', 'blocksuite/affine/model',
'blocksuite/affine/shared', 'blocksuite/affine/shared',
'blocksuite/affine/widgets/widget-edgeless-toolbar',
'blocksuite/affine/widgets/widget-frame-title', 'blocksuite/affine/widgets/widget-frame-title',
'blocksuite/framework/block-std', 'blocksuite/framework/block-std',
'blocksuite/framework/global', 'blocksuite/framework/global',
+2
View File
@@ -2509,6 +2509,7 @@ __metadata:
"@blocksuite/affine-model": "workspace:*" "@blocksuite/affine-model": "workspace:*"
"@blocksuite/affine-rich-text": "workspace:*" "@blocksuite/affine-rich-text": "workspace:*"
"@blocksuite/affine-shared": "workspace:*" "@blocksuite/affine-shared": "workspace:*"
"@blocksuite/affine-widget-edgeless-toolbar": "workspace:*"
"@blocksuite/block-std": "workspace:*" "@blocksuite/block-std": "workspace:*"
"@blocksuite/global": "workspace:*" "@blocksuite/global": "workspace:*"
"@blocksuite/icons": "npm:^2.2.6" "@blocksuite/icons": "npm:^2.2.6"
@@ -2562,6 +2563,7 @@ __metadata:
"@blocksuite/affine-components": "workspace:*" "@blocksuite/affine-components": "workspace:*"
"@blocksuite/affine-model": "workspace:*" "@blocksuite/affine-model": "workspace:*"
"@blocksuite/affine-shared": "workspace:*" "@blocksuite/affine-shared": "workspace:*"
"@blocksuite/affine-widget-edgeless-toolbar": "workspace:*"
"@blocksuite/affine-widget-frame-title": "workspace:*" "@blocksuite/affine-widget-frame-title": "workspace:*"
"@blocksuite/block-std": "workspace:*" "@blocksuite/block-std": "workspace:*"
"@blocksuite/global": "workspace:*" "@blocksuite/global": "workspace:*"