feat(editor): add toolbar registry extension

blocksuite/affine/block-attachment/src/attachment-spec.ts

@@ -1,4 +1,9 @@
-import { BlockViewExtension, FlavourExtension } from '@blocksuite/block-std';
+import { ToolbarModuleExtension } from '@blocksuite/affine-shared/services';
+import {
+  BlockFlavourIdentifier,
+  BlockViewExtension,
+  FlavourExtension,
+} from '@blocksuite/block-std';
 import type { ExtensionType } from '@blocksuite/store';
 import { literal } from 'lit/static-html.js';
 
@@ -12,10 +17,12 @@ import {
   AttachmentEmbedService,
 } from './embed.js';
 
+const Flavour = 'affine:attachment';
+
 export const AttachmentBlockSpec: ExtensionType[] = [
-  FlavourExtension('affine:attachment'),
+  FlavourExtension(Flavour),
   AttachmentBlockService,
-  BlockViewExtension('affine:attachment', model => {
+  BlockViewExtension(Flavour, model => {
     return model.parent?.flavour === 'affine:surface'
       ? literal`affine-edgeless-attachment`
       : literal`affine-attachment`;
@@ -24,4 +31,10 @@ export const AttachmentBlockSpec: ExtensionType[] = [
   AttachmentEmbedConfigExtension(),
   AttachmentEmbedService,
   AttachmentBlockNotionHtmlAdapterExtension,
+  ToolbarModuleExtension({
+    id: BlockFlavourIdentifier(Flavour),
+    config: {
+      actions: [],
+    },
+  }),
 ];

blocksuite/affine/block-image/src/image-spec.ts

@@ -1,5 +1,7 @@
 import { ImageSelectionExtension } from '@blocksuite/affine-shared/selection';
+import { ToolbarModuleExtension } from '@blocksuite/affine-shared/services';
 import {
+  BlockFlavourIdentifier,
   BlockViewExtension,
   CommandExtension,
   FlavourExtension,
@@ -12,11 +14,13 @@ import { ImageBlockAdapterExtensions } from './adapters/extension.js';
 import { commands } from './commands/index.js';
 import { ImageBlockService, ImageDropOption } from './image-service.js';
 
+const Flavour = 'affine:image';
+
 export const ImageBlockSpec: ExtensionType[] = [
-  FlavourExtension('affine:image'),
+  FlavourExtension(Flavour),
   ImageBlockService,
   CommandExtension(commands),
-  BlockViewExtension('affine:image', model => {
+  BlockViewExtension(Flavour, model => {
     const parent = model.doc.getParent(model.id);
 
     if (parent?.flavour === 'affine:surface') {
@@ -25,10 +29,33 @@ export const ImageBlockSpec: ExtensionType[] = [
 
     return literal`affine-image`;
   }),
-  WidgetViewMapExtension('affine:image', {
+  WidgetViewMapExtension(Flavour, {
     imageToolbar: literal`affine-image-toolbar-widget`,
   }),
   ImageDropOption,
   ImageSelectionExtension,
   ImageBlockAdapterExtensions,
+  ToolbarModuleExtension({
+    id: BlockFlavourIdentifier(Flavour),
+    config: {
+      actions: [
+        {
+          id: 'copy',
+          run(_cx) {},
+        },
+        {
+          id: 'download',
+          run(_cx) {},
+        },
+        {
+          id: 'refresh',
+          run(_cx) {},
+        },
+        {
+          id: 'convertToCardView',
+          run(_cx) {},
+        },
+      ],
+    },
+  }),
 ].flat();

blocksuite/affine/shared/src/services/index.ts

@@ -14,3 +14,4 @@ export * from './parse-url-service';
 export * from './quick-search-service';
 export * from './telemetry-service';
 export * from './theme-service';
+export * from './toolbar-service';

blocksuite/affine/shared/src/services/toolbar-service/index.ts

@@ -0,0 +1,3 @@
+export * from './module';
+export * from './registry';
+export * from './utils';

blocksuite/affine/shared/src/services/toolbar-service/module.ts

@@ -0,0 +1,9 @@
+import type { BlockFlavourIdentifier } from '@blocksuite/block-std';
+
+import type { ToolbarModuleConfig } from './types';
+
+export type ToolbarModule = {
+  readonly id: ReturnType<typeof BlockFlavourIdentifier>;
+
+  readonly config: ToolbarModuleConfig;
+};

blocksuite/affine/shared/src/services/toolbar-service/registry.ts

@@ -0,0 +1,59 @@
+import {
+  type BlockStdScope,
+  LifeCycleWatcher,
+  StdIdentifier,
+} from '@blocksuite/block-std';
+import {
+  type Container,
+  createIdentifier,
+  createScope,
+} from '@blocksuite/global/di';
+import type { ExtensionType } from '@blocksuite/store';
+
+import type { ToolbarModule } from './module';
+
+export const ToolbarModuleIdentifier = createIdentifier<ToolbarModule>(
+  'AffineToolbarModuleIdentifier'
+);
+
+export const ToolbarModulesIdentifier = createIdentifier<
+  Map<string, ToolbarModule>
+>('AffineToolbarModulesIdentifier');
+
+export const ToolbarRegistryScope = createScope('AffineToolbarRegistryScope');
+
+export const ToolbarRegistryIdentifier =
+  createIdentifier<ToolbarRegistryExtension>('AffineToolbarRegistryIdentifier');
+
+export function ToolbarModuleExtension(module: ToolbarModule): ExtensionType {
+  return {
+    setup: di => {
+      di.scope(ToolbarRegistryScope).addImpl(
+        ToolbarModuleIdentifier(module.id.variant),
+        module
+      );
+    },
+  };
+}
+
+export class ToolbarRegistryExtension extends LifeCycleWatcher {
+  constructor(
+    std: BlockStdScope,
+    readonly modules: Map<string, ToolbarModule>
+  ) {
+    super(std);
+  }
+
+  static override readonly key = 'toolbar-registry';
+
+  static override setup(di: Container) {
+    di.scope(ToolbarRegistryScope)
+      .addImpl(ToolbarModulesIdentifier, provider =>
+        provider.getAll(ToolbarModuleIdentifier)
+      )
+      .addImpl(ToolbarRegistryIdentifier, this, [
+        StdIdentifier,
+        ToolbarModulesIdentifier,
+      ]);
+  }
+}

blocksuite/affine/shared/src/services/toolbar-service/types.ts

@@ -0,0 +1,42 @@
+import type { BlockStdScope } from '@blocksuite/block-std';
+import type { TemplateResult } from 'lit';
+
+type ActionBase = {
+  id: string;
+  label?: string;
+  icon?: TemplateResult;
+  score?: number;
+  when?: (cx: ToolbarContext) => boolean;
+};
+
+type Action = ActionBase & {
+  run: (cx: ToolbarContext) => void;
+};
+
+type ActionGenerator = ActionBase & {
+  // Generates an action at runtime
+  generate: (cx: ToolbarContext) => Pick<Action, 'run'>;
+};
+
+type ActionGroup = ActionBase & {
+  actions: Action[];
+};
+
+type ActionGroupGenerator = ActionBase & {
+  // Generates an action group at runtime
+  generate: (cx: ToolbarContext) => Pick<ActionGroup, 'actions'>;
+};
+
+export type ToolbarAction =
+  | Action
+  | ActionGenerator
+  | ActionGroup
+  | ActionGroupGenerator;
+
+export type ToolbarContext = {
+  std: BlockStdScope;
+};
+
+export type ToolbarModuleConfig = {
+  actions: ToolbarAction[];
+};

blocksuite/affine/shared/src/services/toolbar-service/utils.ts

@@ -0,0 +1,7 @@
+export function generateActionIdWith(
+  flavour: string,
+  name: string,
+  prefix = 'com.affine.internal'
+) {
+  return `${prefix}.${flavour}.${name}`;
+}

blocksuite/affine/widget-toolbar/src/toolbar.ts

@@ -1,5 +1,18 @@
+import {
+  ToolbarRegistryIdentifier,
+  ToolbarRegistryScope,
+} from '@blocksuite/affine-shared/services';
 import { WidgetComponent } from '@blocksuite/block-std';
 
 export const AFFINE_TOOLBAR_WIDGET = 'affine-toolbar-widget';
 
-export class AffineToolbarWidget extends WidgetComponent {}
+export class AffineToolbarWidget extends WidgetComponent {
+  override connectedCallback() {
+    super.connectedCallback();
+
+    const toolbarRegistry = this.std.container
+      .provider(ToolbarRegistryScope, this.std.provider)
+      .get(ToolbarRegistryIdentifier);
+    console.log(toolbarRegistry);
+  }
+}

blocksuite/blocks/src/root-block/edgeless/edgeless-root-spec.ts

@@ -5,6 +5,7 @@ import {
   EmbedOptionService,
   PageViewportServiceExtension,
   ThemeService,
+  ToolbarRegistryExtension,
 } from '@blocksuite/affine-shared/services';
 import { AFFINE_DRAG_HANDLE_WIDGET } from '@blocksuite/affine-widget-drag-handle';
 import { AFFINE_FRAME_TITLE_WIDGET } from '@blocksuite/affine-widget-frame-title';
@@ -102,6 +103,7 @@ const EdgelessCommonExtension: ExtensionType[] = [
   PageViewportServiceExtension,
   RootBlockAdapterExtensions,
   FileDropExtension,
+  ToolbarRegistryExtension,
 ].flat();
 
 export const EdgelessRootBlockSpec: ExtensionType[] = [

blocksuite/blocks/src/root-block/page/page-root-spec.ts

@@ -5,6 +5,7 @@ import {
   EmbedOptionService,
   PageViewportServiceExtension,
   ThemeService,
+  ToolbarRegistryExtension,
 } from '@blocksuite/affine-shared/services';
 import { AFFINE_DRAG_HANDLE_WIDGET } from '@blocksuite/affine-widget-drag-handle';
 import { AFFINE_DOC_REMOTE_SELECTION_WIDGET } from '@blocksuite/affine-widget-remote-selection';
@@ -83,6 +84,7 @@ export const PageRootBlockSpec: ExtensionType[] = [
   DNDAPIExtension,
   RootBlockAdapterExtensions,
   FileDropExtension,
+  ToolbarRegistryExtension,
 ].flat();
 
 export const PreviewPageRootBlockSpec: ExtensionType[] = [

packages/frontend/core/src/components/blocksuite/block-suite-editor/specs/common.ts

@@ -21,6 +21,7 @@ import {
   ParagraphBlockSpec,
   RefNodeSlotsExtension,
   RichTextExtensions,
+  ToolbarRegistryExtension,
 } from '@blocksuite/affine/blocks';
 import type { ExtensionType } from '@blocksuite/affine/store';
 
@@ -38,6 +39,7 @@ const CommonBlockSpecs: ExtensionType[] = [
   AttachmentBlockSpec,
   AdapterFactoryExtensions,
   FontLoaderService,
+  ToolbarRegistryExtension,
 ].flat();
 
 export const DefaultBlockSpecs: ExtensionType[] = [