@mdxeditor/editor 3.0.7 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/FormatConstants.js +6 -0
- package/dist/MDXEditor.js +1 -1
- package/dist/directive-editors/GenericDirectiveEditor.js +5 -7
- package/dist/exportMarkdownFromLexical.js +10 -7
- package/dist/icons/strikethrough_s.svg.js +5 -0
- package/dist/icons/subscript.svg.js +5 -0
- package/dist/icons/superscript.svg.js +5 -0
- package/dist/importMarkdownToLexical.js +3 -1
- package/dist/index.d.ts +133 -142
- package/dist/index.js +2 -1
- package/dist/jsx-editors/GenericJsxEditor.js +1 -1
- package/dist/mdastUtilHtmlComment.js +2 -2
- package/dist/node_modules/micromark-extension-gfm-strikethrough/lib/syntax.js +114 -0
- package/dist/node_modules/micromark-util-chunked/index.js +29 -0
- package/dist/node_modules/micromark-util-classify-character/index.js +12 -0
- package/dist/node_modules/micromark-util-resolve-all/index.js +15 -0
- package/dist/plugins/codeblock/index.js +2 -2
- package/dist/plugins/codemirror/index.js +4 -4
- package/dist/plugins/core/Icon.js +6 -0
- package/dist/plugins/core/LexicalTextVisitor.js +56 -10
- package/dist/plugins/core/MdastFormattingVisitor.js +66 -30
- package/dist/plugins/core/MdastHTMLNode.js +1 -2
- package/dist/plugins/core/NestedLexicalEditor.js +1 -1
- package/dist/plugins/core/PropertyPopover.js +28 -18
- package/dist/plugins/core/index.js +36 -39
- package/dist/plugins/core/ui/DownshiftAutoComplete.js +1 -1
- package/dist/plugins/directives/index.js +2 -2
- package/dist/plugins/frontmatter/FrontmatterEditor.js +48 -31
- package/dist/plugins/frontmatter/FrontmatterNode.js +5 -3
- package/dist/plugins/image/ImageDialog.js +1 -1
- package/dist/plugins/image/ImageEditor.js +8 -6
- package/dist/plugins/image/ImageNode.js +2 -2
- package/dist/plugins/image/MdastImageVisitor.js +3 -3
- package/dist/plugins/image/index.js +20 -20
- package/dist/plugins/jsx/index.js +1 -1
- package/dist/plugins/link-dialog/LinkDialog.js +13 -5
- package/dist/plugins/link-dialog/index.js +7 -8
- package/dist/plugins/lists/MdastListVisitor.js +1 -2
- package/dist/plugins/lists/index.js +1 -1
- package/dist/plugins/markdown-shortcut/index.js +4 -2
- package/dist/plugins/sandpack/SandpackEditor.js +1 -1
- package/dist/plugins/sandpack/index.js +2 -2
- package/dist/plugins/sandpack/useCodeMirrorRef.js +8 -8
- package/dist/plugins/table/TableEditor.js +67 -50
- package/dist/plugins/table/TableNode.js +2 -2
- package/dist/plugins/toolbar/components/BlockTypeSelect.js +3 -3
- package/dist/plugins/toolbar/components/BoldItalicUnderlineToggles.js +79 -24
- package/dist/plugins/toolbar/components/ChangeAdmonitionType.js +1 -1
- package/dist/plugins/toolbar/components/ChangeCodeMirrorLanguage.js +1 -1
- package/dist/plugins/toolbar/components/DiffSourceToggleWrapper.js +3 -1
- package/dist/plugins/toolbar/components/InsertFrontmatter.js +3 -1
- package/dist/plugins/toolbar/components/InsertImage.js +12 -1
- package/dist/plugins/toolbar/components/InsertThematicBreak.js +10 -1
- package/dist/plugins/toolbar/components/KitchenSinkToolbar.js +2 -2
- package/dist/plugins/toolbar/primitives/DialogButton.js +1 -1
- package/dist/plugins/toolbar/primitives/select.js +3 -1
- package/dist/plugins/toolbar/primitives/toolbar.js +17 -3
- package/dist/utils/detectMac.js +1 -1
- package/dist/utils/isPartOftheEditorUI.js +1 -1
- package/package.json +9 -8
- package/dist/plugins/core/MdastInlineCodeVisitor.js +0 -27
package/dist/index.d.ts
CHANGED
|
@@ -1,38 +1,7 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The `@mdxeditor/editor` package exports the MDXEditor React component and a set of plugins and
|
|
3
|
-
* pre-made components for editing/editor UI.
|
|
4
|
-
*
|
|
5
|
-
* The API Reference is organized around the various features of the editor. Usually, each feature is implemented as a plugin.
|
|
6
|
-
*
|
|
7
|
-
* Several note-worthy types of exports are available:
|
|
8
|
-
*
|
|
9
|
-
* **dollar-suffixed variables** (e.g. `markdown$`, `applyBlockType$`, etc.). These are [reactive Gurx primitives (Cells and Signals)](https://mdx-editor.github.io/gurx/)
|
|
10
|
-
* which let you interact with the editor state and extend it with your own custom logic.
|
|
11
|
-
*
|
|
12
|
-
* The MDXEditor package re-exports Gurx's React hooks, so you can use them like this for example:
|
|
13
|
-
* ```tsx
|
|
14
|
-
* // use the markdown$ cell to get the current markdown value,
|
|
15
|
-
* // and the rootEditor$ cell to get the Lexical editor instance.
|
|
16
|
-
* const [markdown, rootEditor] = useCellValues([markdown$, rootEditor$])
|
|
17
|
-
* // use the applyBlockType$ signal to apply a block type to the current selection
|
|
18
|
-
* const applyBlockType = usePublisher(applyBlockType$)
|
|
19
|
-
* ```
|
|
20
|
-
*
|
|
21
|
-
* **dollar-prefixed functions** (e.g. `$isCodeBlockNode`, etc.). These are following the conventions of the Lexical API, and are usually usable within the Lexical editor read/update cycles.
|
|
22
|
-
*
|
|
23
|
-
* **`plugin` functions** - these are functions that return a plugin object that can be passed to the `plugins` prop of the MDXEditor component. They usually accept a set of configuration options specific to the features they provide.
|
|
24
|
-
*
|
|
25
|
-
* **MDAST Nodes, Lexical Nodes and Import/Export visitors** - these are part of the bi-directional Markdown to/from Lexical state conversion API.
|
|
26
|
-
*
|
|
27
|
-
* **Toolbar plugins and primitives** - React components that can be used in the Editor toolbar. The primitives are meant to be used to build your own toolbar items.
|
|
28
|
-
*
|
|
29
|
-
* @packageDocumentation
|
|
30
|
-
*/
|
|
31
|
-
|
|
32
|
-
/// <reference types="react" />
|
|
33
|
-
|
|
34
1
|
import { Config } from 'mdast-util-from-markdown/lib';
|
|
2
|
+
import { ContentEditable } from '@lexical/react/LexicalContentEditable.js';
|
|
35
3
|
import { DecoratorNode } from 'lexical';
|
|
4
|
+
import { default as default_2 } from 'react';
|
|
36
5
|
import { Directives } from 'mdast-util-directive';
|
|
37
6
|
import { DOMConversionMap } from 'lexical';
|
|
38
7
|
import { DOMExportOutput } from 'lexical';
|
|
@@ -61,7 +30,6 @@ import { Options as Options_2 } from 'mdast-util-to-markdown/lib/types';
|
|
|
61
30
|
import { ParseOptions } from 'micromark-util-types';
|
|
62
31
|
import * as RadixToolbar from '@radix-ui/react-toolbar';
|
|
63
32
|
import { RangeSelection } from 'lexical';
|
|
64
|
-
import { default as React_2 } from 'react';
|
|
65
33
|
import { ReactNode } from 'react';
|
|
66
34
|
import { Realm } from '@mdxeditor/gurx';
|
|
67
35
|
import { RootNode } from 'lexical';
|
|
@@ -160,23 +128,23 @@ export declare const addActivePlugin$: NodeRef<string | string[]>;
|
|
|
160
128
|
* Lets you add React components to the {@link https://lexical.dev/docs/react/plugins | Lexical Composer} element.
|
|
161
129
|
* @group Core
|
|
162
130
|
*/
|
|
163
|
-
export declare const addComposerChild$: NodeRef<
|
|
131
|
+
export declare const addComposerChild$: NodeRef<default_2.ComponentType<{}> | default_2.ComponentType<{}>[]>;
|
|
164
132
|
|
|
165
133
|
/**
|
|
166
134
|
* Lets you add React components as wrappers around the editor.
|
|
167
135
|
* @group Core
|
|
168
136
|
*/
|
|
169
|
-
export declare const addEditorWrapper$: NodeRef<
|
|
170
|
-
children:
|
|
171
|
-
}> |
|
|
172
|
-
children:
|
|
137
|
+
export declare const addEditorWrapper$: NodeRef<default_2.ComponentType<{
|
|
138
|
+
children: default_2.ReactNode;
|
|
139
|
+
}> | default_2.ComponentType<{
|
|
140
|
+
children: default_2.ReactNode;
|
|
173
141
|
}>[]>;
|
|
174
142
|
|
|
175
143
|
/**
|
|
176
144
|
* Adds an export visitor to be used when exporting markdown from the Lexical tree.
|
|
177
145
|
* @group Markdown Processing
|
|
178
146
|
*/
|
|
179
|
-
export declare const addExportVisitor$: NodeRef<LexicalVisitor | LexicalVisitor[]>;
|
|
147
|
+
export declare const addExportVisitor$: NodeRef< LexicalVisitor | LexicalVisitor[]>;
|
|
180
148
|
|
|
181
149
|
/**
|
|
182
150
|
* Registers a visitor to be used when importing markdown.
|
|
@@ -188,37 +156,37 @@ export declare const addImportVisitor$: NodeRef<MdastImportVisitor<Mdast.Nodes>
|
|
|
188
156
|
* Registers a lexical node to be used in the editor.
|
|
189
157
|
* @group Core
|
|
190
158
|
*/
|
|
191
|
-
export declare const addLexicalNode$: NodeRef<KlassConstructor<typeof LexicalNode> | KlassConstructor<typeof LexicalNode>[]>;
|
|
159
|
+
export declare const addLexicalNode$: NodeRef< KlassConstructor<typeof LexicalNode> | KlassConstructor<typeof LexicalNode>[]>;
|
|
192
160
|
|
|
193
161
|
/**
|
|
194
162
|
* Adds a mdast extension to the markdown parser.
|
|
195
163
|
* @group Markdown Processing
|
|
196
164
|
*/
|
|
197
|
-
export declare const addMdastExtension$: NodeRef<Partial<Config> | Partial<Config>[] | (Partial<Config> | Partial<Config>[])[]>;
|
|
165
|
+
export declare const addMdastExtension$: NodeRef<Partial< Config> | Partial< Config>[] | (Partial< Config> | Partial< Config>[])[]>;
|
|
198
166
|
|
|
199
167
|
/**
|
|
200
168
|
* Lets you add React components as children of any registered nested editor (useful for Lexical plugins).
|
|
201
169
|
* @group Core
|
|
202
170
|
*/
|
|
203
|
-
export declare const addNestedEditorChild$: NodeRef<
|
|
171
|
+
export declare const addNestedEditorChild$: NodeRef<default_2.ComponentType<{}> | default_2.ComponentType<{}>[]>;
|
|
204
172
|
|
|
205
173
|
/**
|
|
206
174
|
* Adds a syntax extension to the markdown parser.
|
|
207
175
|
* @group Markdown Processing
|
|
208
176
|
*/
|
|
209
|
-
export declare const addSyntaxExtension$: NodeRef<Extension | Extension[]>;
|
|
177
|
+
export declare const addSyntaxExtension$: NodeRef< Extension | Extension[]>;
|
|
210
178
|
|
|
211
179
|
/**
|
|
212
180
|
* Adds a markdown to string extension to be used when exporting markdown from the Lexical tree.
|
|
213
181
|
* @group Markdown Processing
|
|
214
182
|
*/
|
|
215
|
-
export declare const addToMarkdownExtension$: NodeRef<Options_2 | Options_2[]>;
|
|
183
|
+
export declare const addToMarkdownExtension$: NodeRef< Options_2 | Options_2[]>;
|
|
216
184
|
|
|
217
185
|
/**
|
|
218
186
|
* Lets you add React components on top of the editor (like the toolbar).
|
|
219
187
|
* @group Core
|
|
220
188
|
*/
|
|
221
|
-
export declare const addTopAreaChild$: NodeRef<
|
|
189
|
+
export declare const addTopAreaChild$: NodeRef<default_2.ComponentType<{}> | default_2.ComponentType<{}>[]>;
|
|
222
190
|
|
|
223
191
|
/* Excluded from this release type: ADMONITION_TYPES */
|
|
224
192
|
|
|
@@ -307,19 +275,19 @@ export declare type BlockType = 'paragraph' | 'quote' | HeadingTagType | '';
|
|
|
307
275
|
* Supports paragraphs, headings and block quotes.
|
|
308
276
|
* @group Toolbar Components
|
|
309
277
|
*/
|
|
310
|
-
export declare const BlockTypeSelect: () =>
|
|
278
|
+
export declare const BlockTypeSelect: () => default_2.JSX.Element | null;
|
|
311
279
|
|
|
312
280
|
/**
|
|
313
281
|
* A toolbar component that lets the user toggle bold, italic and underline formatting.
|
|
314
282
|
* @group Toolbar Components
|
|
315
283
|
*/
|
|
316
|
-
export declare const BoldItalicUnderlineToggles:
|
|
284
|
+
export declare const BoldItalicUnderlineToggles: default_2.FC;
|
|
317
285
|
|
|
318
286
|
/**
|
|
319
287
|
* A toolbar button primitive.
|
|
320
288
|
* @group Toolbar Primitives
|
|
321
289
|
*/
|
|
322
|
-
export declare const Button:
|
|
290
|
+
export declare const Button: default_2.ForwardRefExoticComponent<Omit<RadixToolbar.ToolbarButtonProps & default_2.RefAttributes<HTMLButtonElement>, "ref"> & default_2.RefAttributes<object>>;
|
|
323
291
|
|
|
324
292
|
/**
|
|
325
293
|
* Use this primitive to create a toolbar button that can be either a button or a dropdown, depending on the number of items passed.
|
|
@@ -329,7 +297,7 @@ export declare const ButtonOrDropdownButton: <T extends string>(props: {
|
|
|
329
297
|
/**
|
|
330
298
|
* The contents of the button - usually an icon.
|
|
331
299
|
*/
|
|
332
|
-
children:
|
|
300
|
+
children: default_2.ReactNode;
|
|
333
301
|
/**
|
|
334
302
|
* The title used for the tooltip.
|
|
335
303
|
*/
|
|
@@ -352,15 +320,15 @@ export declare const ButtonOrDropdownButton: <T extends string>(props: {
|
|
|
352
320
|
*/
|
|
353
321
|
label: string | JSX.Element;
|
|
354
322
|
}[];
|
|
355
|
-
}) =>
|
|
323
|
+
}) => default_2.JSX.Element;
|
|
356
324
|
|
|
357
325
|
/**
|
|
358
326
|
* A toolbar button with tooltip primitive.
|
|
359
327
|
* @group Toolbar Primitives
|
|
360
328
|
*/
|
|
361
|
-
export declare const ButtonWithTooltip: ({ title, children, ...props }: Omit<RadixToolbar.ToolbarButtonProps &
|
|
329
|
+
export declare const ButtonWithTooltip: ({ title, children, ...props }: Omit<RadixToolbar.ToolbarButtonProps & default_2.RefAttributes<HTMLButtonElement>, "ref"> & default_2.RefAttributes<object> & {
|
|
362
330
|
title: string;
|
|
363
|
-
}) =>
|
|
331
|
+
}) => default_2.JSX.Element;
|
|
364
332
|
|
|
365
333
|
/**
|
|
366
334
|
* Calls the passed function.
|
|
@@ -381,7 +349,7 @@ export declare const cancelLinkEdit$: NodeRef<void>;
|
|
|
381
349
|
* For this component to work, you must pass the {@link AdmonitionDirectiveDescriptor} to the `directivesPlugin` `directiveDescriptors` parameter.
|
|
382
350
|
* @group Toolbar Components
|
|
383
351
|
*/
|
|
384
|
-
export declare const ChangeAdmonitionType: () =>
|
|
352
|
+
export declare const ChangeAdmonitionType: () => default_2.JSX.Element;
|
|
385
353
|
|
|
386
354
|
/**
|
|
387
355
|
* A component that allows the user to change the code block language of the current selection.
|
|
@@ -389,7 +357,7 @@ export declare const ChangeAdmonitionType: () => React_2.JSX.Element;
|
|
|
389
357
|
* See {@link ConditionalContents} for an example on how to display the dropdown only when a code block is in focus.
|
|
390
358
|
* @group Toolbar Components
|
|
391
359
|
*/
|
|
392
|
-
export declare const ChangeCodeMirrorLanguage: () =>
|
|
360
|
+
export declare const ChangeCodeMirrorLanguage: () => default_2.JSX.Element;
|
|
393
361
|
|
|
394
362
|
export declare type ClickLinkCallback = (url: string) => void;
|
|
395
363
|
|
|
@@ -547,7 +515,7 @@ export declare const codeBlockPlugin: (params?: {
|
|
|
547
515
|
*/
|
|
548
516
|
export declare const codeMirrorAutoLoadLanguageSupport$: NodeRef<boolean>;
|
|
549
517
|
|
|
550
|
-
export declare const CodeMirrorEditor: ({ language, nodeKey, code, focusEmitter }: CodeBlockEditorProps) =>
|
|
518
|
+
export declare const CodeMirrorEditor: ({ language, nodeKey, code, focusEmitter }: CodeBlockEditorProps) => default_2.JSX.Element;
|
|
551
519
|
|
|
552
520
|
/**
|
|
553
521
|
* The code mirror extensions for the coemirror code block editor.
|
|
@@ -578,7 +546,7 @@ export declare const codeMirrorPlugin: (params?: {
|
|
|
578
546
|
* Use for inline `code` elements (like variables, methods, etc).
|
|
579
547
|
* @group Toolbar Components
|
|
580
548
|
*/
|
|
581
|
-
export declare const CodeToggle:
|
|
549
|
+
export declare const CodeToggle: default_2.FC;
|
|
582
550
|
|
|
583
551
|
export declare const COMMON_STATE_CONFIG_EXTENSIONS: Extension_2[];
|
|
584
552
|
|
|
@@ -613,7 +581,7 @@ export declare function compose<I, A, R>(a: (arg: A) => R, b: (arg: I) => A): (a
|
|
|
613
581
|
* ```
|
|
614
582
|
* @group Toolbar Primitives
|
|
615
583
|
*/
|
|
616
|
-
export declare const ConditionalContents:
|
|
584
|
+
export declare const ConditionalContents: default_2.FC<{
|
|
617
585
|
/**
|
|
618
586
|
* A set of options that define the contents to show based on the editor that is in focus.
|
|
619
587
|
* Can be either a {@link ConditionalContentsOption} or a {@link FallbackOption}.
|
|
@@ -626,7 +594,7 @@ export declare const ConditionalContents: React_2.FC<{
|
|
|
626
594
|
* An object that describes a possible option to be displayed in the {@link ConditionalContents} component.
|
|
627
595
|
* @group Toolbar Primitives
|
|
628
596
|
*/
|
|
629
|
-
export declare
|
|
597
|
+
export declare interface ConditionalContentsOption {
|
|
630
598
|
/**
|
|
631
599
|
* A function that returns `true` if the option should be displayed for the current editor in focus.
|
|
632
600
|
*/
|
|
@@ -634,8 +602,8 @@ export declare type ConditionalContentsOption = {
|
|
|
634
602
|
/**
|
|
635
603
|
* The contents to display if the `when` function returns `true`.
|
|
636
604
|
*/
|
|
637
|
-
contents: () =>
|
|
638
|
-
}
|
|
605
|
+
contents: () => default_2.ReactNode;
|
|
606
|
+
}
|
|
639
607
|
|
|
640
608
|
/**
|
|
641
609
|
* Holds the CSS class name of the content editable element.
|
|
@@ -711,7 +679,7 @@ export declare interface CreateImageNodeParameters {
|
|
|
711
679
|
* For this component to work, you must include the `linkDialogPlugin`.
|
|
712
680
|
* @group Toolbar Components
|
|
713
681
|
*/
|
|
714
|
-
export declare const CreateLink: () =>
|
|
682
|
+
export declare const CreateLink: () => default_2.JSX.Element;
|
|
715
683
|
|
|
716
684
|
/**
|
|
717
685
|
* An input signal that lets you register a new {@link EditorSubscription} for the root editor.
|
|
@@ -737,7 +705,7 @@ export declare const currentBlockType$: NodeRef<BlockType>;
|
|
|
737
705
|
* Holds the current format of the selection.
|
|
738
706
|
* @group Core
|
|
739
707
|
*/
|
|
740
|
-
export declare const currentFormat$: NodeRef<
|
|
708
|
+
export declare const currentFormat$: NodeRef<FORMAT>;
|
|
741
709
|
|
|
742
710
|
/**
|
|
743
711
|
* The current list type in the editor.
|
|
@@ -763,6 +731,8 @@ export declare function curry1to0<T, R>(proc: (arg: T) => R, arg: T): () => R;
|
|
|
763
731
|
*/
|
|
764
732
|
export declare function curry2to1<T, K, R>(proc: (arg1: T, arg2: K) => R, arg1: T): (arg2: K) => R;
|
|
765
733
|
|
|
734
|
+
declare const DEFAULT_FORMAT: 0;
|
|
735
|
+
|
|
766
736
|
/**
|
|
767
737
|
* Contains the default language to use when creating a new code block if no language is passed.
|
|
768
738
|
* @group Code Block
|
|
@@ -782,7 +752,7 @@ export declare interface Descriptors {
|
|
|
782
752
|
* Use this primitive to create a toolbar button that opens a dialog with a text input, autocomplete suggestions, and a submit button.
|
|
783
753
|
* @group Toolbar Primitives
|
|
784
754
|
*/
|
|
785
|
-
export declare const DialogButton:
|
|
755
|
+
export declare const DialogButton: default_2.ForwardRefExoticComponent<{
|
|
786
756
|
/**
|
|
787
757
|
* The autocomplete suggestions to show in the dialog input.
|
|
788
758
|
*/
|
|
@@ -802,7 +772,7 @@ export declare const DialogButton: React_2.ForwardRefExoticComponent<{
|
|
|
802
772
|
* <DialogButton buttonContent={<CustomIcon />} />
|
|
803
773
|
* ```
|
|
804
774
|
*/
|
|
805
|
-
buttonContent?:
|
|
775
|
+
buttonContent?: default_2.ReactNode;
|
|
806
776
|
/**
|
|
807
777
|
* The placeholder text to show in the dialog input.
|
|
808
778
|
*/
|
|
@@ -811,7 +781,7 @@ export declare const DialogButton: React_2.ForwardRefExoticComponent<{
|
|
|
811
781
|
* The title of the submit button.
|
|
812
782
|
*/
|
|
813
783
|
submitButtonTitle: string;
|
|
814
|
-
} &
|
|
784
|
+
} & default_2.RefAttributes<HTMLButtonElement>>;
|
|
815
785
|
|
|
816
786
|
/* Excluded from this release type: diffMarkdown$ */
|
|
817
787
|
|
|
@@ -856,8 +826,8 @@ export declare const diffSourcePlugin: (params?: {
|
|
|
856
826
|
*
|
|
857
827
|
* @group Toolbar Components
|
|
858
828
|
*/
|
|
859
|
-
export declare const DiffSourceToggleWrapper:
|
|
860
|
-
children:
|
|
829
|
+
export declare const DiffSourceToggleWrapper: default_2.FC<{
|
|
830
|
+
children: default_2.ReactNode;
|
|
861
831
|
options?: ViewMode[];
|
|
862
832
|
}>;
|
|
863
833
|
|
|
@@ -898,7 +868,7 @@ export declare interface DirectiveDescriptor<T extends Directives = Directives>
|
|
|
898
868
|
* Contains the currently registered Markdown directive descriptors.
|
|
899
869
|
* @group Directive
|
|
900
870
|
*/
|
|
901
|
-
export declare const directiveDescriptors$: NodeRef<DirectiveDescriptor<Directives>[]>;
|
|
871
|
+
export declare const directiveDescriptors$: NodeRef<DirectiveDescriptor< Directives>[]>;
|
|
902
872
|
|
|
903
873
|
/**
|
|
904
874
|
* The properties passed to the {@link DirectiveDescriptor.Editor} component.
|
|
@@ -927,7 +897,7 @@ export declare interface DirectiveEditorProps<T extends Directives = Directives>
|
|
|
927
897
|
* A lexical node that represents an image. Use {@link "$createDirectiveNode"} to construct one.
|
|
928
898
|
* @group Directive
|
|
929
899
|
*/
|
|
930
|
-
export declare class DirectiveNode extends DecoratorNode<
|
|
900
|
+
export declare class DirectiveNode extends DecoratorNode<default_2.JSX.Element> {
|
|
931
901
|
/* Excluded from this release type: __mdastNode */
|
|
932
902
|
/* Excluded from this release type: __focusEmitter */
|
|
933
903
|
/* Excluded from this release type: getType */
|
|
@@ -986,11 +956,11 @@ export declare const disableImageSettingsButton$: NodeRef<boolean>;
|
|
|
986
956
|
* The state of the image dialog when it is in editing an existing node.
|
|
987
957
|
* @group Image
|
|
988
958
|
*/
|
|
989
|
-
export declare
|
|
959
|
+
export declare interface EditingImageDialogState {
|
|
990
960
|
type: 'editing';
|
|
991
961
|
nodeKey: string;
|
|
992
962
|
initialValues: Omit<SaveImageParameters, 'file'>;
|
|
993
|
-
}
|
|
963
|
+
}
|
|
994
964
|
|
|
995
965
|
/**
|
|
996
966
|
* The state of the link dialog when it is in edit mode.
|
|
@@ -1025,7 +995,7 @@ export declare interface EditorInFocus {
|
|
|
1025
995
|
* A reference to a DOM element. used for the various popups, dialogs, and tooltips
|
|
1026
996
|
* @group Core
|
|
1027
997
|
*/
|
|
1028
|
-
export declare const editorRootElementRef$: NodeRef<
|
|
998
|
+
export declare const editorRootElementRef$: NodeRef<default_2.RefObject<HTMLDivElement> | null>;
|
|
1029
999
|
|
|
1030
1000
|
/**
|
|
1031
1001
|
* A function that subscribes to Lexical editor updates or events, and retursns an unsubscribe function.
|
|
@@ -1045,26 +1015,28 @@ export declare type EditorSubscription = (activeEditor: LexicalEditor) => () =>
|
|
|
1045
1015
|
|
|
1046
1016
|
/* Excluded from this release type: exportVisitors$ */
|
|
1047
1017
|
|
|
1048
|
-
declare
|
|
1018
|
+
declare interface ExpressionValue {
|
|
1049
1019
|
type: 'expression';
|
|
1050
1020
|
value: string;
|
|
1051
|
-
}
|
|
1021
|
+
}
|
|
1052
1022
|
|
|
1053
1023
|
/**
|
|
1054
1024
|
* A default option to be displayed in the {@link ConditionalContents} component if none of the other options match.
|
|
1055
1025
|
* @group Toolbar Primitives
|
|
1056
1026
|
*/
|
|
1057
|
-
export declare
|
|
1027
|
+
export declare interface FallbackOption {
|
|
1058
1028
|
/**
|
|
1059
1029
|
* The contents to display
|
|
1060
1030
|
*/
|
|
1061
|
-
fallback: () =>
|
|
1062
|
-
}
|
|
1031
|
+
fallback: () => default_2.ReactNode;
|
|
1032
|
+
}
|
|
1063
1033
|
|
|
1064
1034
|
declare interface FileImageParameters extends BaseImageParameters {
|
|
1065
1035
|
file: File;
|
|
1066
1036
|
}
|
|
1067
1037
|
|
|
1038
|
+
declare type FORMAT = typeof DEFAULT_FORMAT | typeof IS_BOLD | typeof IS_ITALIC | typeof IS_STRIKETHROUGH | typeof IS_UNDERLINE | typeof IS_CODE | typeof IS_SUBSCRIPT | typeof IS_SUPERSCRIPT | typeof IS_HIGHLIGHT;
|
|
1039
|
+
|
|
1068
1040
|
/**
|
|
1069
1041
|
* Fetches a value from the Lexical editor read cycle.
|
|
1070
1042
|
* @group Utils
|
|
@@ -1089,7 +1061,7 @@ export declare const frontmatterPlugin: (params?: unknown) => RealmPlugin;
|
|
|
1089
1061
|
* Use this editor for the {@link DirectiveDescriptor} Editor option.
|
|
1090
1062
|
* @group Directive
|
|
1091
1063
|
*/
|
|
1092
|
-
export declare const GenericDirectiveEditor:
|
|
1064
|
+
export declare const GenericDirectiveEditor: default_2.FC<DirectiveEditorProps>;
|
|
1093
1065
|
|
|
1094
1066
|
/**
|
|
1095
1067
|
* A Lexical node that represents a generic HTML element. Use {@link $createGenericHTMLNode} to construct one.
|
|
@@ -1127,7 +1099,7 @@ export declare class GenericHTMLNode extends ElementNode {
|
|
|
1127
1099
|
* Use this editor for the {@link JsxComponentDescriptor} Editor option.
|
|
1128
1100
|
* @group JSX
|
|
1129
1101
|
*/
|
|
1130
|
-
export declare const GenericJsxEditor:
|
|
1102
|
+
export declare const GenericJsxEditor: default_2.FC<JsxEditorProps>;
|
|
1131
1103
|
|
|
1132
1104
|
/**
|
|
1133
1105
|
* Gets the selected node from the Lexical editor.
|
|
@@ -1183,13 +1155,13 @@ export declare const htmlTags: readonly ["a", "abbr", "address", "area", "articl
|
|
|
1183
1155
|
* A callback that returns the icon component for the given name.
|
|
1184
1156
|
* @group Core
|
|
1185
1157
|
*/
|
|
1186
|
-
export declare const iconComponentFor$: NodeRef<(name: IconKey) =>
|
|
1158
|
+
export declare const iconComponentFor$: NodeRef<(name: IconKey) => default_2.ReactNode>;
|
|
1187
1159
|
|
|
1188
1160
|
/**
|
|
1189
1161
|
* A type that represents the possible icon names that can be used with the {@link iconComponentFor$} cell.
|
|
1190
1162
|
* @group Core
|
|
1191
1163
|
*/
|
|
1192
|
-
export declare type IconKey = 'add_column' | 'add_photo' | 'add_row' | 'arrow_drop_down' | 'check' | 'check_small' | 'close' | 'code' | 'content_copy' | 'delete_big' | 'delete_small' | 'sandpack' | 'difference' | 'edit' | 'admonition' | 'extension' | 'format_align_center' | 'format_align_left' | 'format_align_right' | 'format_bold' | 'format_italic' | 'format_list_bulleted' | 'format_list_checked' | 'format_list_numbered' | 'format_underlined' | 'frame_source' | 'frontmatter' | 'horizontal_rule' | 'insert_col_left' | 'insert_col_right' | 'insert_row_above' | 'insert_row_below' | 'link' | 'link_off' | 'markdown' | 'more_horiz' | 'more_vert' | 'open_in_new' | 'redo' | 'rich_text' | 'settings' | 'table' | 'undo';
|
|
1164
|
+
export declare type IconKey = 'add_column' | 'add_photo' | 'add_row' | 'arrow_drop_down' | 'check' | 'check_small' | 'close' | 'code' | 'content_copy' | 'delete_big' | 'delete_small' | 'sandpack' | 'difference' | 'edit' | 'admonition' | 'extension' | 'format_align_center' | 'format_align_left' | 'format_align_right' | 'format_bold' | 'format_italic' | 'format_list_bulleted' | 'format_list_checked' | 'format_list_numbered' | 'format_underlined' | 'frame_source' | 'frontmatter' | 'horizontal_rule' | 'insert_col_left' | 'insert_col_right' | 'insert_row_above' | 'insert_row_below' | 'link' | 'link_off' | 'markdown' | 'more_horiz' | 'more_vert' | 'open_in_new' | 'redo' | 'rich_text' | 'settings' | 'strikeThrough' | 'subscript' | 'superscript' | 'table' | 'undo';
|
|
1193
1165
|
|
|
1194
1166
|
/**
|
|
1195
1167
|
* Holds the autocomplete suggestions for image sources.
|
|
@@ -1292,9 +1264,9 @@ export declare interface ImportPoint {
|
|
|
1292
1264
|
* The state of the image dialog when it is inactive.
|
|
1293
1265
|
* @group Image
|
|
1294
1266
|
*/
|
|
1295
|
-
export declare
|
|
1267
|
+
export declare interface InactiveImageDialogState {
|
|
1296
1268
|
type: 'inactive';
|
|
1297
|
-
}
|
|
1269
|
+
}
|
|
1298
1270
|
|
|
1299
1271
|
/**
|
|
1300
1272
|
* The state of the link dialog when it is inactive.
|
|
@@ -1322,7 +1294,7 @@ export declare const inFocus$: NodeRef<boolean>;
|
|
|
1322
1294
|
*
|
|
1323
1295
|
* @group Toolbar Components
|
|
1324
1296
|
*/
|
|
1325
|
-
export declare const InsertAdmonition: () =>
|
|
1297
|
+
export declare const InsertAdmonition: () => default_2.JSX.Element;
|
|
1326
1298
|
|
|
1327
1299
|
/**
|
|
1328
1300
|
* A signal that inserts a new code block into the editor with the published options.
|
|
@@ -1337,7 +1309,7 @@ export declare const insertCodeBlock$: NodeRef<Partial<CreateCodeBlockNodeOption
|
|
|
1337
1309
|
*
|
|
1338
1310
|
* @group Toolbar Components
|
|
1339
1311
|
*/
|
|
1340
|
-
export declare const InsertCodeBlock:
|
|
1312
|
+
export declare const InsertCodeBlock: default_2.FC;
|
|
1341
1313
|
|
|
1342
1314
|
/**
|
|
1343
1315
|
* Inserts a new code mirror code block with the specified parameters.
|
|
@@ -1375,7 +1347,7 @@ export declare const insertFrontmatter$: NodeRef<void>;
|
|
|
1375
1347
|
* For this to work, you need to have the `frontmatterPlugin` plugin enabled.
|
|
1376
1348
|
* @group Toolbar Components
|
|
1377
1349
|
*/
|
|
1378
|
-
export declare const InsertFrontmatter:
|
|
1350
|
+
export declare const InsertFrontmatter: default_2.FC;
|
|
1379
1351
|
|
|
1380
1352
|
/**
|
|
1381
1353
|
* A signal that inserts a new image node with the published payload.
|
|
@@ -1388,7 +1360,7 @@ export declare const insertImage$: NodeRef<InsertImageParameters>;
|
|
|
1388
1360
|
* For the button to work, you need to have the `imagePlugin` plugin enabled.
|
|
1389
1361
|
* @group Toolbar Components
|
|
1390
1362
|
*/
|
|
1391
|
-
export declare const InsertImage:
|
|
1363
|
+
export declare const InsertImage: default_2.ForwardRefExoticComponent<Omit<Record<string, never>, "ref"> & default_2.RefAttributes<HTMLButtonElement>>;
|
|
1392
1364
|
|
|
1393
1365
|
/**
|
|
1394
1366
|
* @group Image
|
|
@@ -1431,7 +1403,7 @@ export declare const insertSandpack$: NodeRef<string>;
|
|
|
1431
1403
|
* For this to work, you need to have the `sandpackPlugin` installed.
|
|
1432
1404
|
* @group Toolbar Components
|
|
1433
1405
|
*/
|
|
1434
|
-
export declare const InsertSandpack: () =>
|
|
1406
|
+
export declare const InsertSandpack: () => default_2.JSX.Element;
|
|
1435
1407
|
|
|
1436
1408
|
/**
|
|
1437
1409
|
* A signal that will insert a table with the published amount of rows and columns into the active editor.
|
|
@@ -1460,7 +1432,7 @@ export declare const insertTable$: NodeRef<{
|
|
|
1460
1432
|
* For this button to work, you need to have the `tablePlugin` plugin enabled.
|
|
1461
1433
|
* @group Toolbar Components
|
|
1462
1434
|
*/
|
|
1463
|
-
export declare const InsertTable:
|
|
1435
|
+
export declare const InsertTable: default_2.FC;
|
|
1464
1436
|
|
|
1465
1437
|
/**
|
|
1466
1438
|
* Inserts a thematic break at the current selection.
|
|
@@ -1473,7 +1445,7 @@ export declare const insertThematicBreak$: NodeRef<void>;
|
|
|
1473
1445
|
* For this button to work, you need to have the `thematicBreakPlugin` plugin enabled.
|
|
1474
1446
|
* @group Toolbar Components
|
|
1475
1447
|
*/
|
|
1476
|
-
export declare const InsertThematicBreak:
|
|
1448
|
+
export declare const InsertThematicBreak: default_2.FC;
|
|
1477
1449
|
|
|
1478
1450
|
/**
|
|
1479
1451
|
* Used to detect if the current platform is Apple based, mostly for keyboard shortcuts.
|
|
@@ -1485,8 +1457,16 @@ declare const IS_BOLD: 1;
|
|
|
1485
1457
|
|
|
1486
1458
|
declare const IS_CODE: 16;
|
|
1487
1459
|
|
|
1460
|
+
declare const IS_HIGHLIGHT: 128;
|
|
1461
|
+
|
|
1488
1462
|
declare const IS_ITALIC: 2;
|
|
1489
1463
|
|
|
1464
|
+
declare const IS_STRIKETHROUGH: 4;
|
|
1465
|
+
|
|
1466
|
+
declare const IS_SUBSCRIPT: 32;
|
|
1467
|
+
|
|
1468
|
+
declare const IS_SUPERSCRIPT: 64;
|
|
1469
|
+
|
|
1490
1470
|
declare const IS_UNDERLINE: 8;
|
|
1491
1471
|
|
|
1492
1472
|
/**
|
|
@@ -1508,7 +1488,7 @@ export declare function isMdastJsxNode(node: Mdast.Nodes): node is MdastJsx;
|
|
|
1508
1488
|
* joinProc does not pass arguments or collect return values.
|
|
1509
1489
|
* @group Utils
|
|
1510
1490
|
*/
|
|
1511
|
-
export declare function joinProc(...procs:
|
|
1491
|
+
export declare function joinProc(...procs: (() => unknown)[]): () => void;
|
|
1512
1492
|
|
|
1513
1493
|
/**
|
|
1514
1494
|
* Defines the structure of a JSX component that can be used within the markdown document.
|
|
@@ -1544,7 +1524,7 @@ export declare interface JsxComponentDescriptor {
|
|
|
1544
1524
|
/**
|
|
1545
1525
|
* The editor to use for editing the component
|
|
1546
1526
|
*/
|
|
1547
|
-
Editor:
|
|
1527
|
+
Editor: default_2.ComponentType<JsxEditorProps>;
|
|
1548
1528
|
}
|
|
1549
1529
|
|
|
1550
1530
|
/**
|
|
@@ -1576,7 +1556,7 @@ export declare const jsxIsAvailable$: NodeRef<boolean>;
|
|
|
1576
1556
|
*/
|
|
1577
1557
|
export declare const jsxPlugin: (params?: JsxPluginParams | undefined) => RealmPlugin;
|
|
1578
1558
|
|
|
1579
|
-
declare
|
|
1559
|
+
declare interface JsxPluginParams {
|
|
1580
1560
|
/**
|
|
1581
1561
|
* A set of descriptors that document the JSX elements used in the document.
|
|
1582
1562
|
*/
|
|
@@ -1585,7 +1565,7 @@ declare type JsxPluginParams = {
|
|
|
1585
1565
|
* Wether or not to allow default React fragments <></> processing in MDX.
|
|
1586
1566
|
*/
|
|
1587
1567
|
allowFragment?: boolean;
|
|
1588
|
-
}
|
|
1568
|
+
}
|
|
1589
1569
|
|
|
1590
1570
|
declare type JsxProperties = Record<string, string | ExpressionValue>;
|
|
1591
1571
|
|
|
@@ -1614,7 +1594,7 @@ export declare interface JsxPropertyDescriptor {
|
|
|
1614
1594
|
* You'll probably want to create your own toolbar component that includes only the buttons that you need.
|
|
1615
1595
|
* @group Toolbar Components
|
|
1616
1596
|
*/
|
|
1617
|
-
export declare const KitchenSinkToolbar:
|
|
1597
|
+
export declare const KitchenSinkToolbar: default_2.FC;
|
|
1618
1598
|
|
|
1619
1599
|
/**
|
|
1620
1600
|
* All recognized HTML tags.
|
|
@@ -1750,7 +1730,7 @@ export declare const linkPlugin: (params?: {
|
|
|
1750
1730
|
* An optional function to validate the URL of a link.
|
|
1751
1731
|
* By default, no validation is performed.
|
|
1752
1732
|
*/
|
|
1753
|
-
validateUrl?:
|
|
1733
|
+
validateUrl?: default_2.ComponentProps<typeof LinkPlugin>['validateUrl'];
|
|
1754
1734
|
/**
|
|
1755
1735
|
* Whether to disable the auto-linking of URLs and email addresses.
|
|
1756
1736
|
* @default false
|
|
@@ -1771,8 +1751,8 @@ export declare const listsPlugin: (params?: unknown) => RealmPlugin;
|
|
|
1771
1751
|
* @group Toolbar Components
|
|
1772
1752
|
* @param options - The list types that the user can toggle between. Defaults to `['bullet', 'number', 'check']`.
|
|
1773
1753
|
*/
|
|
1774
|
-
export declare const ListsToggle:
|
|
1775
|
-
options?:
|
|
1754
|
+
export declare const ListsToggle: default_2.FC<{
|
|
1755
|
+
options?: ('bullet' | 'number' | 'check')[];
|
|
1776
1756
|
}>;
|
|
1777
1757
|
|
|
1778
1758
|
/* Excluded from this release type: makeHslTransparent */
|
|
@@ -1884,12 +1864,12 @@ export declare interface MdastImportVisitor<UN extends Mdast.Nodes> {
|
|
|
1884
1864
|
* Adds formatting as a context for the current node and its children.
|
|
1885
1865
|
* This is necessary due to mdast treating formatting as a node, while lexical considering it an attribute of a node.
|
|
1886
1866
|
*/
|
|
1887
|
-
addFormatting(format:
|
|
1867
|
+
addFormatting(format: FORMAT, node?: Mdast.Parent | null): void;
|
|
1888
1868
|
/**
|
|
1889
1869
|
* Removes formatting as a context for the current node and its children.
|
|
1890
1870
|
* This is necessary due to mdast treating formatting as a node, while lexical considering it an attribute of a node.
|
|
1891
1871
|
*/
|
|
1892
|
-
removeFormatting(format:
|
|
1872
|
+
removeFormatting(format: FORMAT, node?: Mdast.Parent | null): void;
|
|
1893
1873
|
/**
|
|
1894
1874
|
* Access the current formatting context.
|
|
1895
1875
|
*/
|
|
@@ -1925,7 +1905,7 @@ export declare type MdastJsx = MdxJsxTextElement | MdxJsxFlowElement;
|
|
|
1925
1905
|
* The MDXEditor React component.
|
|
1926
1906
|
* @group MDXEditor
|
|
1927
1907
|
*/
|
|
1928
|
-
export declare const MDXEditor:
|
|
1908
|
+
export declare const MDXEditor: default_2.ForwardRefExoticComponent<MDXEditorProps & default_2.RefAttributes<MDXEditorMethods>>;
|
|
1929
1909
|
|
|
1930
1910
|
/**
|
|
1931
1911
|
* The interface for the {@link MDXEditor} object reference.
|
|
@@ -2014,7 +1994,7 @@ export declare interface MDXEditorProps {
|
|
|
2014
1994
|
/**
|
|
2015
1995
|
* The placeholder contents, displayed when the editor is empty.
|
|
2016
1996
|
*/
|
|
2017
|
-
placeholder?:
|
|
1997
|
+
placeholder?: default_2.ReactNode;
|
|
2018
1998
|
/**
|
|
2019
1999
|
* pass if you would like to have the editor in read-only mode.
|
|
2020
2000
|
* Note: Don't use this mode to render content for consumption - render the markdown using a library of your choice instead.
|
|
@@ -2044,10 +2024,10 @@ export declare type MdxNodeType = MdastHTMLNode['type'];
|
|
|
2044
2024
|
* A toolbar primitive that allows you to build an UI with multiple non-exclusive toggle groups, like the bold/italic/underline toggle.
|
|
2045
2025
|
* @group Toolbar Primitives
|
|
2046
2026
|
*/
|
|
2047
|
-
export declare const MultipleChoiceToggleGroup:
|
|
2027
|
+
export declare const MultipleChoiceToggleGroup: default_2.FC<{
|
|
2048
2028
|
items: {
|
|
2049
2029
|
title: string;
|
|
2050
|
-
contents:
|
|
2030
|
+
contents: default_2.ReactNode;
|
|
2051
2031
|
active: boolean;
|
|
2052
2032
|
onChange: (active: boolean) => void;
|
|
2053
2033
|
disabled?: boolean;
|
|
@@ -2065,7 +2045,7 @@ export declare const muteChange$: NodeRef<boolean>;
|
|
|
2065
2045
|
* Place it as a wrapper in your custom lexical node decorators.
|
|
2066
2046
|
* @group Custom Editor Primitives
|
|
2067
2047
|
*/
|
|
2068
|
-
export declare const NestedEditorsContext:
|
|
2048
|
+
export declare const NestedEditorsContext: default_2.Context<NestedEditorsContextValue<Node_2> | undefined>;
|
|
2069
2049
|
|
|
2070
2050
|
/**
|
|
2071
2051
|
* The value of the {@link NestedEditorsContext} React context.
|
|
@@ -2128,33 +2108,20 @@ export declare const NestedLexicalEditor: <T extends Mdast.RootContent>(props: {
|
|
|
2128
2108
|
/**
|
|
2129
2109
|
* Props passed to the {@link https://github.com/facebook/lexical/blob/main/packages/lexical-react/src/LexicalContentEditable.tsx | ContentEditable} component.
|
|
2130
2110
|
*/
|
|
2131
|
-
contentEditableProps?:
|
|
2132
|
-
ariaActiveDescendant?: string | undefined;
|
|
2133
|
-
ariaAutoComplete?: "list" | "none" | "inline" | "both" | undefined;
|
|
2134
|
-
ariaControls?: string | undefined;
|
|
2135
|
-
ariaDescribedBy?: string | undefined;
|
|
2136
|
-
ariaExpanded?: (boolean | "true" | "false") | undefined;
|
|
2137
|
-
ariaLabel?: string | undefined;
|
|
2138
|
-
ariaLabelledBy?: string | undefined;
|
|
2139
|
-
ariaMultiline?: (boolean | "true" | "false") | undefined;
|
|
2140
|
-
ariaOwns?: string | undefined;
|
|
2141
|
-
ariaRequired?: (boolean | "true" | "false") | undefined;
|
|
2142
|
-
autoCapitalize?: string | undefined;
|
|
2143
|
-
'data-testid'?: string | null | undefined;
|
|
2144
|
-
} & React_2.AllHTMLAttributes<HTMLDivElement>) | undefined;
|
|
2111
|
+
contentEditableProps?: default_2.ComponentProps<typeof ContentEditable>;
|
|
2145
2112
|
/**
|
|
2146
2113
|
* Whether or not the editor edits blocks (multiple paragraphs)
|
|
2147
2114
|
*/
|
|
2148
|
-
block?: boolean
|
|
2149
|
-
}) =>
|
|
2115
|
+
block?: boolean;
|
|
2116
|
+
}) => default_2.JSX.Element;
|
|
2150
2117
|
|
|
2151
2118
|
/**
|
|
2152
2119
|
* The state of the image dialog when it is in new mode.
|
|
2153
2120
|
* @group Image
|
|
2154
2121
|
*/
|
|
2155
|
-
export declare
|
|
2122
|
+
export declare interface NewImageDialogState {
|
|
2156
2123
|
type: 'new';
|
|
2157
|
-
}
|
|
2124
|
+
}
|
|
2158
2125
|
|
|
2159
2126
|
/**
|
|
2160
2127
|
* an empty function
|
|
@@ -2219,7 +2186,7 @@ export declare function prop<T extends Record<string, unknown>>(property: keyof
|
|
|
2219
2186
|
* Displays a simple, static key/value editing UI in a popover.
|
|
2220
2187
|
* @group Custom Editor Primitives
|
|
2221
2188
|
*/
|
|
2222
|
-
export declare const PropertyPopover:
|
|
2189
|
+
export declare const PropertyPopover: default_2.FC<{
|
|
2223
2190
|
/**
|
|
2224
2191
|
* The properties to edit. The key is the name of the property, and the value is the initial value.
|
|
2225
2192
|
*/
|
|
@@ -2385,7 +2352,7 @@ export declare interface SandpackPreset {
|
|
|
2385
2352
|
initialSnippetContent?: string;
|
|
2386
2353
|
}
|
|
2387
2354
|
|
|
2388
|
-
declare type SandpackProviderProps =
|
|
2355
|
+
declare type SandpackProviderProps = default_2.ComponentProps<typeof SandpackProvider>;
|
|
2389
2356
|
|
|
2390
2357
|
/**
|
|
2391
2358
|
* Saves the data from the image dialog
|
|
@@ -2410,11 +2377,11 @@ export declare const Select: <T extends string>(props: {
|
|
|
2410
2377
|
onChange: (value: T) => void;
|
|
2411
2378
|
triggerTitle: string;
|
|
2412
2379
|
placeholder: string;
|
|
2413
|
-
items: (
|
|
2380
|
+
items: ({
|
|
2414
2381
|
label: string | JSX.Element;
|
|
2415
2382
|
value: T;
|
|
2416
|
-
})[];
|
|
2417
|
-
}) =>
|
|
2383
|
+
} | 'separator')[];
|
|
2384
|
+
}) => default_2.JSX.Element;
|
|
2418
2385
|
|
|
2419
2386
|
/* Excluded from this release type: SelectButtonTrigger */
|
|
2420
2387
|
|
|
@@ -2429,7 +2396,7 @@ export declare const Select: <T extends string>(props: {
|
|
|
2429
2396
|
* By default, the separator is styled as vertical line.
|
|
2430
2397
|
* @group Toolbar Primitives
|
|
2431
2398
|
*/
|
|
2432
|
-
export declare const Separator:
|
|
2399
|
+
export declare const Separator: default_2.ForwardRefExoticComponent<RadixToolbar.ToolbarSeparatorProps & default_2.RefAttributes<HTMLDivElement>>;
|
|
2433
2400
|
|
|
2434
2401
|
/**
|
|
2435
2402
|
* A serialized representation of an {@link CodeBlockNode}.
|
|
@@ -2496,7 +2463,7 @@ export declare const setMarkdown$: NodeRef<string>;
|
|
|
2496
2463
|
* See {@link ConditionalContents} for an example on how to display the dropdown only when a sandpack editor is in focus.
|
|
2497
2464
|
* @group Toolbar Components
|
|
2498
2465
|
*/
|
|
2499
|
-
export declare const ShowSandpackInfo: () =>
|
|
2466
|
+
export declare const ShowSandpackInfo: () => default_2.JSX.Element;
|
|
2500
2467
|
|
|
2501
2468
|
/**
|
|
2502
2469
|
* A toolbar primitive that allows you to build an UI with multiple exclusive toggle groups, like the list type toggle.
|
|
@@ -2506,12 +2473,12 @@ export declare const SingleChoiceToggleGroup: <T extends string>({ value, onChan
|
|
|
2506
2473
|
items: {
|
|
2507
2474
|
title: string;
|
|
2508
2475
|
value: T;
|
|
2509
|
-
contents:
|
|
2476
|
+
contents: default_2.ReactNode;
|
|
2510
2477
|
}[];
|
|
2511
|
-
onChange: (value: T) => void;
|
|
2478
|
+
onChange: (value: T | '') => void;
|
|
2512
2479
|
value: T;
|
|
2513
|
-
className?: string
|
|
2514
|
-
}) =>
|
|
2480
|
+
className?: string;
|
|
2481
|
+
}) => default_2.JSX.Element;
|
|
2515
2482
|
|
|
2516
2483
|
/* Excluded from this release type: SingleToggleGroup */
|
|
2517
2484
|
|
|
@@ -2519,6 +2486,12 @@ declare interface SrcImageParameters extends BaseImageParameters {
|
|
|
2519
2486
|
src: string;
|
|
2520
2487
|
}
|
|
2521
2488
|
|
|
2489
|
+
/**
|
|
2490
|
+
* A toolbar component that lets the user toggle strikeThrough, superscript and subscript formatting.
|
|
2491
|
+
* @group Toolbar Components
|
|
2492
|
+
*/
|
|
2493
|
+
export declare const StrikeThroughSupSubToggles: default_2.FC;
|
|
2494
|
+
|
|
2522
2495
|
/**
|
|
2523
2496
|
* An action that switches the link dialog from preview mode to edit mode.
|
|
2524
2497
|
* @group Link Dialog
|
|
@@ -2614,14 +2587,14 @@ export { ToMarkdownOptions }
|
|
|
2614
2587
|
* The factory function that returns the contents of the toolbar.
|
|
2615
2588
|
* @group Toolbar
|
|
2616
2589
|
*/
|
|
2617
|
-
export declare const toolbarContents$: NodeRef<() =>
|
|
2590
|
+
export declare const toolbarContents$: NodeRef<() => default_2.ReactNode>;
|
|
2618
2591
|
|
|
2619
2592
|
/**
|
|
2620
2593
|
* A plugin that adds a toolbar to the editor.
|
|
2621
2594
|
* @group Toolbar
|
|
2622
2595
|
*/
|
|
2623
2596
|
export declare const toolbarPlugin: (params?: {
|
|
2624
|
-
toolbarContents: () =>
|
|
2597
|
+
toolbarContents: () => default_2.ReactNode;
|
|
2625
2598
|
} | undefined) => RealmPlugin;
|
|
2626
2599
|
|
|
2627
2600
|
/* Excluded from this release type: ToolbarToggleItem */
|
|
@@ -2630,10 +2603,10 @@ export declare const toolbarPlugin: (params?: {
|
|
|
2630
2603
|
* A styled wrapper around the radix-ui tooltip, that lets you display an instant tooltip on hover.
|
|
2631
2604
|
* @group Toolbar Primitives
|
|
2632
2605
|
*/
|
|
2633
|
-
export declare const TooltipWrap:
|
|
2606
|
+
export declare const TooltipWrap: default_2.ForwardRefExoticComponent<{
|
|
2634
2607
|
title: string;
|
|
2635
2608
|
children: ReactNode;
|
|
2636
|
-
} &
|
|
2609
|
+
} & default_2.RefAttributes<HTMLButtonElement>>;
|
|
2637
2610
|
|
|
2638
2611
|
/* Excluded from this release type: topAreaChildren$ */
|
|
2639
2612
|
|
|
@@ -2647,7 +2620,7 @@ export declare type Translation = (key: string, defaultValue: string, interpolat
|
|
|
2647
2620
|
* A toolbar component that lets the user undo and redo changes in the editor.
|
|
2648
2621
|
* @group Toolbar Components
|
|
2649
2622
|
*/
|
|
2650
|
-
export declare const UndoRedo:
|
|
2623
|
+
export declare const UndoRedo: default_2.FC;
|
|
2651
2624
|
|
|
2652
2625
|
/**
|
|
2653
2626
|
* An error that gets thrown when the Markdown parsing encounters an node that has no corresponding {@link MdastImportVisitor}.
|
|
@@ -2713,12 +2686,12 @@ export declare type ViewMode = 'rich-text' | 'source' | 'diff';
|
|
|
2713
2686
|
* The construct is used so that the lexical nodes can focus their React component editors.
|
|
2714
2687
|
* @group Utils
|
|
2715
2688
|
*/
|
|
2716
|
-
export declare
|
|
2689
|
+
export declare interface VoidEmitter {
|
|
2717
2690
|
/**
|
|
2718
2691
|
* Subscribes to the emitter event
|
|
2719
2692
|
*/
|
|
2720
2693
|
subscribe: (cb: () => void) => void;
|
|
2721
|
-
}
|
|
2694
|
+
}
|
|
2722
2695
|
|
|
2723
2696
|
/**
|
|
2724
2697
|
* Creates a void emitter.
|
|
@@ -2733,3 +2706,21 @@ export declare function voidEmitter(): {
|
|
|
2733
2706
|
export * from "@mdxeditor/gurx";
|
|
2734
2707
|
|
|
2735
2708
|
export { }
|
|
2709
|
+
|
|
2710
|
+
|
|
2711
|
+
declare global {
|
|
2712
|
+
interface DragEvent {
|
|
2713
|
+
rangeOffset?: number;
|
|
2714
|
+
rangeParent?: Node;
|
|
2715
|
+
}
|
|
2716
|
+
}
|
|
2717
|
+
|
|
2718
|
+
|
|
2719
|
+
declare module 'micromark-util-types' {
|
|
2720
|
+
interface TokenTypeMap {
|
|
2721
|
+
comment: 'comment';
|
|
2722
|
+
commentEnd: 'commentEnd';
|
|
2723
|
+
data: 'data';
|
|
2724
|
+
}
|
|
2725
|
+
}
|
|
2726
|
+
|