Roadmap v8

[zbeyens]

While we have a general roadmap, this is a discussion for what can come until next major release.

Core

At the moment we have 3 props to use for each new plugin:

• create a plugin and add it to plugins
• add the plugin options to options
• add the plugin components to components

which is nicely decoupled but ideally we want to use a single prop to use (plugins) for less complexity.
This was not possible because a plugin was not identifiable by a plugin key (pluginKeys can be an array of string).
It can be solved by changing pluginKeys: string | string[] to key: string and each slate node will have its own plugin (instead of a single one like headings and lists).

• Plate
  • options and components props will be removed in favor of createPlatePlugins
  • a single helper createPlatePlugins will be needed to register both options and components
  • use getRenderElement / getRenderLeaf as defaults if renderElement / renderLeaf are not defined
• PlatePlugin
  • pluginKeys will be renamed to key: string and not string | string[] anymore
  • the rule will be: one key per plugin, at most one element/leaf to render per plugin
  • so multi element plugins like headings will have a proper migration to just return a list of plugins
  • Plate will merge “common options” (the current options prop) and options passed to plugin factories
    (createXPlugin(options)), both will be stored in editor.plugins[key] so it can be used by any transform/query, as it's already done for the common, e.g. type option
  • renderElement and renderLeaf will be optional
  • remove voidTypes and inlineTypes
  • new fields

key?: string;
isElement?: boolean;
isInline?: boolean;
isLeaf?: boolean;
isVoid?: boolean;

• createPlatePlugin: (overrides: PlatePlugin<T>, defaults: PlatePlugin<T>) => PlatePlugin<T>
  • overrides will override defaults
  • each plugin (+ merged options) will be stored in editor.plugins[plugin.key] by Plate

const createXPlugin = (overrides: PlatePlugin<T>) => createPlatePlugin(overrides, {
  key: ELEMENT_PARAGRAPH,
  renderElement: ...,
  hotkey: ...,
)}

createXPlugin({ key: 'custom', type: 'custom', component: ... })

Misc

• rename CSV, MD to pascal case
• remove plugins param in favor of editor.plugins