Giter Club home page Giter Club logo

directus-extension-tiptap's Introduction

Tiptap for Directus

npm version npm downloads License

This is a Directus extension that provides the Tiptap editor as a rich text field type.

The StarterKit tiptap bundle is already included and the other tiptap extensions are available in the directus interface options.

Requirements

This extension requires Directus 9 or higher to be installed.

Installation

Add @bicou/directus-extension-tiptap dependency to your directus project.

# Using pnpm
pnpm add @bicou/directus-extension-tiptap
# Using yarn
yarn add @bicou/directus-extension-tiptap
# Using npm
npm install @bicou/directus-extension-tiptap

Usage

Field

When creating a field in Directus choose TipTap.

field creation

Choosing Type allows you to store your content as a JSON object or as a good old HTML string

  • JSON : the JSON object of the ProseMirror nodes
  • Text : the HTML content as string

Editor

When editing content items, the Tiptap WYSIWG editor will show up :

editor

Field data and display

By default, the data is shown as raw JSON :

json render

Edit the field to select Tiptap as display ...

display

... to render the text of the field in content browsing :

text render

License

This extension is released under the MIT license. See the LICENSE file for more details.

directus-extension-tiptap's People

Contributors

gbicou avatar semantic-release-bot avatar renovate[bot] avatar github-actions[bot] avatar hermitpopcorn avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.