Skip to content

IVoyt/tiptapify

Repository files navigation

Tiptapify


Tiptap 3 (beta) editor for Vue3 with Vuetify menu implementation

Requirements

  • Vue 3.x
  • Vuetify.js 3.x

Features

  • Vuetify components
  • Markdown support
  • TypeScript support
  • I18n support(en, ru, ua, pl, fr, de, it, es, more later)
  • Vuetify 3.x and Vue 3.x support
  • Bubble Menu
  • Floating Menu
  • Slash Command

Installation

Install package

# npm
npm i tiptapify

# or pnpm
pnpm i tiptapify

Register plugin in your main.js (main.ts)

import TiptapifyPlugin from 'tiptapify';
import 'tiptapify/style.css';
app.use(TiptapifyPlugin, { locale: 'en' });

Should be something like this

import { createApp } from "vue";
import App from "./App.vue";

import 'vuetify/styles'
import { createVuetify } from 'vuetify'
import { aliases, mdi } from 'vuetify/iconsets/mdi-svg'
import * as components from 'vuetify/components'
import * as directives from 'vuetify/directives'

const app = createApp(App)

const vuetify = createVuetify({
  components,
  directives,
  icons: { defaultSet: 'mdi', aliases, sets: { mdi } },
})

app.use(vuetify);

// add these lines
import TiptapifyPlugin from 'tiptapify';
import 'tiptapify/style.css';
app.use(TiptapifyPlugin, { locale: 'en' });

// Mount vue app
app.mount('#app')

TODO

  • menu items list customizable
  • extend a built-in font list
  • raw html mode
  • tables extension
  • preview extension
  • image extension
  • text styling (background & font color)
  • print hotkey in tooltip
  • video extensions
  • emoji plugin
  • option to use custom component for link & media extension
  • option to provide custom extension
  • demo
  • documentation
  • dark theme
  • AI features

Licence

MIT

About

Tiptap3 editor with Vuetify3 menu implementation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published