Giter Club home page Giter Club logo

editorjs-svelte-plugin-builder's Introduction

Что это и зачем?

Хочется писать плагины на чем то реактивном и Svelte подходит отлично, так как компилируется в обычный js код. Но плагин собранный на svelte имеет ряд багов, которые не удалось устранить. Например если внутри input нажать backspace, реактивность пропадает. Это можно пофиксить добавив on:keydown|stopPropagation на input, но все равно есть еще ряд мелких проблем.

Как это работает

Чтобы обойти выше описанные эффекты - svelte часть была собрана как web components. Видимо из-за shadow dom компонент изолируется и все неприятные эффекты исчезают.

Однако не нашел решения, чтобы один web component работал и как view самого плагина и как tune плагина. Поэтому для view сделан отдельный компонент Body.svelte, для tune (если он нужен) отдельный Tune.svelte. Состояние между нимим синхронизируется через отдельный store, который инициализируется в конструкторе класса плагина и передается в каждый веб компонент после его создания.

Имя плагина задается в package.json в поле pluginName (например "todo").

Далее в методе render и renderSettings создаются веб компоненты <editorjs-todo-block> и <editorjs-todo-tune> (где "todo" это имя плагина заданное выше).

Плагин собирается в 2 прохода. Вначале сборка веб компонентов, потом сборка непосредственно плагина.

В dev режиме плагин подключен к редактору с именем test, поэтому имеет тип test при просмотре результатов. В свои проекты вы сами решаете с каким именем он будет подключаться.

Команды

  • npm run build - Собрать плагин
  • npm run dev - Режим разработки (Запускатеся веб-сервер с editorjs и watch)

Структура проекта

...

editorjs-svelte-plugin-builder's People

Contributors

yurasovm avatar

Stargazers

 avatar  avatar

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.