udecode/plate @udecode/plate-reset-node@49.0.0

on GitHub

Major Changes

• #4327 by @zbeyens – Package @udecode/plate-reset-node has been deprecated. Its functionality (e.g., ResetNodePlugin) is now exclusively configured using the rules.break and rules.delete options on plugin definitions. Migration:

  • Remove @udecode/plate-reset-node from your dependencies.
  • Remove any usage of ResetNodePlugin from your project.
  • Configure reset behaviors directly on the relevant plugins by defining rules.break and/or rules.delete.

  Example: Resetting a Blockquote to a Paragraph

  ResetNodePlugin.configure({
    options: {
      rules: [
        {
          types: [BlockquotePlugin.key],
          defaultType: ParagraphPlugin.key,
          hotkey: 'Enter',
          predicate: (editor) =>
            editor.api.isEmpty(editor.selection, { block: true }),
        },
      ],
    },
  });
  
  // After
  BlockquotePlugin.configure({
    rules: {
      break: { empty: 'reset' },
      delete: { start: 'reset' },
    },
  });

  For custom reset logic (previously onReset):

  // Before
  ResetNodePlugin.configure({
    options: {
      rules: [
        {
          types: [CodeBlockPlugin.key],
          defaultType: ParagraphPlugin.key,
          hotkey: 'Enter',
          predicate: isCodeBlockEmpty,
          onReset: unwrapCodeBlock,
        },
      ],
    },
  });
  
  // After
  CodeBlockPlugin.configure({
    rules: {
      delete: { empty: 'reset' },
    },
  }).overrideEditor(({ editor, tf: { resetBlock } }) => ({
    transforms: {
      resetBlock(options) {
        if (
          editor.api.block({
            at: options?.at,
            match: { type: editor.getType(CodeBlockPlugin.key) },
          })
        ) {
          unwrapCodeBlock(editor);
          return;
        }
  
        return resetBlock(options);
      },
    },
  }));