Accept type-keyed react render functions

[MichaelDarr]

Status

The contents of this PR represent an in-progress implementation of a proposal. If it is decided to move forward in this direction, tests, a changeset, and additional documentation will be written and added to this PR.

Description
These changes allow type-specific render functions to passed into the Editable component directly. The renderElement and renderLeaf properties now accept either a single render function (the current standard) or an object mapping the type property of the relevant Descendant to its render function.

Example

This PR uses the new pattern for element renderers in the inlines example:

custom-types.d.ts

export type LinkElement = { type: 'link'; url: string; children: Descendant[] }
export type ButtonElement = { type: 'button'; children: Descendant[] }

declare module 'slate' {
    interface CustomTypes {
        Element: ButtonElement | LinkElement
    }
}

inlines.tsx

const EditableButtonComponent: SlateReact.ElementRenderer<'button'> = ({
  attributes,
  children,
  element,
}) => {
  // `element` is `ButtonElement`
  //...
}

// ...

const LinkComponent: SlateReact.ElementRenderer<'link'> = ({
  attributes,
  children,
  element,
}) => {
  // `element` is `LinkElement`
  //...
}

// ...

<Editable
  renderElement={{
    button: EditableButtonComponent,
    link: LinkComponent,
  }}
  // ...
/>

Context
In my experience, defining and maintaining Text and Element render functions is tedious. As seen in several of the examples, these render functions are usually just a huge, awkward switch statements.

These changes provide a more direct, less cumbersome method of passing typed render functions to Slate. Care has been taken to make these changes non-breaking.

Checks

• The new code matches the existing patterns and styles.
• The tests pass with yarn test.
• The linter passes with yarn lint. (Fix errors with yarn fix.)
• The relevant examples still work. (Run examples with yarn start.)
• You've added a changeset if changing functionality. (Add one with yarn changeset add.)

[changeset-bot]

⚠️ No Changeset found

Latest commit: 029565a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR