Types

TiptapifyEditor

Extended Tiptap Editor class with additional properties.

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

variantBtnTypes

Defines valid values for the variantBtn prop on <Tiptapify>. The value is applied to every toolbar button through the editor's shared config (see useTiptapifyConfig).

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

variantFieldTypes

Defines valid values for the variantField prop on <Tiptapify>. The value is applied to toolbar dropdown fields through the editor's shared config (see useTiptapifyConfig).

TiptapifyFooterAlignment

Defines valid values for the footerAlignment prop on the <Tiptapify> component.

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

<Tiptapify footer-alignment="center" />

TiptapifyConfig

Editor-level UI configuration shared with every component inside <Tiptapify> via Vue provide/inject. Read it in your own toolbar components with useTiptapifyConfig.

import type { Ref } from 'vue'

interface TiptapifyConfig {
  variantBtn: Ref<variantBtnTypes>
  variantField: Ref<variantFieldTypes>
}

Values are reactive: changing the variantBtn / variantField prop on <Tiptapify> updates every toolbar component without re-rendering props.

useTiptapifyConfig

Returns the shared config of the <Tiptapify> instance that the calling component belongs to. Intended for custom toolbar components (see Custom Toolbar).

function useTiptapifyConfig(): TiptapifyConfig

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

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

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

Outside of a <Tiptapify> instance the composable falls back to the package defaults (flat / solo).

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

AI Types

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
  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

Defines valid values for the items prop.

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

Array format — flat list of item names:

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

Object format — named sections:

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

EditorReadyPayload

Emitted via the editor-ready event.

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

ContentChangedPayload

Emitted via the content-changed event.

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

TiptapifyOptions

Options passed when installing the plugin.

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

Re-exports

The following utilities are re-exported from @tiptap/core for convenience when building custom extensions:

Export	Kind	Source
Node	Class	@tiptap/core
Mark	Class	@tiptap/core
mergeAttributes	Function	@tiptap/core
markInputRule	Function	@tiptap/core
markPasteRule	Function	@tiptap/core
CommandProps	Type	@tiptap/core
InputRuleMatch	Type	@tiptap/core
PasteRuleMatch	Type	@tiptap/core

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

mdi

Material Design Icons from @mdi/js are re-exported for toolbar icon customization.

import { mdi } from 'tiptapify'

useTiptapifyConfig

Composable for reading the editor-level UI config (variantBtn, variantField) from custom toolbar components. See useTiptapifyConfig.

import { useTiptapifyConfig } from 'tiptapify'

TipTapEditor

The underlying @tiptap/vue-3 Editor class.

import { TipTapEditor } from 'tiptapify'

Tiptapify / TiptapifyDialog

The editor and dialog components are available as named exports for direct use.

import { Tiptapify, TiptapifyDialog } from 'tiptapify'