Skip to content

Vizel API / core/src / VizelExtensionsOptions

Interface: VizelExtensionsOptions

Defined in: packages/core/src/extensions/base.ts:63

Properties

encoding?

ts
optional encoding?: VizelMarkdownEncodingOptions;

Defined in: packages/core/src/extensions/base.ts:84

Per-node encoding mode for nodes that have no canonical Markdown representation (embed, mention, wikiLink). See VizelMarkdownEncodingOptions.


features?

ts
optional features?: VizelFeatureOptions;

Defined in: packages/core/src/extensions/base.ts:72

Feature configuration. All features are enabled by default. Set to false to disable a feature, or pass options to configure it.


flavor?

ts
optional flavor?: VizelMarkdownFlavor;

Defined in: packages/core/src/extensions/base.ts:78

Markdown output flavor. Controls how extensions serialize their content to Markdown.

Default

ts
"gfm"

headingLevels?

ts
optional headingLevels?: (1 | 2 | 3 | 4 | 5 | 6)[];

Defined in: packages/core/src/extensions/base.ts:67

Configure heading levels (default: [1, 2, 3])


locale?

ts
optional locale?: VizelLocale;

Defined in: packages/core/src/extensions/base.ts:89

Locale for editor UI strings. If not provided, default English strings are used.


onError?

ts
optional onError?: (err) => void;

Defined in: packages/core/src/extensions/base.ts:95

Editor-level error sink threaded into the drop / paste image-upload plugin so an upload rejection emits a VizelError (UPLOAD_FAILED) to observability sinks, not only the feature-level onUploadError.

Parameters

ParameterType
errVizelError

Returns

void


placeholder?

ts
optional placeholder?: string;

Defined in: packages/core/src/extensions/base.ts:65

Placeholder text when editor is empty

Released under the MIT License.