Registering new formats

pete87p · May 17, 2024, 7:04pm

Hi,

I have tried to register a new format without any luck. I have the following below. Could anyone point to the right of how to register a new format? Thank you in advance.

editor.js

roots.register.formats(‘@scripts/formats’)

scripts/formats/test.format.js

export default {
name: bud-project/example-format,
title: Example format,
tagName: ‘span’,
className: ‘example-format’,
}

ben · May 21, 2024, 4:39pm

Here’s an example from the bud repo:

github.com

roots/bud/blob/35861a7589439046bcc94511d1c6aba01da22a58/examples/wordpress-editor/src/underline.format.js

import { RichTextToolbarButton } from '@wordpress/block-editor';
import { toggleFormat } from '@wordpress/rich-text';

export const name = `example/underline`;
export const title = `Underline`;
export const tagName = `u`;
export const className = null;

export const edit = ({ isActive, onChange, value }) => (
  <RichTextToolbarButton
    icon="editor-underline"
    title="Underline"
    isDisabled
    onClick={() =>
      onChange(
        toggleFormat(value, {
          type: name,
        })
      )
    }

This file has been truncated. show original