Skip to content

Latest commit

 

History

History
117 lines (93 loc) · 3.09 KB

README.md

File metadata and controls

117 lines (93 loc) · 3.09 KB
Raw

🪵 buche

Base d'éditeur d'arbre récursif et arbitraire. Un composant opaque, Buche, crée un éditeur. Le Buche racine doit simplement recevoir :

  • Un noeud racine
  • Une liste de blocs autorisés, dont le bloc générique (voir section "Usage")

Bring your own blocks

Bûche n'inclut pas de blocs (composants d'édition), seulement la mécanique pour construire une expérience d'édition par blocs. C'est à vous d'implémenter vos blocs.

Quelques idées de blocs : Titre, Code, Texte, Image, Vidéo (plusieurs hébergeurs), Embed tiers, Table des matières, Tableau ... La capture d'écran ci-dessous montre un cas d'usage réel.

Objectifs

  • Mécaniques de base (récursion infinie, ajout, supression, réordonnement, copier/coller, téléportation) sur l'arbre.
  • Passage d'une liste de blocs extérieure aux composants.
  • Assez de classes CSS pour styler l'éditeur
  • Skin par défaut basé sur Bulma
  • Traduction de l'interface
  • Gestion de règles avancées
  • Blocs étant eux-mêmes des arbres (2 colonnes, 4 colonnes)
  • Enfants autorisés / interdis, enfants mini, enfants maxi
  • Ajout de classes CSS sur un noeud particulier.

screenshot

Usage

Si vous souhaitez utiliser l'éditeur tel-quel, installez et appelez le CSS de Bulma. Sinon, écrivez une feuille de style basée sur les classes visibles dans BucheNode.vue.

La seule contrainte : le bloc générique doit s'appeler generic et le noeud de départ doit en être une instance. Il doit donc exister dans vos définitions de blocs personnalisés. Pour cela, vous pouvez l'importer.

import {generic_block} from '@documents-org/buche/generic_block';;

App.vue :

<buche :blocks="blocks"
      :node="tree"
      @update:node="tree = $event"></buche>

Où tree est le noeud de départ, comme cela (instance de generic_block.constructor() ):

this.tree = {
    root: true,
    type: 'generic',
    data: {},
    children: [],
    uuid: uuidv4(),
    cssClasses: "",
}

Et blocks une liste des blocs autorisés, comme ceci :

export const blocks = {
    text: {
        type: 'text',
        label: 'Bloc texte',
        constructor: () => ({
            data: {
                content: "",
            },
            root: false,
            type: 'text',
            children: [],
            uuid: uuidv4(),
            cssClasses: "",
        }),
        editor: 'TextEditor', 
        has_children: false,
    },
    generic: {
        type: 'generic',
        label: 'Groupe',
        constructor: () => ({
            data: {},
            root: false,
            type: 'generic',
            children: [],
            uuid: uuidv4(),
            cssClasses: "",
        }),
        children_min: 0,
        has_children: true,
    },
};

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Customize configuration

See Configuration Reference.