Ugrás a tartalomhoz

Telepítés ​

Követelmények ​

  • Vue 3.5+
  • vue-i18n 11+
  • Vuetify 3.8+ vagy Vuetify 4.x
  • @mdi/js (Material Design Icons)

A csomag telepítése ​

bash
npm i tiptapify
bash
pnpm i tiptapify
bash
yarn add tiptapify

Peer függőségek ​

A Tiptapify az alábbi peer függőségeket igényli. Győződj meg róla, hogy telepítve vannak a projektedben:

bash
npm i @mdi/js vue vue-i18n vuetify

A Vuetify beállítása ​

Regisztráld a Vuetify-t MDI ikonokkal a main.ts / main.js fájlban:

typescript
import { createApp } from 'vue'
import App from './App.vue'

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

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

const app = createApp(App)
app.use(vuetify)
app.mount('#app')

A Tiptapify plugin regisztrálása ​

Az alkalmazás belépési fájljában importáld és regisztráld a Tiptapify plugint:

typescript
import { createI18n } from 'vue-i18n'
import TiptapifyPlugin from 'tiptapify'
import 'tiptapify/style.css'

const i18n = createI18n({
  legacy: false,
  locale: 'en',
})

app.use(i18n)
app.use(TiptapifyPlugin, { i18n })

Teljes példa ​

Íme egy teljes main.ts beállítás:

typescript
import { createApp } from 'vue'
import App from './App.vue'

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

import { createI18n } from 'vue-i18n'
import TiptapifyPlugin from 'tiptapify'
import 'tiptapify/style.css'

const i18n = createI18n({
  legacy: false,
  locale: 'en',
})

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

const app = createApp(App)

app.use(vuetify)
app.use(i18n)
app.use(TiptapifyPlugin, { i18n })

app.mount('#app')

Vue 3 + Composition API beállítás ​

Ha <script setup> szintaxist használsz, a szerkesztő azonnal használható:

vue
<script setup lang="ts">
const handleEditorReady = (options) => {
  console.log('HTML:', options.getHTML())
  console.log('JSON:', options.getJSON())
}
</script>

<template>
  <Tiptapify
    placeholder="Start writing..."
    @editor-ready="handleEditorReady"
  />
</template>

Használat CDN-ről ​

Gyors prototípus-készítéshez a Tiptapify betölthető CDN-ről:

html
<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tiptapify@latest/dist/tiptapify.css" />
</head>
<body>
  <div id="app">
    <tiptapify placeholder="Start typing..."></tiptapify>
  </div>
  <script type="module">
    import { createApp } from 'https://unpkg.com/vue@3/dist/vue.esm-browser.js'
    import TiptapifyPlugin from 'https://cdn.jsdelivr.net/npm/tiptapify@latest/dist/tiptapify.mjs'
    import 'https://cdn.jsdelivr.net/npm/tiptapify@latest/dist/tiptapify.css'
    // Note: CDN usage requires Vue, Vuetify, and @mdi/js to be loaded separately
  </script>
</body>
</html>

CDN korlátai

A CDN használata éles környezetben nem ajánlott. Éles telepítésekhez mindig modulkötegelőt (Vite, Webpack) használj.

MIT licenc alatt kiadva.