import type { CellPlugin } from '@react-page/editor'; import { lazyLoad } from '@react-page/editor'; import React from 'react'; import ReadOnlySlate from './components/ReadOnlySlate'; import { defaultTranslations } from './default/settings'; import { HtmlToSlate } from './htmlToSlate'; import v002 from './migrations/v002'; import v003 from './migrations/v003'; import v004 from './migrations/v004'; import * as pluginFactories from './pluginFactories/index'; import defaultPlugins from './plugins/index'; import type { InitialSlateStateDef } from './types/initialSlateState'; import type { SlatePluginCollection } from './types/SlatePlugin'; import type { SlateState } from './types/state'; import { getTextContents } from './utils/getTextContent'; import makeSlatePluginsFromDef from './utils/makeSlatePluginsFromDef'; import transformInitialSlateState from './utils/transformInitialSlateState'; import { useSafeSetState } from './utils/useSafeSetState'; const slatePlugins = defaultPlugins; export { defaultPlugins, slatePlugins, pluginFactories, HtmlToSlate, SlateState, }; const SlateEditor = lazyLoad(() => import('./components/SlateEditor')); const Subject = lazyLoad(() => import('@mui/icons-material/Subject')); const Controls = lazyLoad(() => import('./components/Controls')); const SlateProvider = lazyLoad(() => import('./components/SlateProvider')); const migrations = [v002, v003, v004]; type SlateDefinition = { icon: JSX.Element; plugins: TPlugins; // eslint-disable-next-line @typescript-eslint/no-explicit-any defaultPluginType: string; title?: string; description?: string; id: string; version: number; translations: typeof defaultTranslations; migrations: typeof migrations; allowInlineNeighbours: boolean; hideInMenu?: boolean; }; type DefaultPlugins = typeof defaultPlugins; type DefaultSlateDefinition = SlateDefinition; export type CreateDataCustomizer = ({ plugins, }: { plugins: TPlugins; }) => InitialSlateStateDef; export const DEFAULT_SLATE_PLUGIN_ID = 'ory/editor/core/content/slate'; const defaultConfig: DefaultSlateDefinition = { icon: , plugins: defaultPlugins, defaultPluginType: 'PARAGRAPH/PARAGRAPH', id: DEFAULT_SLATE_PLUGIN_ID, version: 1, translations: defaultTranslations, migrations, allowInlineNeighbours: true, }; type CreateSlateData = ( custom?: CreateDataCustomizer ) => SlateState; export type SlateCellPlugin< TPlugins extends SlatePluginCollection = DefaultPlugins > = CellPlugin> & { createData: CreateSlateData; createDataFromHtml: (html: string) => Promise; /** * @deprecated, use createData */ createInitialSlateState: CreateSlateData; }; export type SlateCustomizeFunction = ( def: DefaultSlateDefinition ) => SlateDefinition; function plugin( customize?: SlateCustomizeFunction ): SlateCellPlugin { const settings = ( customize ? customize(defaultConfig) : defaultConfig ) as SlateDefinition; const createData = (customizer?: CreateDataCustomizer) => { if (!customizer) { return { slate: [] }; } return transformInitialSlateState( customizer({ plugins: settings.plugins }) ); }; const createInitialData = () => createData(({ plugins }) => ({ children: [ { plugin: plugins.paragraphs.paragraph, children: [''], }, ], })); // plugins should be flatten // NEW: to make it easier to manage and group plugins, // they now need to be an object of object with group and keys, see type SlatePluginCollection const plugins = makeSlatePluginsFromDef(settings.plugins); const htmlToSlate = HtmlToSlate({ plugins }); return { Renderer: (props) => { const allProps = { ...props, plugins, translations: settings.translations, defaultPluginType: settings.defaultPluginType, }; /* we need a small fix to avoid flashing when SSR in edit mode: we code split the Provider AND the editor version, but we have to make sure to not render the editor without the provider: */ const [providerLoaded, setProviderLoaded] = useSafeSetState(false); if (!props.readOnly && !providerLoaded) { SlateProvider.load().then(() => setProviderLoaded(true)); } if (props.readOnly || !providerLoaded) { return ; } return ( } /> ); }, Provider: (props) => ( {props.children}} /> ), // we no longer require the provider in read only mode thanks to the static renderer: disableProviderInReadOnly: true, controls: { type: 'custom', Component: (props) => ( ), }, // eslint-disable-next-line @typescript-eslint/no-explicit-any id: settings.id || (settings as any).name, version: settings.version, icon: settings.icon, title: settings.title || settings.translations.pluginName, description: settings.description || settings.translations.pluginDescription, hideInMenu: settings.hideInMenu, allowInlineNeighbours: settings.allowInlineNeighbours, allowClickInside: true, // disable default hotkeys handleRemoveHotKey: () => Promise.reject(), handleFocusPreviousHotKey: () => Promise.reject(), handleFocusNextHotKey: (e, node) => Promise.reject(), createInitialData, createInitialState: createInitialData, createInitialSlateState: createData, createData: createData, createDataFromHtml: htmlToSlate, getTextContents: (data) => getTextContents(data.slate, { slatePlugins: plugins }), // remove selection serialize: ({ slate, selection, ...rest } = { slate: [] }) => ({ slate, ...rest, }), cellClassName: 'slate', unserialize: (s) => { // eslint-disable-next-line @typescript-eslint/no-explicit-any if ((s as any)?.importFromHtml) { // this is no longer supported, but we do not delete it return { // eslint-disable-next-line @typescript-eslint/no-explicit-any importFromHtml: (s as any).importFromHtml, ...s, ...createInitialData(), }; } if (s?.slate) { return { ...s, selection: null, }; } return createInitialData(); }, migrations: settings.migrations, }; } export default plugin;