WYSIWYG

npm license npm download GitHub top language GitHub issues npm version

What-you-see-is-what-you-get text editor

Usage

The components can be used outside of the Enso ecosystem.

Demo

For live examples and demos, you may visit laravel-enso.com

Installation

Install the package:

yarn add @enso-ui/wysiwyg

Import the desired component(s):

import Wysiwyg from '@enso-ui/wysiwyg/bulma';

Note that this package has a couple of external dependencies. Read here for more info.

Exports

@enso-ui/wysiwyg/bulma:

  • Wysiwyg,

bulma/Uploader.vue

A bulma styled typeahead component built on top of its renderless counterpart.

Example:

<wysiwyg v-model="myModel"
    :readonly="isReadonly"
    :has-error="hasErrors"
    @input="customHandleInput"/>

Properties:

  • hasError - boolean, optional, default false, if true, applies the 'is-danger' class on the editor
  • placeholder - string, optional, default Write something...
  • readonly - boolean, optional, default false, if true, the editor is readonly
  • value - string|object, required, default '', the editor's value

Questions & Issues

For questions and support please use the issues functionality for this package's github repository.

Please make sure to search for existing issues before creating a new issue, and when opening a new issue, fill the required information in the issue template.

Issues not conforming to the guidelines may be closed immediately.

Depends on

  • @fortawesome/fontawesome-free
  • @fortawesome/fontawesome-svg-core
  • @fortawesome/free-solid-svg-icons
  • @fortawesome/vue-fontawesome
  • tiptap
  • tiptap-commands
  • tiptap-extensions
  • vue

Contributions

are welcome. Pull requests are great, but issues are good too.

Thank you to all the people who already contributed to Enso!

License

ISC