Tipe

TiptapifyEditor

Class Tiptap Editor yang diperluas dengan properti tambahan.

declare class TiptapifyEditor extends Editor {
  interactiveStyles: boolean | undefined
}

variantBtnTypes

Menentukan nilai yang valid untuk prop variantBtn pada <Tiptapify>. Nilainya diterapkan ke setiap tombol toolbar melalui konfigurasi bersama editor (lihat useTiptapifyConfig).

type variantBtnTypes = 'outlined' | 'plain' | 'flat' | 'text' | 'elevated' | 'tonal' | undefined

variantFieldTypes

Menentukan nilai yang valid untuk prop variantField pada <Tiptapify>. Nilainya diterapkan ke kolom dropdown toolbar melalui konfigurasi bersama editor (lihat useTiptapifyConfig).

TiptapifyFooterAlignment

Menentukan nilai yang valid untuk prop footerAlignment pada komponen <Tiptapify>.

type TiptapifyFooterAlignment = 'start' | 'center' | 'end'

<Tiptapify footer-alignment="center" />

TiptapifySkin

Menentukan nama bawaan untuk prop skin pada komponen <Tiptapify>: tampilan chrome editor.

type TiptapifySkin = 'default' | 'pastel'

• default — tampilan klasik: toolbar timbul, grup tombol sebagai kotak timbul, tombol Vuetify dengan status ditekan berwarna primer.
• pastel — tampilan tenang: toolbar datar berwarna lembut, tombol ghost, dropdown ringan, dialog lembut.

Skin kustom menambahkan nama: registerSkin('mint', { extends: 'pastel', colors: { … } }); defineSkin adalah helper identitas untuk definisi const bertipe. Keduanya diekspor dari tiptapify.

<Tiptapify skin="pastel" />

TiptapifyShape

Varian struktural yang tidak dapat diungkapkan oleh token (markup komponen, pengikatan prop Vuetify). Shape menentukan kumpulan aturan skin mana yang berlaku; token yang mewarnainya.

type TiptapifyShape = {
  toolbar?: 'raised' | 'flat'   // elevated bar vs flat tinted bar
  groups?: 'box' | 'flat'       // toolbar sections as raised boxes vs plain runs
  buttons?: 'vuetify' | 'quiet' // native Vuetify buttons vs ghost buttons
  bubble?: 'card' | 'flat'      // kept for compatibility: the bubble menus are one row in both
  dialog?: 'classic' | 'soft'   // classic dialog chrome vs soft card
  menu?: 'vuetify' | 'soft'     // dropdown menus: Vuetify list vs padded card
}

// The shape after resolution: every key set (missing keys fall back to classic)
type ResolvedShape = Required<TiptapifyShape>

Setiap skin diselesaikan di atas shape klasik. Shape yang telah diselesaikan diekspos sebagai shape: ComputedRef<ResolvedShape> pada TiptapifyConfig, sehingga komponen toolbar kustom dapat mengikutinya.

TiptapifySkinColors

Katalog token warna skin: toolbar, grup, tombol, bubble menu, dropdown, dialog, bingkai, gambar, dan handle pengubah ukuran. Setiap key camelCase dipetakan ke variabel CSS --tf-* (toolbarBg → --tf-toolbar-bg). Tabel lengkapnya ada di panduan Skin.

TiptapifySkinMetrics

Katalog token metrik skin: jarak, ukuran, dan radius untuk area yang sama, dengan pemetaan key → --tf-* yang sama. Tabel lengkapnya ada di panduan Skin.

TiptapifySkinInput

Tipe lengkap prop skin: nama skin terdaftar (string) atau objek skin inline.

type TiptapifySkinInput = string | TiptapifySkinConfig

type TiptapifySkinConfig = TiptapifyShape & {
  name?: string
  // registered skin name to inherit from; implicit 'default'
  extends?: string
  colors?: Partial<TiptapifySkinColors>
  metrics?: Partial<TiptapifySkinMetrics>
}

Objek inline diselesaikan melalui rantai yang sama dengan skin terdaftar (classic → extends → milik sendiri), tidak pernah masuk ke registry global, dan dirender dengan class tiptapify-skin-inline kecuali memiliki name. Token-nya dikeluarkan sebagai variabel CSS --tf-* pada root editor.

TiptapifyContentStyles

Tipe prop contentStyles (lihat Gaya konten).

type TiptapifyContentStyles = 'inline' | 'classes'

// The content HTML with the content styles written into its style attributes (unchanged without a DOM)
function inlineContentStyles(html: string): string

