@barocss/extensions

Version in this checkout: 1.0.3. npm · Source

Reusable editing commands and keybindings for text, blocks, marks, tables, and document features.

Purpose

Compose extension bundles with a schema and renderers that support the same vocabulary.

Install

npm install @barocss/extensions @barocss/editor-core @barocss/schema

The published package provides ES modules and TypeScript declarations. Use a bundler that supports package exports.

Public entry points

Import	Role
@barocss/extensions	Public JavaScript and TypeScript API

Import only these public paths. Source paths such as @barocss/extensions/src/... are not part of the published API.

Usage

import { Editor } from '@barocss/editor-core';
import { createSchema, getMinimalSchemaDefinition } from '@barocss/schema';
import { createCoreExtensions, BoldExtension, ItalicExtension } from '@barocss/extensions';

const editor = new Editor({
  schema: createSchema('prose', getMinimalSchemaDefinition()),
  extensions: [...createCoreExtensions(), BoldExtension, ItalicExtension],
});
// Supply renderers and a view before accepting user input.
editor.destroy();

Integration notes

Adding an extension does not automatically add its schema nodes, renderers, toolbar buttons, or persistence. Product factories deliberately select supported extensions; avoid enabling every extension without checking those boundaries.

Documentation

• Package guide
• Choose a package
• Source and tests
• Detailed architecture reference (older deep reference; use the package guide for current entry points).

License

MIT. The published archive includes the license in dist/LICENSE.