1.5.2 • Published 6 months ago
@toneflix/vue-trix v1.5.2
Vue Trix
Simple and lightweight Trix rich-text editor for Vue.js. - See a live demo here.
Documentation
Read the full documentation here
Features
- A simple and lightweight rich-text editor for writing daily.
- Two-way binding with
v-model
easily. - Auto-save editor data temporally what you have typed into the form input in case something goes wrong (for example, the browser could crash or you could accidentally refresh the page without submit saving).
Installation
npm install @toneflix/vue-trix
#or
yarn add @toneflix/vue-trix
#or
pnpm add @toneflix/vue-trix
Usage
Global Registration
You can make Vue Trix available throughout your Vue project.
main.js or main.ts
import 'trix/dist/trix.css'
import { createApp } from 'vue'
import App from './app.vue'
import VueTrix from '@toneflix/vue-trix'
const app = createApp(App)
app.use(VueTrix)
app.mount('#app')
Local Registration
You can also import the component in your Vue component.
SomeComponent.vue
<script setup>
import 'trix/dist/trix.css'
import { VueTrix } from '@toneflix/vue-trix'
</script>
Create a simple editor in your single component file
SomeComponent.vue
<script setup lang="ts">
import 'trix/dist/trix.css'
import { VueTrix } from '@toneflix/vue-trix'
import { ref } from 'vue'
const value = ref<string>('')
</script>
<template>
<div style="display: flex; flex-direction: row;">
<vue-trix v-model="value" />
</div>
</template>