@hz-libs/bpe-ui-editor

Rich text editor primitive for Vue 3.

Docs

Install

pnpm add @hz-libs/bpe-ui-editor

The app must already depend on Vue ^3.5.0. Component CSS is included in the JavaScript import.

Use

placeholder is shown while the editor is empty. Pass users, then type @ to filter them and insert a mention. paste-files emits the files when someone pastes an image or other file.

<script setup>
import { PmEditor } from '@hz-libs/bpe-ui-editor'

const users = [
  { id: '1', name: 'Ada Lovelace' },
  { id: '2', name: 'Grace Hopper' }
]
</script>

<template>
  <PmEditor placeholder="Type @ to mention someone" :users="users" />
</template>

Exports

MentionDropdown, PmEditor, useEditor, useMdConverter.