github-actions[bot]
e3757f300a
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
32 lines
895 B
Plaintext
32 lines
895 B
Plaintext
---
|
|
title: Block Editor
|
|
image: /images/user-guide/api/api.png
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Uses a block-based rich text editor from [BlockNote](https://www.blocknotejs.org/) to allow users to edit and view blocks of content.
|
|
|
|
<Tabs>
|
|
<Tab title="Usage">
|
|
```jsx
|
|
import { useBlockNote } from "@blocknote/react";
|
|
import { BlockEditor } from "@/ui/input/editor/components/BlockEditor";
|
|
|
|
export const MyComponent = () => {
|
|
const BlockNoteEditor = useBlockNote();
|
|
|
|
return <BlockEditor editor={BlockNoteEditor} />;
|
|
};
|
|
```
|
|
</Tab>
|
|
|
|
<Tab title="Props">
|
|
| Props | Type | Description |
|
|
| ------ | ----------------- | ------------------------------------------ |
|
|
| editor | `BlockNoteEditor` | The block editor instance or configuration |
|
|
</Tab>
|
|
</Tabs>
|