editor

import "drab/editor/define";

<drab-editor trigger="button">
	<textarea
		data-content
		class="mb-2 h-36"
		placeholder="Write something"
	></textarea>
	<div class="flex gap-2">
		<button
			data-value="# "
			data-type="block"
			class="icon secondary text-base"
			aria-label="heading"
		>
			H
		</button>
		<button
			data-value="**"
			data-type="wrap"
			class="icon secondary text-base font-bold"
			aria-label="bold"
		>
			B
		</button>
		<button
			data-value="_"
			data-type="wrap"
			class="icon secondary text-base italic"
			aria-label="italic"
		>
			I
		</button>
		<button
			data-value="&#8226; "
			data-type="block"
			class="icon secondary"
			aria-label="bullet"
		>
			<span class="icon-[lucide--list]"></span>
		</button>
		<button
			data-value="[text](href)"
			data-type="inline"
			data-key="["
			class="icon secondary"
			aria-label="link"
		>
			<span class="icon-[lucide--link]"></span>
		</button>
	</div>
</drab-editor>

Overview

Defined in: editor/index.ts:69

Enhances the textarea element with controls to add content and keyboard shortcuts. Compared to other WYSIWYG editors, the text value is just a string, so you can easily store it in a database or manipulate it without learning a separate API.

• Automatically adds closing characters for keyPairs. For example, when typing (, ) will be inserted and typed over when reached. All content with data-type="wrap" is also added to keyPairs.
• Highlights the first word of the text inserted if it contains letters.
• Automatically increments/decrements ordered lists.
• Adds the starting character to the next line for block content.
• On double click, highlight is corrected to only highlight the current word without space around it.
• tab key will indent or dedent (+shift) instead of focus change if the selection is within a code block (three backticks).
• When text is highlighted and a wrap character keyPair is typed, the highlighted text will be wrapped with the character instead of removing it. For example, if a word is highlighted and the " character is typed, the work will be surrounded by "s.

Trigger attributes

data-value

Set the value of the text to be inserted using the data-value attribute on the trigger.

data-type

Set the data-type attribute of the trigger to specify how the content should be inserted into the textarea.

• block will be inserted at the beginning of the selected line.
• wrap will be inserted before and after the current selection.
• inline will be inserted at the current selection.

data-key

Add a ctrl/meta keyboard shortcut for the content based on the data-key attribute.

Constructors

Constructor

new Editor(): Editor

Defined in: editor/index.ts:88

Returns

Editor

Overrides

Lifecycle(Trigger(Content())).constructor

Properties

controller

controller: AbortController

Defined in: base/index.ts:20

To clean up event listeners added to document when the element is removed.

Inherited from

Lifecycle(Trigger(Content())).controller

Accessors

event

Get Signature

get event(): keyof HTMLElementEventMap

Defined in: base/index.ts:120

Event for the trigger to execute.

For example, set to "mouseover" to execute the event when the user hovers the mouse over the trigger, instead of when they click it.

Default

"click";

Returns

keyof HTMLElementEventMap

Set Signature

set event(value): void

Defined in: base/index.ts:126

Parameters

value

keyof HTMLElementEventMap

Returns

void

Inherited from

Lifecycle(Trigger(Content())).event

Methods

connectedCallback()

connectedCallback(): void

Defined in: base/index.ts:76

Called when custom element is added to the page.

Returns

void

Inherited from

Lifecycle(Trigger(Content())).connectedCallback

content()

Call Signature

content<T>(instance): T

Defined in: base/index.ts:215

Type Parameters

T

T extends HTMLElement

Parameters

instance

Constructor<T>

The instance of the desired element to validate against, ex: HTMLDialogElement. Defaults to HTMLElement.

Returns

T

The element that matches the content selector.

Default

this.querySelector("[data-content]");

Inherited from

Lifecycle(Trigger(Content())).content

Call Signature

content(): HTMLElement

Defined in: base/index.ts:216

Returns

HTMLElement

The element that matches the content selector.

Default

this.querySelector("[data-content]");

Inherited from

Lifecycle(Trigger(Content())).content

destroy()

destroy(): void

Defined in: base/index.ts:83

Passed into disconnectedCallback, since Base needs to run disconnectedCallback as well. It is overridden in each element that needs to run disconnectedCallback.

Returns

void

