This is useful to construct your own table of contents since the toc option was removed in v10. Their level in the hierarchy, and the anchor id. Returns an array of objects with the text content of all the headings in the document, If title and icon are provided then the embed will also appear in the block menu. The matcher method's return value will be available on the component under. Optionally define embeds which will be inserted in place of links when the matcher function returns a truthy value. scrollToĪ string representing a heading anchor – the document will smooth scroll so that the heading is visible For example, if you already nest the editor under a main h1 title you might want the user to only be able to create h2 headings and below, in this case you would set the prop to 1. children: The component that the tooltip wraps, must be renderedĪ number that will offset the document headings by a number of levels.placement: Enum top, bottom, left, right.tooltip: A React node with the tooltip content.You can use this to inject your own tooltip library into the editor – the component will be passed the following props: auto: Editor layout is decided by the browser based on document content.Ī React component that will be wrapped around items that have an optional tooltip.
With dark set to true the editor will use a default dark theme that's included. See the inbuilt dictionary for an example of the keys that should be provided. dictionaryĪllows overriding the inbuilt copy dictionary, for example to internationalize the editor. See the inbuilt theme for an example of the keys that should be provided. themeĪllows overriding the inbuilt theme to brand the editor, for example use your own font face and brand colors to have the editor fit within your application. set to to disable italic text and blockquotes. Removes corresponding menu items and commands. List of included extension names to disable. extensionsĪllows additional Prosemirror plugins to be passed to the underlying Prosemirror instance. When set enforces a maximum character length on the document, not including markdown syntax. When set true together with readOnly set to false, focus at the end of the With readOnlyWriteCheckboxes set to true checkboxes can still be checked or unchecked as a special case while readOnly is set to true and the editor is otherwise unable to be edited. When true the editor can be used to display previously written content – headings gain anchors and links become clickable. With readOnly set to false the editor is optimized for composition. placeholderĪllows overriding of the placeholder. Do not pipe the value of onChange back into value, the editor keeps it's own internal state and this will result in unexpected side effects. Use this prop to change the value of the editor once mounted, this will re-render the entire editor and as such is only suitable when also in readOnly mode. valueĪ markdown string that represents the value of the editor.
Previously saved content for the user to continue editing. defaultValueĪ markdown string that represents the initial value of the editor. If no id is passed then the editor will default to using the location pathname. Props idĪ unique id for this editor, used to persist settings in local storage. Import Editor from "rich-markdown-editor" Ĭlone this repo and run the Storybook with yarn start to see a wide variety of example usage.
0 kommentar(er)
