1.0.1 • Published 4 months ago
plate-rich-editor v1.0.1
Plate Rich Editor
A powerful and customizable rich text editor based on Plate and React.
Installation
npm install plate-rich-editor
# or
yarn add plate-rich-editor
# or
pnpm add plate-rich-editor
Requirements
This package has the following peer dependencies:
- React >= 17.0.0
- ReactDOM >= 17.0.0
Usage
Basic Usage
import { PlateEditor } from 'plate-rich-editor';
function MyEditor() {
return (
<PlateEditor>
{/* Your editor content */}
</PlateEditor>
);
}
With Drag and Drop
The editor comes with built-in drag and drop support. The DnD provider is automatically included when you use the PlateEditor
component.
import { PlateEditor } from 'plate-rich-editor';
function MyEditorWithDnD() {
return (
<PlateEditor>
{/* Your draggable content */}
</PlateEditor>
);
}
If you need to use the DnD provider separately:
import { PlateEditorDndProvider } from 'plate-rich-editor/dnd';
function CustomEditor() {
return (
<PlateEditorDndProvider>
{/* Your custom editor implementation */}
</PlateEditorDndProvider>
);
}
Features
- 🎨 Modern and beautiful UI components
- 📝 Rich text editing capabilities
- 🎯 AI-powered suggestions
- 📸 Media support (images, videos, etc.)
- 📋 Tables and lists
- 🔗 Links and mentions
- 🎨 Custom styling and theming
- 📱 Responsive design
- 🔌 Extensible plugin system
- 🔄 Drag and drop support
Documentation
For detailed documentation and examples, please visit our documentation site.
Contributing
Contributions are welcome! Please read our contributing guidelines for details.
License
This project is licensed under the MIT License - see the LICENSE file for details.