Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lxsmnsyc/solid-tiptap
SolidJS bindings for tiptap
https://github.com/lxsmnsyc/solid-tiptap
Last synced: 3 days ago
JSON representation
SolidJS bindings for tiptap
- Host: GitHub
- URL: https://github.com/lxsmnsyc/solid-tiptap
- Owner: lxsmnsyc
- License: mit
- Created: 2021-09-01T16:23:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T04:27:57.000Z (11 months ago)
- Last Synced: 2024-12-24T09:08:05.312Z (10 days ago)
- Language: TypeScript
- Size: 1000 KB
- Stars: 120
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# solid-tiptap
> SolidJS bindings for [tiptap](https://www.tiptap.dev/)
[](https://www.npmjs.com/package/solid-tiptap) [](https://github.com/airbnb/javascript) [](https://stackblitz.com/github/lxsmnsyc/solid-tiptap/tree/main/examples/simple-example)
## Install
```bash
npm i @tiptap/core @tiptap/pm solid-tiptap
```
```bash
yarn add @tiptap/core @tiptap/pm solid-tiptap
```
```bash
pnpm add @tiptap/core @tiptap/pm solid-tiptap
```
## Usage
```jsx
import { createTiptapEditor } from 'solid-tiptap';
import StarterKit from '@tiptap/starter-kit';
function App() {
let ref!: HTMLDivElement;
const editor = createTiptapEditor(() => ({
element: ref!,
extensions: [
StarterKit,
],
content: `
Example Text
`,
}));
return
;
}
```
### Transactions
`createEditorTransaction` provides a way to reactively subscribe to editor changes.
```ts
const isBold = createEditorTransaction(
() => props.editor, // Editor instance from createTiptapEditor
(editor) => editor.isActive('bold'),
);
createEffect(() => {
if (isBold()) {
// do something
}
});
```
There are out-of-the-box utilities that wraps `createEditorTransaction` based on the [Editor API](https://www.tiptap.dev/api/editor):
- `useEditorCharacterCount`: reactively subscribe to `getCharacterCount`.
```js
const count = useEditorCharacterCount(() => props.editor);
createEffect(() => {
console.log('Character Count:', count());
});
```
- `useEditorHTML`: reactively subscribe to `getEditorHTML`.
```js
const html = useEditorHTML(() => props.editor);
createEffect(() => {
updateHTML(html());
});
```
- `useEditorIsActive`: reactively subscribe to `isActive`.
```js
const isHeading = useEditorIsActive(() => props.editor, () => 'heading', {
level: 1,
});
createEffect(() => {
if (isHeading()) {
// do something
}
});
```
- `useEditorIsEditable`: reactively subscribe to `isEditable`.
```js
const isEditable = useEditorIsEditable(() => props.editor);
createEffect(() => {
if (isEditable()) {
// do something
}
});
```
- `useEditorIsEmpty`: reactively subscribe to `isEmpty`.
```js
const isEmpty = useEditorIsEmpty(() => props.editor);
createEffect(() => {
if (isEmpty()) {
// do something
}
});
```
- `useEditorIsFocused`: reactively subscribe to `isFocused`.
```js
const isFocused = useEditorIsFocused(() => props.editor);
createEffect(() => {
if (isFocused()) {
// do something
}
});
```
- `useEditorJSON`: reactively subscribe to `getJSON`.
```js
const json = useEditorJSON(() => props.editor);
createEffect(() => {
const data = json();
if (data) {
uploadJSON(data);
}
});
```
## Tips
Since `createTiptapEditor` may return `undefined` (the instanciation is scheduled), and you're planning to pass it to another component (e.g. creating `BubbleMenu` or Toolbar), it is recommended to use ternary evaluation (e.g. ``) to check if the editor is `undefined` or not.
```js
const editor = createTiptapEditor(() => ({ ... }));
{(instance) => }
```
## Sponsors
## License
MIT © [lxsmnsyc](https://github.com/lxsmnsyc)