Skip to content

Vizel API / vue/src / createVizelMentionMenuRenderer

Function: createVizelMentionMenuRenderer() ​

ts
function createVizelMentionMenuRenderer(options?): Partial<SuggestionOptions<VizelMentionItem>>;

Defined in: packages/vue/src/composables/createVizelMentionMenuRenderer.ts:37

Creates a suggestion render configuration for the Mention extension. This handles the popup positioning and Vue component lifecycle.

Parameters ​

ParameterType
optionsVizelSuggestionRendererOptions

Returns ​

Partial&lt;SuggestionOptions&lt;VizelMentionItem&gt;&gt;

Example ​

ts
import { createVizelMentionMenuRenderer } from '@vizel/vue';

const editor = useVizelEditor({
  features: {
    interaction: {
      mention: {
        items: async (query) => fetchUsers(query),
        suggestion: createVizelMentionMenuRenderer(),
      },
    },
  },
});

Released under the MIT License.