// The content styles as a stylesheet for the content inside `scope`, weightless (:where) by default
function contentCss(scope?: string, options?: { weightless?: boolean }): string

TiptapifyUploadOptions

Tipe prop upload: endpoint unggahan.

type TiptapifyUploadOptions = {
  // POST {endpoint}: multipart `file` and `kind`, answered by { url } (or an error status with { error })
  endpoint: string
  // extra request headers, e.g. authorization
  headers?: Record<string, string>
}

// The `kind` field of an upload
type TiptapifyUploadKind = 'image' | 'video'

TiptapifyLinkPreviewOptions

Tipe prop linkPreview dan data yang dijawab endpoint-nya (lihat Kartu tautan).

type TiptapifyLinkPreviewOptions = {
  // GET {endpoint} answers the handshake, GET {endpoint}?url=<page> the data of the page
  endpoint: string
  headers?: Record<string, string>
}

type TiptapifyLinkPreviewData = {
  url: string
  title?: string
  description?: string
  image?: string
  siteName?: string
}

TiptapifyConfig

Konfigurasi UI tingkat editor yang dibagikan ke setiap komponen di dalam <Tiptapify> melalui provide/inject Vue. Baca di komponen toolbar Anda sendiri dengan useTiptapifyConfig.

import type { ComputedRef, Ref } from 'vue'

interface TiptapifyConfig {
  variantBtn: Ref<variantBtnTypes>
  variantField: Ref<variantFieldTypes>
  // the raw `skin` prop: a registered name (string) or an inline skin object
  skin: Ref<TiptapifySkinInput>
  // the resolved skin name ('inline' for an inline object without a name)
  skinName: ComputedRef<string>
  // css variable name -> value; only overrides, the css fallbacks carry the base
  tokens: ComputedRef<Record<string, string>>
  // the resolved shape — every key set, see [ResolvedShape](#tiptapifyshape)
  shape: ComputedRef<ResolvedShape>
}

Nilainya reaktif: mengubah prop variantBtn / variantField / skin pada <Tiptapify> memperbarui setiap komponen toolbar tanpa merender ulang props.

useTiptapifyConfig

Mengembalikan konfigurasi bersama dari instance <Tiptapify> tempat komponen pemanggil berada. Ditujukan untuk komponen toolbar kustom (lihat Toolbar Kustom).

function useTiptapifyConfig(): TiptapifyConfig

<script setup lang="ts">
import { useTiptapifyConfig } from 'tiptapify'

const { variantBtn, variantField, skin } = useTiptapifyConfig()
</script>

<template>
  <VBtn :variant="variantBtn" size="32" />
</template>

Di luar instance <Tiptapify>, composable ini kembali ke default paket: variantBtn flat, variantField solo, dan skin default (shape classic, tanpa token yang dikeluarkan).

enum ToolbarSectionsEnum {
  actions = 'actions',
  ai = 'ai',
  alignment = 'alignment',
  extra = 'extra',
  formatExtra = 'formatExtra',
  format = 'format',
  list = 'list',
  media = 'media',
  misc = 'misc',
  style = 'style',
}

Tipe AI

type TiptapifyAiProvider = (
  request: TiptapifyAiRequest,
  context: TiptapifyAiEditorContext,
  stream?: TiptapifyAiStream,
) => Promise<TiptapifyAiResponse | TiptapifyAiOpenAiResponse | string>

interface TiptapifyAiStream {
  signal: AbortSignal
  onChunk: (chunk: string) => void
  onReasoning: (chunk: string) => void
}

type TiptapifyAiChatRole = 'system' | 'user' | 'assistant' | 'developer' | 'tool'

interface TiptapifyAiChatMessage {
  role: TiptapifyAiChatRole
  content: string
}

interface TiptapifyAiRequest {
  model?: string
  messages: TiptapifyAiChatMessage[]
  temperature?: number
  stream?: boolean
  [key: string]: unknown
}

type TiptapifyAiReasoningEffort = 'low' | 'medium' | 'high'

interface TiptapifyAiReasoningEffortOptions {
  options: TiptapifyAiReasoningEffort[]
  default?: TiptapifyAiReasoningEffort
}

interface TiptapifyAiEditorContext {
  prompt: string
  selectedText: string  // whole words: a selection cut inside a word takes the word
  textBefore: string    // the selection's paragraph before it, up to 500 characters ('' without a selection)
  textAfter: string     // the selection's paragraph after it, up to 500 characters
  text: string
  html: string
  json: object
  mode: 'insert' | 'replace' | 'append'
}

interface TiptapifyAiResponse {
  content: string
}

