API

Core

Carta options

List of options that can be used when creating Carta:

gfmOptions

Type: GfmOptions

GitHub Flavored Markdown options.

extensions

Type: Extension[]

List of extensions(plugins) to use.

rendererDebounce

Type: number

Rendering debouncing timeout, in milliseconds. Defaults to 300ms.

disableShortcuts

Type: DefaultShortcutId[] | true

Remove default shortcuts by id. You can use true to disable all of them.

disableIcons

Type: DefaultIconId[] | true

Remove default icons by id. You can use true to disable all of them.

disablePrefixes

Type: DefaultPrefixId[] | true

Remove default prefixes by id. You can use true to disable all of them.

disableTabOuts

Type: DefaultTabOutId[] | true

Remove default tab-outs by id. You can use true to disable all of them.

historyOptions

History management options.

historyOptions.minInterval

Type: number

Minimum interval between save states in milliseconds. Defaults to 300ms.

historyOptions.maxSize

Type: number

Maximum history size in bytes. Defaults to 1MB.

sanitizer

Type: (html: string) => void

HTML sanitizer. See here for more details.

shikiOptions

Type: ShikiOptions

Highlighter(Shiki) options.

theme

Type: Theme | DualTheme

Shiki theme to use to highlight Markdown.

disableTabCapture

Type: boolean

Disable tab capture. This will prevent the editor from capturing the tab key and using it for indentation.

MarkdownEditor options

List of options that can be used in the <MarkdownEditor> component.

carta

Type: Carta

Carta instance to use for this editor.

theme

Type: string

The theme of this editor. The editor and related elements will have carta-theme_<theme> as a class.

value

Type: string

Current Markdown input value.

mode

Type: 'tabs' | 'split' | 'auto'

Editor windows mode. With auto it will split when the window size is greater than 768px.

scroll

Type: 'sync' | 'async'

Scroll synchronization.

disableToolbar

Type: boolean

Option to disable the toolbar.

placeholder

Type: string

Set the textarea placeholder.

textarea

Type: TextAreaProps (extends Record<string, unknown>)

Additional properties that will be used in the textarea used under the hood in the editor. class, placeholder and value are not allowed. Use the corresponding editor properties instead.

labels

Type: Partial<Labels>

Can be used to provide custom text for labels in the editor.

highlightDelay

Type: number

Highlight delay in milliseconds. Defaults to 250ms.

Markdown options

List of options that can be used in the <Markdown> component.

carta

Type: Carta

Carta instance to use for this editor.

theme

Type: string

The theme to use. The element will have carta-theme_<theme> as a class.

value

Type: string

Current Markdown input value.

selectedTab

Type: 'write' | 'preview'

The selected editor tab.

PreRendered options

List of options that can be used in the <PreRendered> component.

html

Type: string

The HTML to render. It is NOT sanitized.

theme

Type: string

The theme to use. The element will have carta-theme_<theme> as a class.