mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-11-27 23:15:15 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

refactor: make NodeViewProps an interface again (#5658)

Browse Source
This commit is contained in:
Nick Perez 2024-09-25 15:51:30 +02:00 committed by GitHub
parent 1bad8f8c95
commit 15b54990b0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
packages/core/src/types.ts
View File

@ -101,7 +101,19 @@ export interface EditorOptions {
* *
* @default true * @default true
*/ */
enableCoreExtensions?: boolean | Partial<Record<'editable' | 'clipboardTextSerializer' | 'commands' | 'focusEvents' | 'keymap' | 'tabindex', false>>; enableCoreExtensions?:
| boolean
| Partial<
Record<
| 'editable'
| 'clipboardTextSerializer'
| 'commands'
| 'focusEvents'
| 'keymap'
| 'tabindex',
false
>
>;
/** /**
* If `true`, the editor will check the content for errors on initialization. * If `true`, the editor will check the content for errors on initialization.
* Emitting the `contentError` event if the content is invalid. * Emitting the `contentError` event if the content is invalid.
@ -122,8 +134,8 @@ export interface EditorOptions {
onFocus: (props: EditorEvents['focus']) => void; onFocus: (props: EditorEvents['focus']) => void;
onBlur: (props: EditorEvents['blur']) => void; onBlur: (props: EditorEvents['blur']) => void;
onDestroy: (props: EditorEvents['destroy']) => void; onDestroy: (props: EditorEvents['destroy']) => void;
onPaste: (e: ClipboardEvent, slice: Slice) => void onPaste: (e: ClipboardEvent, slice: Slice) => void;
onDrop: (e: DragEvent, slice: Slice, moved: boolean) => void onDrop: (e: DragEvent, slice: Slice, moved: boolean) => void;
} }
export type HTMLContent = string; export type HTMLContent = string;
@ -208,21 +220,17 @@ export type ValuesOf<T> = T[keyof T];
export type KeysWithTypeOf<T, Type> = { [P in keyof T]: T[P] extends Type ? P : never }[keyof T]; export type KeysWithTypeOf<T, Type> = { [P in keyof T]: T[P] extends Type ? P : never }[keyof T];
export type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
export type DecorationWithType = Decoration & { export type DecorationWithType = Decoration & {
type: NodeType; type: NodeType;
}; };
export type NodeViewProps = Simplify< export interface NodeViewProps extends NodeViewRendererProps {
Omit<NodeViewRendererProps, 'decorations'> & {
// TODO this type is not technically correct, but it's the best we can do for now since prosemirror doesn't expose the type of decorations // TODO this type is not technically correct, but it's the best we can do for now since prosemirror doesn't expose the type of decorations
decorations: readonly DecorationWithType[]; decorations: readonly DecorationWithType[];
selected: boolean; selected: boolean;
updateAttributes: (attributes: Record<string, any>) => void; updateAttributes: (attributes: Record<string, any>) => void;
deleteNode: () => void; deleteNode: () => void;
} }
>;
export interface NodeViewRendererOptions { export interface NodeViewRendererOptions {
stopEvent: ((props: { event: Event }) => boolean) | null; stopEvent: ((props: { event: Event }) => boolean) | null;
@ -232,7 +240,7 @@ export interface NodeViewRendererOptions {
contentDOMElementTag: string; contentDOMElementTag: string;
} }
export type NodeViewRendererProps = { export interface NodeViewRendererProps {
// pass-through from prosemirror // pass-through from prosemirror
node: Parameters<NodeViewConstructor>[0]; node: Parameters<NodeViewConstructor>[0];
view: Parameters<NodeViewConstructor>[1]; view: Parameters<NodeViewConstructor>[1];
@ -243,7 +251,7 @@ export type NodeViewRendererProps = {
editor: Editor; editor: Editor;
extension: Node; extension: Node;
HTMLAttributes: Record<string, any>; HTMLAttributes: Record<string, any>;
}; }
export type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView; export type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView;