feat(editor): text gfx extension (#11951)

Closes: BS-3213
This commit is contained in:
Saul-Mirone
2025-04-24 03:21:54 +00:00
parent 9d90899344
commit 2200bd7b70
18 changed files with 81 additions and 53 deletions

View File

@@ -173,7 +173,9 @@
"./fragments/doc-title": "./src/fragments/doc-title.ts", "./fragments/doc-title": "./src/fragments/doc-title.ts",
"./fragments/frame-panel": "./src/fragments/frame-panel.ts", "./fragments/frame-panel": "./src/fragments/frame-panel.ts",
"./fragments/outline": "./src/fragments/outline.ts", "./fragments/outline": "./src/fragments/outline.ts",
"./gfx/text": "./src/gfx/text.ts", "./gfx/text": "./src/gfx/text/index.ts",
"./gfx/text/store": "./src/gfx/text/store.ts",
"./gfx/text/view": "./src/gfx/text/view.ts",
"./gfx/brush": "./src/gfx/brush/index.ts", "./gfx/brush": "./src/gfx/brush/index.ts",
"./gfx/brush/store": "./src/gfx/brush/store.ts", "./gfx/brush/store": "./src/gfx/brush/store.ts",
"./gfx/brush/view": "./src/gfx/brush/view.ts", "./gfx/brush/view": "./src/gfx/brush/view.ts",

View File

@@ -11,14 +11,6 @@ import {
PageSurfaceBlockSpec, PageSurfaceBlockSpec,
SurfaceBlockAdapterExtensions, SurfaceBlockAdapterExtensions,
} from '@blocksuite/affine-block-surface'; } from '@blocksuite/affine-block-surface';
import {
groupToMarkdownAdapterMatcher,
groupToPlainTextAdapterMatcher,
} from '@blocksuite/affine-gfx-group';
import {
textToMarkdownAdapterMatcher,
textToPlainTextAdapterMatcher,
} from '@blocksuite/affine-gfx-text';
import { inlinePresetExtensions } from '@blocksuite/affine-inline-preset'; import { inlinePresetExtensions } from '@blocksuite/affine-inline-preset';
import { import {
DefaultOpenDocExtension, DefaultOpenDocExtension,
@@ -28,25 +20,12 @@ import {
} from '@blocksuite/affine-shared/services'; } from '@blocksuite/affine-shared/services';
import type { ExtensionType } from '@blocksuite/store'; import type { ExtensionType } from '@blocksuite/store';
const elementToPlainTextAdapterMatchers = [
groupToPlainTextAdapterMatcher,
textToPlainTextAdapterMatcher,
];
const elementToMarkdownAdapterMatchers = [
groupToMarkdownAdapterMatcher,
textToMarkdownAdapterMatcher,
];
const CommonBlockSpecs: ExtensionType[] = [ const CommonBlockSpecs: ExtensionType[] = [
inlinePresetExtensions, inlinePresetExtensions,
DocDisplayMetaService, DocDisplayMetaService,
EditPropsStore, EditPropsStore,
DefaultOpenDocExtension, DefaultOpenDocExtension,
FontLoaderService, FontLoaderService,
elementToPlainTextAdapterMatchers,
elementToMarkdownAdapterMatchers,
].flat(); ].flat();
const PageFirstPartyBlockSpecs: ExtensionType[] = [ const PageFirstPartyBlockSpecs: ExtensionType[] = [

View File

@@ -20,6 +20,7 @@ import { ConnectorStoreExtension } from '@blocksuite/affine-gfx-connector/store'
import { GroupStoreExtension } from '@blocksuite/affine-gfx-group/store'; import { GroupStoreExtension } from '@blocksuite/affine-gfx-group/store';
import { MindmapStoreExtension } from '@blocksuite/affine-gfx-mindmap/store'; import { MindmapStoreExtension } from '@blocksuite/affine-gfx-mindmap/store';
import { ShapeStoreExtension } from '@blocksuite/affine-gfx-shape/store'; import { ShapeStoreExtension } from '@blocksuite/affine-gfx-shape/store';
import { TextStoreExtension } from '@blocksuite/affine-gfx-text/store';
import { FootnoteStoreExtension } from '@blocksuite/affine-inline-footnote/store'; import { FootnoteStoreExtension } from '@blocksuite/affine-inline-footnote/store';
import { LatexStoreExtension as InlineLatexStoreExtension } from '@blocksuite/affine-inline-latex/store'; import { LatexStoreExtension as InlineLatexStoreExtension } from '@blocksuite/affine-inline-latex/store';
import { LinkStoreExtension } from '@blocksuite/affine-inline-link/store'; import { LinkStoreExtension } from '@blocksuite/affine-inline-link/store';
@@ -59,6 +60,7 @@ export function getInternalStoreExtensions() {
MindmapStoreExtension, MindmapStoreExtension,
ConnectorStoreExtension, ConnectorStoreExtension,
GroupStoreExtension, GroupStoreExtension,
TextStoreExtension,
MigratingStoreExtension, MigratingStoreExtension,
]; ];

View File

@@ -22,6 +22,7 @@ import { MindmapViewExtension } from '@blocksuite/affine-gfx-mindmap/view';
import { NoteViewExtension as GfxNoteViewExtension } from '@blocksuite/affine-gfx-note/view'; import { NoteViewExtension as GfxNoteViewExtension } from '@blocksuite/affine-gfx-note/view';
import { ShapeViewExtension } from '@blocksuite/affine-gfx-shape/view'; import { ShapeViewExtension } from '@blocksuite/affine-gfx-shape/view';
import { TemplateViewExtension } from '@blocksuite/affine-gfx-template/view'; import { TemplateViewExtension } from '@blocksuite/affine-gfx-template/view';
import { TextViewExtension } from '@blocksuite/affine-gfx-text/view';
import { FootnoteViewExtension } from '@blocksuite/affine-inline-footnote/view'; import { FootnoteViewExtension } from '@blocksuite/affine-inline-footnote/view';
import { LatexViewExtension as InlineLatexViewExtension } from '@blocksuite/affine-inline-latex/view'; import { LatexViewExtension as InlineLatexViewExtension } from '@blocksuite/affine-inline-latex/view';
import { LinkViewExtension } from '@blocksuite/affine-inline-link/view'; import { LinkViewExtension } from '@blocksuite/affine-inline-link/view';
@@ -40,6 +41,7 @@ export function getInternalViewExtensions() {
MindmapViewExtension, MindmapViewExtension,
ConnectorViewExtension, ConnectorViewExtension,
GroupViewExtension, GroupViewExtension,
TextViewExtension,
TemplateViewExtension, TemplateViewExtension,
// Block // Block

View File

@@ -0,0 +1 @@
export * from '@blocksuite/affine-gfx-text/store';

View File

@@ -0,0 +1 @@
export * from '@blocksuite/affine-gfx-text/view';

View File

@@ -1,8 +1,4 @@
import { FileDropExtension } from '@blocksuite/affine-components/drop-indicator'; import { FileDropExtension } from '@blocksuite/affine-components/drop-indicator';
import {
TextElementRendererExtension,
TextElementView,
} from '@blocksuite/affine-gfx-text';
import { NoteBlockSchema } from '@blocksuite/affine-model'; import { NoteBlockSchema } from '@blocksuite/affine-model';
import { import {
AutoClearSelectionService, AutoClearSelectionService,
@@ -29,17 +25,6 @@ import { builtinToolbarConfig } from '../configs/toolbar';
import { fallbackKeymap } from '../keyboard/keymap'; import { fallbackKeymap } from '../keyboard/keymap';
import { viewportOverlayWidget } from './widgets'; import { viewportOverlayWidget } from './widgets';
/**
* Why do we add these extensions into CommonSpecs?
* Because in some cases we need to create edgeless elements in page mode.
* And these view may contain some logic when elements initialize.
*/
const EdgelessElementViews = [TextElementView];
export const EdgelessElementRendererExtension: ExtensionType[] = [
TextElementRendererExtension,
];
export const CommonSpecs: ExtensionType[] = [ export const CommonSpecs: ExtensionType[] = [
FlavourExtension('affine:page'), FlavourExtension('affine:page'),
DocModeService, DocModeService,
@@ -52,8 +37,6 @@ export const CommonSpecs: ExtensionType[] = [
AutoClearSelectionService, AutoClearSelectionService,
...RootBlockAdapterExtensions, ...RootBlockAdapterExtensions,
...clipboardConfigs, ...clipboardConfigs,
...EdgelessElementViews,
...EdgelessElementRendererExtension,
SlashMenuExtension, SlashMenuExtension,
linkedDocWidget, linkedDocWidget,
dragHandleWidget, dragHandleWidget,

View File

@@ -1,4 +1,3 @@
import { textToolbarExtension } from '@blocksuite/affine-gfx-text';
import { ToolbarModuleExtension } from '@blocksuite/affine-shared/services'; import { ToolbarModuleExtension } from '@blocksuite/affine-shared/services';
import { BlockFlavourIdentifier } from '@blocksuite/std'; import { BlockFlavourIdentifier } from '@blocksuite/std';
import type { ExtensionType } from '@blocksuite/store'; import type { ExtensionType } from '@blocksuite/store';
@@ -6,8 +5,6 @@ import type { ExtensionType } from '@blocksuite/store';
import { builtinLockedToolbarConfig, builtinMiscToolbarConfig } from './misc'; import { builtinLockedToolbarConfig, builtinMiscToolbarConfig } from './misc';
export const EdgelessElementToolbarExtension: ExtensionType[] = [ export const EdgelessElementToolbarExtension: ExtensionType[] = [
textToolbarExtension,
ToolbarModuleExtension({ ToolbarModuleExtension({
id: BlockFlavourIdentifier('affine:surface:*'), id: BlockFlavourIdentifier('affine:surface:*'),
config: builtinMiscToolbarConfig, config: builtinMiscToolbarConfig,

View File

@@ -1,4 +1,3 @@
import { effects as gfxCanvasTextEffects } from '@blocksuite/affine-gfx-text/effects';
import { effects as widgetEdgelessToolbarEffects } from '@blocksuite/affine-widget-edgeless-toolbar/effects'; import { effects as widgetEdgelessToolbarEffects } from '@blocksuite/affine-widget-edgeless-toolbar/effects';
import { effects as widgetMobileToolbarEffects } from '@blocksuite/affine-widget-keyboard-toolbar/effects'; import { effects as widgetMobileToolbarEffects } from '@blocksuite/affine-widget-keyboard-toolbar/effects';
import { effects as widgetLinkedDocEffects } from '@blocksuite/affine-widget-linked-doc/effects'; import { effects as widgetLinkedDocEffects } from '@blocksuite/affine-widget-linked-doc/effects';
@@ -54,7 +53,6 @@ export function effects() {
// Register components by category // Register components by category
registerRootComponents(); registerRootComponents();
registerGfxEffects();
registerWidgets(); registerWidgets();
registerEdgelessToolbarComponents(); registerEdgelessToolbarComponents();
registerMiscComponents(); registerMiscComponents();
@@ -70,10 +68,6 @@ function registerRootComponents() {
); );
} }
function registerGfxEffects() {
gfxCanvasTextEffects();
}
function registerWidgets() { function registerWidgets() {
customElements.define( customElements.define(
AFFINE_PAGE_DRAGGING_AREA_WIDGET, AFFINE_PAGE_DRAGGING_AREA_WIDGET,

View File

@@ -14,7 +14,14 @@ export class GroupElementView extends GfxElementModelView<GroupElementModel> {
private _initDblClickToEdit(): void { private _initDblClickToEdit(): void {
this.on('dblclick', () => { this.on('dblclick', () => {
const edgeless = this.std.view.getBlock(this.std.store.root!.id); const rootId = this.std.store.root?.id;
if (!rootId) {
console.error(
'GroupElementView: rootId is not found when dblclick to edit'
);
return;
}
const edgeless = this.std.view.getBlock(rootId);
if (edgeless && !this.model.isLocked()) { if (edgeless && !this.model.isLocked()) {
mountGroupTitleEditor(this.model, edgeless); mountGroupTitleEditor(this.model, edgeless);

View File

@@ -12,6 +12,7 @@
"dependencies": { "dependencies": {
"@blocksuite/affine-block-surface": "workspace:*", "@blocksuite/affine-block-surface": "workspace:*",
"@blocksuite/affine-components": "workspace:*", "@blocksuite/affine-components": "workspace:*",
"@blocksuite/affine-ext-loader": "workspace:*",
"@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:*",
@@ -33,7 +34,9 @@
}, },
"exports": { "exports": {
".": "./src/index.ts", ".": "./src/index.ts",
"./effects": "./src/effects.ts" "./effects": "./src/effects.ts",
"./view": "./src/view.ts",
"./store": "./src/store.ts"
}, },
"files": [ "files": [
"src", "src",

View File

@@ -0,0 +1,19 @@
import {
type StoreExtensionContext,
StoreExtensionProvider,
} from '@blocksuite/affine-ext-loader';
import {
textToMarkdownAdapterMatcher,
textToPlainTextAdapterMatcher,
} from './adapter';
export class TextStoreExtension extends StoreExtensionProvider {
override name = 'affine-text-gfx';
override setup(context: StoreExtensionContext) {
super.setup(context);
context.register(textToMarkdownAdapterMatcher);
context.register(textToPlainTextAdapterMatcher);
}
}

View File

@@ -0,0 +1,27 @@
import {
type ViewExtensionContext,
ViewExtensionProvider,
} from '@blocksuite/affine-ext-loader';
import { effects } from './effects';
import { TextElementRendererExtension } from './element-renderer';
import { TextElementView } from './element-view';
import { textToolbarExtension } from './toolbar';
export class TextViewExtension extends ViewExtensionProvider {
override name = 'affine-text-gfx';
override effect(): void {
super.effect();
effects();
}
override setup(context: ViewExtensionContext) {
super.setup(context);
context.register(TextElementView);
context.register(TextElementRendererExtension);
if (this.isEdgeless(context.scope)) {
context.register(textToolbarExtension);
}
}
}

View File

@@ -9,6 +9,7 @@
"references": [ "references": [
{ "path": "../../blocks/surface" }, { "path": "../../blocks/surface" },
{ "path": "../../components" }, { "path": "../../components" },
{ "path": "../../ext-loader" },
{ "path": "../../model" }, { "path": "../../model" },
{ "path": "../../rich-text" }, { "path": "../../rich-text" },
{ "path": "../../shared" }, { "path": "../../shared" },

View File

@@ -1,6 +1,11 @@
import { EdgelessElementRendererExtension } from '@blocksuite/affine/blocks/root';
import { SurfaceBlockSchema } from '@blocksuite/affine/blocks/surface'; import { SurfaceBlockSchema } from '@blocksuite/affine/blocks/surface';
import { MindMapView } from '@blocksuite/affine/gfx/mindmap'; import { ConnectorElementRendererExtension } from '@blocksuite/affine/gfx/connector';
import {
MindmapElementRendererExtension,
MindMapView,
} from '@blocksuite/affine/gfx/mindmap';
import { ShapeElementRendererExtension } from '@blocksuite/affine/gfx/shape';
import { TextElementRendererExtension } from '@blocksuite/affine/gfx/text';
import { RootBlockSchema } from '@blocksuite/affine/model'; import { RootBlockSchema } from '@blocksuite/affine/model';
import { import {
DocModeService, DocModeService,
@@ -24,7 +29,10 @@ export const MiniMindmapSpecs: ExtensionType[] = [
MindMapView, MindMapView,
MindmapSurfaceBlockService, MindmapSurfaceBlockService,
BlockViewExtension('affine:surface', literal`mini-mindmap-surface-block`), BlockViewExtension('affine:surface', literal`mini-mindmap-surface-block`),
...EdgelessElementRendererExtension, TextElementRendererExtension,
MindmapElementRendererExtension,
ShapeElementRendererExtension,
ConnectorElementRendererExtension,
]; ];
export const MiniMindmapSchema: z.infer<typeof BlockSchema>[] = [ export const MiniMindmapSchema: z.infer<typeof BlockSchema>[] = [

View File

@@ -622,6 +622,7 @@ export const PackageList = [
workspaceDependencies: [ workspaceDependencies: [
'blocksuite/affine/blocks/surface', 'blocksuite/affine/blocks/surface',
'blocksuite/affine/components', 'blocksuite/affine/components',
'blocksuite/affine/ext-loader',
'blocksuite/affine/model', 'blocksuite/affine/model',
'blocksuite/affine/rich-text', 'blocksuite/affine/rich-text',
'blocksuite/affine/shared', 'blocksuite/affine/shared',

View File

@@ -3313,6 +3313,7 @@ __metadata:
dependencies: dependencies:
"@blocksuite/affine-block-surface": "workspace:*" "@blocksuite/affine-block-surface": "workspace:*"
"@blocksuite/affine-components": "workspace:*" "@blocksuite/affine-components": "workspace:*"
"@blocksuite/affine-ext-loader": "workspace:*"
"@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:*"