carta/packages/plugin-slash/README.md

Carta Slash Plugin

This plugin adds support for Slash commands. Install it using:

npm i @cartamd/plugin-slash

Setup

Styles

Import the default theme, or create you own:

import '@cartamd/plugin-slash/default-theme.css';

Extension

<script lang="ts">
	import { Carta, CartaEditor } from 'carta-md';
	import { slash } from '@cartamd/plugin-slash';

	const carta = new Carta({
		extensions: [slash()]
	});
</script>

<CartaEditor {carta} />

Options

Here are the options you can pass to slash():

export interface SlashExtensionOptions {
	/**
	 * List of default snippets to disable.
	 */
	disableDefaultSnippets?: DefaultSnippetId[] | true;
	/**
	 * Additional snippets.
	 */
	snippets?: SlashSnippet[];
	/**
	 * Custom in transition. See https://svelte.dev/docs#run-time-svelte-transition.
	 */
	inTransition?: (node: Element) => TransitionConfig;
	/**
	 * Custom out transition. See https://svelte.dev/docs#run-time-svelte-transition.
	 */
	outTransition?: (node: Element) => TransitionConfig;
}