BlockBuilder Logo/
Документация/Обзор API
Быстрый стартAPIVueReactДемоИстория изменений
GitHub

Начало работы

Быстрый стартИстория изменений

Справочник API

Обзор APIМетодыСвойстваПоля формТемизация и локализацияУтилитыТипы

Vue 3

Быстрый стартКомпонентыСобытияNuxt (SSR)

React

Быстрый стартКомпонентыКолбэкиNext.js (SSR)
Следующая страница
Методы
→

Обзор API

Headless-слой @mushket-co/block-builder/core — открытая доменная логика без готового редактора. Vue/React UI поверх него — опция, не обязательный путь.

Что такое core

BlockBuilder — фасад: CRUD блоков, схема полей, валидация, кастомные рендереры форм, import/export. Без готовой панели редактора — её дают @mushket-co/block-builder/vue и /react, используя те же правила и типы.

Core не «заставляет» отказываться от UI. Это запасной чистый слой: хотите — собираете свой редактор или работаете только с данными; устраивает готовый — берите компонент из Vue/React.

Когда что использовать

Выбор за вами. Ниже — типичные сценарии, не догма.

BlockBuilderComponent (Vue / React)

Готовый редактор «из коробки» — быстрый старт, если вас устраивает его UX и UI.

  • SSR публичных страниц — в Nuxt, Next.js (рендер блоков на сервере + гидратация редактора в админке)
  • Vue / React — документация по компоненту

BlockBuilder (core)

Когда готовый UI не подходит или редактор вообще не нужен — только логика и данные.

  • Свой админ-UI: дизайн-система сайта, жёсткие макеты — встроенный редактор не вписывается
  • Свой редактор на core (формы, списки, порядок блоков — как решите вы)
  • Только данные: скрипты, тесты, API без монтирования UI (Node и браузер)
  • Примеры: examples/api-usage, vue3-core-api

Импорт и конструктор

Полный тип опций — IBlockBuilderOptions. Публичные поля экземпляра — в разделе Свойства.

Минимальный пример

Конфиг типа блока задаёт поля формы; методы создают и обновляют блоки в репозитории (по умолчанию — in-memory).

Схема полей — в Поля форм. Список методов — Методы.

Карта раздела «Справочник API»

  • → Методы — CRUD, состояние блоков, импорт/экспорт, кастомные рендереры
  • → Свойства — опции конструктора (blockConfigs, initialBlocks, …)
  • → Типы — TypeScript-интерфейсы
  • → Поля форм — типы полей, валидация, кастомные рендереры
  • → Утилиты — spacing, scroll lock, валидация форм