Renamed components
Comark's framework components were renamed so that names describe what they render rather than the library they come from: you render Markdown, with Comark. The Comark brand is unchanged everywhere else — package names (comark, @comark/vue, ...), parser APIs (parse, renderMarkdown, autoCloseMarkdown, ...), and AST types (ComarkTree, ComarkNode, ...) all keep their names.
Component names
| Old name | New name | Package |
|---|---|---|
Comark | Markdown | @comark/vue, @comark/react, @comark/svelte, @comark/nuxt (auto-import) |
ComarkRenderer | MarkdownParsed | @comark/vue, @comark/react, @comark/svelte, @comark/nuxt (auto-import) |
ComarkClient | MarkdownClient | @comark/react |
ComarkLive | MarkdownLive | @comark/react |
ComarkAsync | MarkdownAsync | @comark/svelte/async |
ComarkNode (component) | MarkdownNode | @comark/svelte, @comark/angular |
ComarkComponent | Markdown | @comark/angular |
ComarkRendererComponent | MarkdownParsed | @comark/angular |
defineComarkComponent | defineMarkdownComponent | @comark/vue, @comark/react, @comark/angular, @comark/nuxt |
defineComarkRendererComponent | defineMarkdownParsedComponent | @comark/vue, @comark/react, @comark/angular, @comark/nuxt |
The Angular selectors changed accordingly: <comark> → <comark-markdown>, <comark-renderer> → <comark-markdown-parsed>, and <comark-node> → <comark-markdown-node>.
Prop names
| Old prop | New prop | Component |
|---|---|---|
markdown | value | Markdown (and variants) |
tree | value | MarkdownParsed |
All other props are unchanged (components, plugins, options, streaming, caret, unwrap, data, comarkKey, ...).
Backward compatibility
The old component names and props still work as deprecated aliases. Using one logs a one-time warning in the browser console during development to help you migrate. The aliases will be removed in a future major version, so update your imports and templates when convenient.