interface TiptapifyAiOpenAiResponse {
  choices?: Array<{
    message?: {
      content?: string
    }
    text?: string
  }>
}

interface TiptapifyAiBackendRequest {
  prompt: string
  instruction: string
  stream?: boolean
  thinking?: boolean
  reasoning_effort?: TiptapifyAiReasoningEffort
  model?: string
}

interface TiptapifyAiBackendProviderOptions {
  endpoint: string
  headers?: Record<string, string>
  tokenProvider?: TiptapifyAiTokenProvider
}

function createAiBackendProvider(options: TiptapifyAiBackendProviderOptions): TiptapifyAiProvider

interface TiptapifyAiPromptExample {
  title: string
  prompt: string
}

interface TiptapifyAiOptions {
  aiProvider?: TiptapifyAiProvider
  aiEndpoint?: string
  aiHeaders?: Record<string, string>
  model?: string
  promptExamples?: TiptapifyAiPromptExample[]
  mode?: 'insert' | 'replace' | 'append'
  defaultPrompt?: string
  systemPrompt?: string
  temperature?: number
  stream?: boolean
  thinking?: boolean
  reasoningEffort?: TiptapifyAiReasoningEffortOptions
  showReasoning?: boolean
  chatCompletionOptions?: Record<string, unknown>
  createMessages?: (context: TiptapifyAiEditorContext) => TiptapifyAiChatMessage[]
  tokenProvider?: () => Promise<string | null> | string | null
  storage?: {
    getItem: (key: string) => string | null | Promise<string | null>
    setItem: (key: string, value: string) => void | Promise<void>
    removeItem: (key: string) => void | Promise<void>
  }
}

sectionComponent

interface sectionComponent {
  name: string
  component: any
  props?: { [key: string]: any }
}

section

interface section {
  section: string
  group: boolean
  components: sectionComponent[]
  extensions?: Array<any>
}

toolbarSections

type toolbarSections = Array<section>

itemsPropType

Menentukan nilai yang valid untuk prop items.

type itemsPropType = { [key: string]: Array<string> } | Array<string>

Format array — daftar datar nama item:

const items: itemsPropType = [
  'bold', 'italic', 'underline', '|', 'heading', 'bulletList'
]

Format objek — seksi bernama:

const items: itemsPropType = {
  formatting: ['bold', 'italic', 'underline'],
  headings: ['heading'],
  lists: ['bulletList', 'orderedList'],
}

EditorReadyPayload

Dikeluarkan melalui event editor-ready.

interface EditorReadyPayload {
  editor: TiptapifyEditor  // Tiptapify Editor instance
  getHTML: () => string     // Returns current HTML
  getJSON: () => object     // Returns current JSON
}

ContentChangedPayload

Dikeluarkan melalui event content-changed.

interface ContentChangedPayload {
  html: string   // Current HTML content
  json: object   // Current JSON content
}

TiptapifyOptions

Opsi yang diberikan saat memasang plugin.

interface TiptapifyOptions {
  i18n: I18n  // vue-i18n instance
}

Ekspor Ulang

Utilitas berikut diekspor ulang dari @tiptap/core untuk kemudahan saat membangun ekstensi kustom:

Ekspor	Jenis	Sumber
Node	Class	@tiptap/core
Mark	Class	@tiptap/core
mergeAttributes	Fungsi	@tiptap/core
markInputRule	Fungsi	@tiptap/core
markPasteRule	Fungsi	@tiptap/core
CommandProps	Tipe	@tiptap/core
InputRuleMatch	Tipe	@tiptap/core
PasteRuleMatch	Tipe	@tiptap/core

import { Node, Mark, mergeAttributes, markInputRule, markPasteRule } from 'tiptapify'
import type { CommandProps, InputRuleMatch, PasteRuleMatch } from 'tiptapify'

mdi

Material Design Icons dari @mdi/js diekspor ulang untuk kustomisasi ikon toolbar.

import { mdi } from 'tiptapify'

useTiptapifyConfig

Composable untuk membaca konfigurasi UI tingkat editor (variantBtn, variantField) dari komponen toolbar kustom. Lihat useTiptapifyConfig.

import { useTiptapifyConfig } from 'tiptapify'

TipTapEditor

Class Editor @tiptap/vue-3 yang mendasarinya.

import { TipTapEditor } from 'tiptapify'

Tiptapify / TiptapifyDialog

Komponen editor dan dialog tersedia sebagai named export untuk digunakan langsung.

import { Tiptapify, TiptapifyDialog } from 'tiptapify'