udecode/plate @udecode/plate-basic-nodes@49.0.0

on GitHub

Major Changes

• #4327 by @zbeyens –
  • The packages @udecode/plate-basic-elements and @udecode/plate-basic-marks have been deprecated. All their plugins are now consolidated into the new @platejs/basic-nodes package.
  • Migration:
    • Replace @udecode/plate-basic-elements and @udecode/plate-basic-marks in your dependencies with @platejs/basic-nodes.
    • Update all import paths from @udecode/plate-basic-elements/react or @udecode/plate-basic-marks/react to @platejs/basic-nodes/react.
    • CodeBlockPlugin is not part of @platejs/basic-nodes. Ensure it is imported from @platejs/code-block/react.
  • SkipMarkPlugin (standalone) is removed. Its functionality is now built into the core editor. To enable boundary clearing for a specific mark, configure the mark plugin directly: plugin.configure({ rules: { selection: { affinity: 'outward' } } }).
  • Default HTML Tag Changes:
    • Blocks: Element plugins in @udecode/plate-basic-nodes (e.g., BlockquotePlugin, HeadingPlugin, HorizontalRulePlugin) now default to rendering with specific HTML tags (<blockquote>, <h1>-<h6>, <hr> respectively). ParagraphPlugin still defaults to <div>. If you relied on previous defaults or need different tags, provide a custom component or use the render.as option.
    • Marks: Mark plugins in @udecode/plate-basic-nodes (e.g., BoldPlugin, CodePlugin, ItalicPlugin) now default to specific HTML tags (<strong>, <code>, <em> respectively). If you relied on previous defaults or need different tags, provide a custom component or use the render.as option.
  • Removed Default Shortcuts:
    • Default keyboard shortcuts are no longer bundled with most plugins (exceptions: bold, italic, underline).
    • Configure shortcuts manually via the shortcuts field in plugin configuration.
    • Example (Block Plugins):

      H1Plugin.configure({ shortcuts: { toggle: { keys: 'mod+alt+1' } } });
      BlockquotePlugin.configure({
        shortcuts: { toggle: { keys: 'mod+shift+period' } },
      });

    • Example (Mark Plugins):

      CodePlugin.configure({ shortcuts: { toggle: { keys: 'mod+e' } } });
      StrikethroughPlugin.configure({
        shortcuts: { toggle: { keys: 'mod+shift+x' } },
      });
      SubscriptPlugin.configure({
        shortcuts: { toggle: { keys: 'mod+comma' } },
      });
      SuperscriptPlugin.configure({
        shortcuts: { toggle: { keys: 'mod+period' } },
      });
      HighlightPlugin.configure({
        shortcuts: { toggle: { keys: 'mod+shift+h' } },
      });

Minor Changes

• #4327 by @zbeyens –
  • New toggle Transforms Added:
    • Block plugins with new toggle transforms: BlockquotePlugin, H1Plugin, H2Plugin, H3Plugin, H4Plugin, H5Plugin, H6Plugin.
    • All mark plugins in this package now also feature a toggle transform, including: BoldPlugin, ItalicPlugin, UnderlinePlugin, CodePlugin, StrikethroughPlugin, SubscriptPlugin, SuperscriptPlugin, KbdPlugin, HighlightPlugin.
  • Individual Heading Plugins Available:
    • H1Plugin, H2Plugin, H3Plugin, H4Plugin, H5Plugin, and H6Plugin offer a flexible alternative to the general HeadingPlugin, allowing granular control over heading level inclusion and configuration (e.g., custom components, shortcuts per level).
  • Plugin Consolidations into @udecode/plate-basic-nodes:
    • KbdPlugin (formerly from @udecode/plate-kbd).
    • HighlightPlugin (formerly from @udecode/plate-highlight).