Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

MarkdownChipDefinition

Parser, serializer, and render component for a plugin-owned Markdown chip.

Import

import type { MarkdownChipDefinition } from "@dartwic/interface-sdk/markdown";

Declaration

export interface MarkdownChipDefinition<Token = unknown> {
    id: string;
    prefix?: string;
    start?(source: string): number;
    parse(source: string): MarkdownChipParseResult<Token> | null | undefined;
    serialize(token: Token): string;
    component: (props: MarkdownChipRenderProps<Token>) => HostNode;
}

Members

Name	Type	Requirement
`id`	`string`	Required
`prefix`	`string`	Optional
`start`	`number`	Optional
`parse`	`MarkdownChipParseResult<Token> \| null \| undefined`	Required
`serialize`	`string`	Required
`component`	`(props: MarkdownChipRenderProps<Token>) => HostNode`	Required