README.md

React Native Rich Editor - an Easy-to-use Rich Text Editor for React Native App

⚠️The project is still in the development phase and there may be some issues affecting the normal use.

Platforms Supported

• iOS
• Android
• Expo (Android, iOS)

Try It Now!

Try it now in Expo Go !

Open the camera app on your device and scan the code below:

Preview Build

Release Build

Getting Started

Read our Getting Started Guide. If any step seems unclear, please create a detailed issue.

Install

$ yarn add @ziqch/react-native-rich-editor

(or)

For npm use

$ npm install --save @ziqch/react-native-rich-editor

Usage

Import the ReactNativeRichEditor component from @ziqch/react-native-rich-editor and use it like so:

import {
  Format,
  ReactNativeRichEditor,
  RichEditorToolBar,
} from '@ziqch/react-native-rich-editor';

// ...
const MyComponent = () => {
  return (
    <ReactNativeRichEditor
      height={height}
      width={width}
      defaultValue={[
        { insert: 'Hello ' },
        { insert: 'World!', attributes: { bold: true } },
        { insert: '\n' },
      ]}
    >
      <RichEditorToolBar
        tools={[
          <Format.Basic format={'bold'} icon={() => <YourIcon/>} />,
        ]}
      />
    </ReactNativeRichEditor>
  )
}

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

Made with create-react-native-library