Inherited from

Lifecycle(Trigger(Content())).destroy

disconnectedCallback()

disconnectedCallback(): void

Defined in: base/index.ts:86

Called when custom element is removed from the page.

Returns

void

Inherited from

Lifecycle(Trigger(Content())).disconnectedCallback

listener()

Call Signature

listener<T>(listener, options?): void

Defined in: base/index.ts:152

Type Parameters

T

T extends keyof HTMLElementEventMap

Parameters

listener

Listener<T>

Listener to attach to all of the trigger elements.

options?

AddEventListenerOptions

Returns

void

Inherited from

Lifecycle(Trigger(Content())).listener

Call Signature

listener<T>(type, listener, options?): void

Defined in: base/index.ts:161

Type Parameters

T

T extends keyof HTMLElementEventMap

Parameters

type

T

Event type.

listener

Listener<T>

Listener to attach to all of the trigger elements.

options?

AddEventListenerOptions

Returns

void

Inherited from

Lifecycle(Trigger(Content())).listener

mount()

mount(): void

Defined in: editor/index.ts:303

Passed into queueMicrotask in connectedCallback. It is overridden in each component that needs to run connectedCallback.

The reason for this is to make these elements work better with frameworks like Svelte. For SSR this isn’t necessary, but when client side rendering, the HTML within the custom element isn’t available before connectedCallback is called. By waiting until the next microtask, the HTML content is available—then for example, listeners can be attached to elements inside.

Returns

void

Overrides

Lifecycle(Trigger(Content())).mount

safeListener()

Call Signature

safeListener<T>(type, listener, element?, options?): void

Defined in: base/index.ts:35

Wrapper around addEventListener that ensures when the element is removed from the DOM, these event listeners are cleaned up.

Type Parameters

T

T extends keyof HTMLElementEventMap

Parameters

type

T

Event listener type - ex: "keydown"

listener

(this, event) => any

Listener to add to the target.

element?

HTMLElement

options?

AddEventListenerOptions

Other options sans signal.

Returns

void

Inherited from

Lifecycle(Trigger(Content())).safeListener

Call Signature

safeListener<T>(type, listener, document, options?): void

Defined in: base/index.ts:41

Wrapper around addEventListener that ensures when the element is removed from the DOM, these event listeners are cleaned up.

Type Parameters

T

T extends keyof DocumentEventMap

Parameters

type

T

Event listener type - ex: "keydown"

listener

(this, event) => any

Listener to add to the target.

document

Document

options?

AddEventListenerOptions

Other options sans signal.

Returns

void

Inherited from

Lifecycle(Trigger(Content())).safeListener

Call Signature

safeListener<T>(type, listener, window, options?): void

Defined in: base/index.ts:47

Wrapper around addEventListener that ensures when the element is removed from the DOM, these event listeners are cleaned up.

Type Parameters

T

T extends keyof WindowEventMap

Parameters

type

T

Event listener type - ex: "keydown"

listener

(this, event) => any

Listener to add to the target.

window

Window

options?

AddEventListenerOptions

Other options sans signal.

Returns

void

Inherited from

Lifecycle(Trigger(Content())).safeListener

swap()

swap(revert?): void

Defined in: base/index.ts:231

Finds the HTMLElement | HTMLTemplateElement via the swap selector and swaps this.content() with the content of the element found.

Parameters

revert?

number | false

Wait time (ms) before swapping back, set to false to not revert. default: 800

Returns

void

Inherited from

Lifecycle(Trigger(Content())).swap

triggers()

Call Signature

triggers<T>(instance): NodeListOf<T>

Defined in: base/index.ts:136

Type Parameters

T

T extends HTMLElement

Parameters

instance

Constructor<T>

The instance of the desired element to validate against, ex: HTMLButtonElement. Defaults to HTMLElement.

Returns

NodeListOf<T>

All of the elements that match the trigger selector.

Default

this.querySelectorAll("[data-trigger]");

Inherited from

Lifecycle(Trigger(Content())).triggers

Call Signature

triggers(): NodeListOf<HTMLElement>

Defined in: base/index.ts:137

Returns

NodeListOf<HTMLElement>

All of the elements that match the trigger selector.

Default

this.querySelectorAll("[data-trigger]");

Inherited from

Lifecycle(Trigger(Content())).triggers