Skip to content

feat: Added parameter for updating custom inline content in render #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 54 additions & 5 deletions packages/core/src/schema/inlineContent/createSpec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { Node } from "@tiptap/core";
import { TagParseRule } from "@tiptap/pm/model";
import { nodeToCustomInlineContent } from "../../api/nodeConversions/nodeConversions";
import {
inlineContentToNodes,
nodeToCustomInlineContent,
} from "../../api/nodeConversions/nodeConversions";
import { propsToAttributes } from "../blocks/internal";
import { Props } from "../propTypes";
import { StyleSchema } from "../styles/types";
Expand All @@ -11,15 +14,15 @@ import {
} from "./internal";
import {
CustomInlineContentConfig,
InlineContentConfig,
InlineContentFromConfig,
InlineContentSpec,
PartialCustomInlineContentFromConfig,
} from "./types";

// TODO: support serialization

export type CustomInlineContentImplementation<
T extends InlineContentConfig,
T extends CustomInlineContentConfig,
// B extends BlockSchema,
// I extends InlineContentSchema,
S extends StyleSchema
Expand All @@ -28,7 +31,10 @@ export type CustomInlineContentImplementation<
/**
* The custom inline content to render
*/
inlineContent: InlineContentFromConfig<T, S>
inlineContent: InlineContentFromConfig<T, S>,
updateInlineContent: (
update: PartialCustomInlineContentFromConfig<T, S>
) => void
/**
* The BlockNote editor instance
* This is typed generically. If you want an editor with your custom schema, you need to
Expand Down Expand Up @@ -100,7 +106,10 @@ export function createInlineContentSpec<
node,
editor.schema.inlineContentSchema,
editor.schema.styleSchema
) as any as InlineContentFromConfig<T, S> // TODO: fix cast
) as any as InlineContentFromConfig<T, S>, // TODO: fix cast
() => {
// No-op
}
);

return addInlineContentAttributes(
Expand All @@ -110,6 +119,46 @@ export function createInlineContentSpec<
inlineContentConfig.propSchema
);
},

addNodeView() {
return ({ node, getPos }) => {
const editor = this.options.editor;

const output = inlineContentImplementation.render(
nodeToCustomInlineContent(
node,
editor.schema.inlineContentSchema,
editor.schema.styleSchema
) as any as InlineContentFromConfig<T, S>, // TODO: fix cast
(update) => {
if (typeof getPos === "boolean") {
return;
}

const content = inlineContentToNodes(
[update],
editor._tiptapEditor.schema,
editor.schema.styleSchema
);

editor._tiptapEditor.view.dispatch(
editor._tiptapEditor.view.state.tr.replaceWith(
getPos(),
getPos() + node.nodeSize,
content
)
);
}
);

return addInlineContentAttributes(
output,
inlineContentConfig.type,
node.attrs as Props<T["propSchema"]>,
inlineContentConfig.propSchema
);
};
},
});

return createInlineContentSpecFromTipTapNode(
Expand Down
33 changes: 30 additions & 3 deletions packages/react/src/schema/ReactInlineContentSpec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ import {
createStronglyTypedTiptapNode,
CustomInlineContentConfig,
getInlineContentParseRules,
InlineContentConfig,
InlineContentFromConfig,
inlineContentToNodes,
nodeToCustomInlineContent,
PartialCustomInlineContentFromConfig,
Props,
PropSchema,
propsToAttributes,
Expand All @@ -28,12 +29,15 @@ import { renderToDOMSpec } from "./@util/ReactRenderUtil";

// extend BlockConfig but use a React render function
export type ReactInlineContentImplementation<
T extends InlineContentConfig,
T extends CustomInlineContentConfig,
// I extends InlineContentSchema,
S extends StyleSchema
> = {
render: FC<{
inlineContent: InlineContentFromConfig<T, S>;
updateInlineContent: (
update: PartialCustomInlineContentFromConfig<T, S>
) => void;
contentRef: (node: HTMLElement | null) => void;
}>;
// TODO?
Expand Down Expand Up @@ -119,7 +123,15 @@ export function createReactInlineContentSpec<
) as any as InlineContentFromConfig<T, S>; // TODO: fix cast
const Content = inlineContentImplementation.render;
const output = renderToDOMSpec(
(refCB) => <Content inlineContent={ic} contentRef={refCB} />,
(refCB) => (
<Content
inlineContent={ic}
updateInlineContent={() => {
// No-op
}}
contentRef={refCB}
/>
),
editor
);

Expand Down Expand Up @@ -155,6 +167,21 @@ export function createReactInlineContentSpec<
editor.schema.styleSchema
) as any as InlineContentFromConfig<T, S> // TODO: fix cast
}
updateInlineContent={(update) => {
const content = inlineContentToNodes(
[update],
editor._tiptapEditor.schema,
editor.schema.styleSchema
);

editor._tiptapEditor.view.dispatch(
editor._tiptapEditor.view.state.tr.replaceWith(
props.getPos(),
props.getPos() + props.node.nodeSize,
content
)
);
}}
/>
</InlineContentWrapper>
);
Expand Down
Loading