# RichTextEditor

Редактор на TipTap. Єдиний компонент бібліотеки із зовнішніми залежностями.


Це **єдиний виняток** із правила «бібліотека без зовнішніх залежностей».
ProseMirror переписати неможливо, а редактор без нього — не редактор.

## Залежності

Скопіювавши компонент, поставте:

```bash
bun add @tiptap/core@3.30.2 @tiptap/pm@3.30.2 @tiptap/vue-3@3.30.2 @tiptap/starter-kit@3.30.2 @tiptap/extensions@3.30.2 @tiptap/extension-paragraph@3.30.2 @tiptap/extension-image@3.30.2 @tiptap/extension-table@3.30.2 @tiptap/extension-text-style@3.30.2 @tiptap/extension-highlight@3.30.2 @tiptap/extension-text-align@3.30.2 @tiptap/extension-typography@3.30.2 @tiptap/extension-subscript@3.30.2 @tiptap/extension-superscript@3.30.2 @floating-ui/dom
```

**Версії точні, і це не педантизм.** `@tiptap/vue-3` пінує `@tiptap/core` та
`@tiptap/pm` точно, а решта сімейства залежить одне від одного через карет.
Варто зафіксувати лише частину — і решта поїде вперед: у нас `extension-list`
підтягнувся на 3.30.2, поки закріплений `core` лишався на 3.27.3, і імпорт
упав на відсутньому експорті. Додайте ще й `overrides`:

```json
{ "overrides": { "@tiptap/core": "3.30.2", "@tiptap/pm": "3.30.2" } }
```

Дві копії ProseMirror у графі — найгірший зі сценаріїв: помилки не буде
взагалі, просто всі команди мовчки перестануть працювати, бо схеми
походитимуть з різних інстансів. Перевірка одним рядком:

```bash
find node_modules -type d -name prosemirror-model | wc -l
```

Чого в списку **немає** і чому: `extension-link`, `-underline`,
`-horizontal-rule`, `-blockquote` уже всередині `starter-kit`; `-placeholder`
і `-character-count` — у `@tiptap/extensions`; `-color` — у `-text-style`;
`-table-row`, `-table-cell`, `-table-header` — у `-table`. Поставити їх
окремо означає покласти в граф другу копію того самого розширення.

## Приклад


Example (app/demos/rich-text-editor/RichTextEditorBasic.vue):

```vue
<script setup lang="ts">
import { ref } from 'vue'
import UiProse from '~/components/ui/UiProse.vue'
import UiRichTextEditor from '~/components/ui/UiRichTextEditor.vue'

const html = ref(
  '<h2>Спробуйте відредагувати</h2><p>Нижче — той самий HTML, показаний через ' +
    '<code>UiProse</code>. Обидва несуть однаковий клас, тож розійтися не можуть.</p>' +
    '<ul><li>жирний через Ctrl+B</li><li>курсив через Ctrl+I</li></ul>',
)
</script>

<template>
  <div class="w-full space-y-3">
    <UiRichTextEditor v-model="html" mode="full" :max-chars="600" min-height="9rem" />

    <div class="rounded-card border border-line bg-subtle p-4">
      <p class="mb-2 text-xs font-medium text-muted">Те саме через UiProse:</p>
      <UiProse :html="html" />
    </div>
  </div>
</template>

```


## API

[Props, events, slots, exposed API (JSON)](https://ui.tatet.net/api/component-meta/UiRichTextEditor)

## Коли використовувати

Для вмісту, який пишуть люди й читають люди: стаття, опис, довгий коментар.

## Коли НЕ використовувати

Для короткого тексту без форматування беріть `UiTextarea` — 180 КБ заради
одного рядка не варті нічого.

Не використовуйте як редактор коду. Тут немає ні підсвітки синтаксису, ні
відступів — для цього потрібен інший інструмент.

## Чому немає ClientOnly

Перевірено, а не припущено: `useEditor` створює інстанс усередині
`onMounted`, а `EditorContent` на сервері рендерить порожній `<div>`. Тобто
надісланий HTML і перший клієнтський рендер збігаються, і гідрація чиста.

Обгортка в `ClientOnly` була б не лише зайвою, а й шкідливою: це специфіка
Nuxt, а бібліотеку копіюють і у Vite-проєкти.

## Зв'язок із UiProse

Корінь ProseMirror несе клас `ui-prose` — **той самий**, що й `UiProse`. Це і
є контракт WYSIWYG: якби оформлення жило у scoped-стилях редактора,
публічній сторінці довелося б мати власну копію, і копії розійшлися б за
перший тиждень.

Тому `ui-prose.css` — обов'язкова залежність, а не рекомендація.


## Event descriptions

- `update:modelValue`: Новий HTML документа. Спрацьовує на кожну транзакцію.
- `focus`: Редактор отримав фокус.
- `blur`: Редактор втратив фокус.


[Source files, dependencies and ZIP](https://ui.tatet.net/registry/components/rich-text-editor.json)
