registerEditorItem
Registers a custom Vue component under a string name so the editor's items array can reference it via comp. With { readonly: true }, registers the component that renders that comp type when the editor is read-only. Call once at module scope.
The kanban editor pre-registers richselect, multicombo, datepicker, and slider. @svar-ui/vue-editor exports Attachments, CodeMirror, and TinyMCE field components that aren't pre-registered and are typical candidates for registration.
Usage
import { registerEditorItem } from "@svar-ui/vue-kanban";
import type { Component } from "vue";
registerEditorItem(
type: string,
handler: Component<any>,
config?: { readonly?: boolean } | null
): void;
| Parameter | Type | Description |
|---|---|---|
type | string | Identifier used as comp in editor item descriptors |
handler | Component<any> | Vue component receiving value, onchange, and promoted config fields |
config | { readonly?: boolean } | null | Optional. { readonly: true } registers handler as the read-only renderer for type |
When the editor is read-only, each item renders with the read-only handler registered for its comp. Without one, the editor falls back to its built-in read-only renderer.
The component must call onchange({ value }) on change. Fields in the item's config object are promoted to top-level props.
Example
Registering a custom comments component:
<script setup>
import { Kanban, Editor, registerEditorItem } from "@svar-ui/vue-kanban";
import Comments from "./Comments.vue";
import { ref } from "vue";
registerEditorItem("comments", Comments);
const items = [
{ comp: "text", key: "label", label: "Label" },
{ comp: "textarea", key: "description", label: "Description" },
{ comp: "comments", key: "comments", label: "Comments" },
];
const api = ref(null);
</script>
<template>
<Kanban ref="api" :cards="cards" :columns="columns" />
<Editor :api="api" :items="items" />
</template>
Registering a bundled component from @svar-ui/vue-editor:
<script setup>
import { registerEditorItem } from "@svar-ui/vue-kanban";
import { Attachments } from "@svar-ui/vue-editor";
registerEditorItem("files", Attachments);
const items = [
{ comp: "text", key: "label", label: "Label" },
{ comp: "files", key: "attachments", label: "Attachments", uploadURL: "/api/files" },
];
</script>
Registering a read-only renderer for a custom type:
<script setup>
import { registerEditorItem } from "@svar-ui/vue-kanban";
import Comments from "./Comments.vue";
import CommentsView from "./CommentsView.vue";
registerEditorItem("comments", Comments);
registerEditorItem("comments", CommentsView, { readonly: true });
</script>
Registering multiple components:
<script setup>
import { registerEditorItem } from "@svar-ui/vue-kanban";
import Comments from "./Comments.vue";
import Tasklist from "./Tasklist.vue";
registerEditorItem("comments", Comments);
registerEditorItem("tasks", Tasklist);
const items = [
{ comp: "text", key: "label", label: "Label" },
{ comp: "comments", key: "comments", label: "Comments" },
{ comp: "tasks", key: "tasks", label: "Checklist" },
];
</script>
Related
- Editing guide - comments, checklists, and custom field components
- Editor - the component that renders registered items
- getEditorItems - default editor field set