Giter Club home page Giter Club logo

directus-extension-editorjs-interface's Introduction

This extension is in development and most probably will have file structure change when Directus 9 official releases. Meanwhile breaking changes are possible in anytime.

Editor.js

Block-styled editor for rich media stories, outputs clean data in JSON. More info at https://editorjs.io/

Installation

Create an editorjs folder into the extensions/interfaces folder of your Directus project and then copy the dist/extensions/interfaces/editorjs/index.js of this repository into it.

You can also clone this repository and build it by yourself.

Usage

To use this custom interface into a data model, you have to:

  • Add a simple field with JSON type
  • In the Interface section on the left choose Editor.js
  • Enjoy ! ๐ŸŽ‰

Options

Option Description Default
placeholder Set text to appear in the canvas ''
tools What tools to include in the editor See below
font Default font family to use in editor sans-serif
bordered Displays border around the editor false

Default tools

  • header
  • list
  • code
  • image
  • paragraph
  • delimeter
  • checklist
  • quote
  • underline

Output

{
    "version": "2.19.0", // block editor version,
    "time": 1607174917790, // timestamp of content change>,
    "blocks": [
        // ...
        {
            "type" : "paragraph",
            "data" : {
                "text" : "Paragraph from editorjs interface in Directus."
            }
        },
        // ...
    ]
}

directus-extension-editorjs-interface's People

Watchers

 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.