Skip to content

Vizel API / core/src / VizelFeatureOptions

Interface: VizelFeatureOptions

Defined in: packages/core/src/types.ts:80

Feature configuration for Vizel editor.

Features are grouped into three categories that answer different consumer questions:

  • content — What can the document contain?
  • interaction — How does the user edit?
  • collaboration — Who edits together?

Each field accepts one of:

  • true — enable the feature with default options.
  • false — disable the feature.
  • an options object — enable with custom options.

Always-on core (no opt-in needed): paragraph, heading, list, blockquote, bold/italic/strike/code marks, hard break, horizontal rule, link, code block (with lowlight), markdown import/export, undo/redo. These extensions load regardless of features.

Properties

collaboration?

ts
optional collaboration?: VizelCollaborationFeatureOptions;

Defined in: packages/core/src/types.ts:86

Collaboration features — who edits together.


content?

ts
optional content?: VizelContentFeatureOptions;

Defined in: packages/core/src/types.ts:82

Content features — what the document can contain.


interaction?

ts
optional interaction?: VizelInteractionFeatureOptions;

Defined in: packages/core/src/types.ts:84

Interaction features — how the user edits.

Released under the MIT License.