@remirror/react-ui
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

@remirror/react-ui

A selection of optional react components for your remirror editor, powered by @mui/material.

Version Weekly Downloads Bundled size Typed Codebase MIT License

Installation

# yarn
yarn add @remirror/react-ui @remirror/react

# pnpm
pnpm add @remirror/react-ui @remirror/react

# npm
npm install @remirror/react-ui @remirror/react

This is NOT included by default when you install the recommended @remirror/react package.

Translations

The components used here expect a translation library to be present to render tooltips etc.

This can be provided via the i18nFormat prop to the root Remirror component.

You can use the provided @remirror/i18n package, or you can provide your own i18n library (see the i18n examples in Storybook)

import { i18nFormat } from '@remirror/i18n';
import { Remirror, useRemirror } from '@remirror/react';
import { TopToolbar } from '@remirror/react';

const Editor: React.FC = () => {
  const { manager } = useRemirror({
    extensions: () => [
      // Some extensions here
    ],
  });

  return (
    <Remirror manager={manager} i18nFormat={i18nFormat} autoRender='end'>
      <TopToolbar />
    </Remirror>
  );
};

Readme

Keywords

none

Package Sidebar

Install

npm i @remirror/react-ui

Weekly Downloads

9,101

Version

1.0.2

License

MIT

Unpacked Size

622 kB

Total Files

86

Last publish

Collaborators

  • ifiokjr
  • ocavue