Vizel API / core/src / createVizelExtensions

Function: createVizelExtensions()

function createVizelExtensions(options?): Promise<Extensions>;

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

Create the default set of extensions for Vizel editor. All features are enabled by default. Set any feature to false to disable it.

Parameters

Parameter	Type
options	VizelExtensionsOptions

Returns

Promise<Extensions>

Examples

Basic usage (all features enabled)

const extensions = createVizelExtensions();

Disable specific features

const extensions = createVizelExtensions({
  features: {
    content: {
      table: false,
      mathematics: false,
    },
    interaction: {
      slashMenu: false,
    },
  },
});

Using Markdown support (always-on)

const extensions = createVizelExtensions();

// Then use:
editor.commands.setContent('# Hello', { contentType: 'markdown' });
const md = editor.getMarkdown();

Custom image upload

const extensions = createVizelExtensions({
  features: {
    content: {
      image: {
        onUpload: async (file) => {
          const formData = new FormData();
          formData.append('file', file);
          const res = await fetch('/api/upload', { method: 'POST', body: formData });
          return (await res.json()).url;
        },
      },
    },
  },
});