Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remirror/remirror
ProseMirror toolkit for React 🎉
https://github.com/remirror/remirror
browser editor mobile prosemirror react react-prosemirror rich-text-editor text-editor typescript wysiwyg
Last synced: 3 days ago
JSON representation
ProseMirror toolkit for React 🎉
- Host: GitHub
- URL: https://github.com/remirror/remirror
- Owner: remirror
- License: mit
- Created: 2019-01-21T08:59:53.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T20:41:04.000Z (about 1 month ago)
- Last Synced: 2024-10-29T11:17:11.656Z (about 1 month ago)
- Topics: browser, editor, mobile, prosemirror, react, react-prosemirror, rich-text-editor, text-editor, typescript, wysiwyg
- Language: TypeScript
- Homepage: https://remirror.io
- Size: 74.4 MB
- Stars: 2,717
- Watchers: 19
- Forks: 236
- Open Issues: 186
-
Metadata Files:
- Readme: readme.md
- Contributing: docs/contributing.md
- Funding: .github/funding.yml
- License: LICENSE
- Support: support/actions/CHANGELOG.md
Awesome Lists containing this project
- awesome - remirror/remirror - ProseMirror toolkit for React 🎉 (TypeScript)
- awesome-react-components - remirror - [demo](https://remirror.io/playground) - [docs](https://remirror.io/docs) - ProseMirror toolkit for React. (UI Components / Form Components)
- awesome-react - remirror - ProseMirror toolkit for React.  (UI Components / Form Components)
- react-components-awesome - remirror - Source Software][OSS Icon]](https://github.com/remirror/remirror) (Uncategorized / Uncategorized)
- awesome-list - remirror
- awesome-list - remirror
- awesome-react-components - remirror - [demo](https://remirror.io/playground) - [docs](https://remirror.io/docs) - ProseMirror toolkit for React. (UI Components / Form Components)
- best-of-react - GitHub - 27% open · ⏱️ 08.04.2024): (Editor Components)
- fucking-awesome-react-components - remirror - 🌎 [demo](remirror.io/playground) - 🌎 [docs](remirror.io/docs) - ProseMirror toolkit for React. (UI Components / Form Components)
README
A React toolkit for building cross-platform text editors, based on ProseMirror.
Motivation ·
Status ·
Documentation ·
Storybook ·
Contributing
## Introduction
```jsx
import React from 'react';
import { BoldExtension, ItalicExtension, UnderlineExtension } from 'remirror/extensions';
import { Remirror, useRemirror, OnChangeJSON } from '@remirror/react';
const extensions = () => [new BoldExtension(), new ItalicExtension(), new UnderlineExtension()];
const Editor = ({ onChange }) => {
const { manager, state } = useRemirror({
extensions,
content: '
Hi Friend
',
stringHandler: 'html',
selection: 'end',
});
return (
);
};
```
With this code snippet your editor now supports basic editing functionality.
Alternatively, take a look at our [5 minute tutorial](https://remirror.io/docs/5-min-tutorial) to get up and running with an out-of-the-box WYSIWYG editor.
## Installation
```bash
npm install remirror @remirror/react @remirror/pm
# Or
yarn add remirror @remirror/react @remirror/pm
# Or
pnpm add remirror @remirror/react @remirror/pm
```
If you run into any issues we recommend any of the following:
- Open an issue in our [github repo](https://github.com/remirror/remirror/issues).
- [Join our discord server](https://remirror.io/chat) and discuss the problem with our community.
- Create a pull request with your proposed improvement by clicking the edit button on the relevant page.
Whatever you decide thanks for taking the time to explore the **remirror** project.
## Our community
### Sponsors
**[Become a sponsor!](https://github.com/sponsors/remirror)**
### Community spotlight
Benefex
Cobudget
eftax Co., Ltd.
LabKey
Onethread
## Documentation
View our documentation website [**here**][introduction].
- [Introduction]
- [Use an out-of-the-box editor](https://remirror.io/docs/5-min-tutorial)
- [Create your own editor](https://remirror.io/docs/getting-started/installation)
- [Extensions](https://remirror.io/docs/extensions/)
- [Storybook]
- [CodeSandbox starter](https://codesandbox.io/s/github/remirror/remirror-starter)
## Features
- A11y focused and ARIA compatible.
- I18n support via [lingui](https://lingui.dev).
- Great support for mobile devices.
- Out-of-the-box editors, or create own by composing extensions.
- Create your own extensions for bare-metal ProseMirror integration.
- Collaborative editing with [yjs](https://github.com/yjs/yjs) or [prosemirror-collab](https://github.com/ProseMirror/prosemirror-collab).
- 30+ extensions for creating fully customized editing experiences.
- TypeScript as a first class citizen for great developer experience.
## Getting Started
See our [5 minute tutorial](https://remirror.io/docs/5-min-tutorial) to get started!
## Contributing
Please read our [contribution guide] for details on our code of conduct, and the process for submitting pull requests. It also outlines the project structure so you can find help when navigating your way around the codebase.
## Versioning
This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/remirror/remirror/tags).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
[introduction]: https://remirror.io/docs
[contribution guide]: https://remirror.io/docs/contributing
[projects]: https://remirror.io/projects
[installation]: https://remirror.io/docs/installation
[storybook]: https://remirror.vercel.app
[typescript]: https://github.com/microsoft/Typescript
[react]: https://github.com/facebook/react
[prosemirror]: https://prosemirror.net
