MarkHandler
Defined in: packages/markput/src/lib/classes/MarkHandler.ts:6
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T extends HTMLElement | HTMLElement |
Properties
Section titled “Properties”readOnly?
Section titled “readOnly?”optional readOnly: boolean;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:10
readonly ref: RefObject<T>;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:7
Accessors
Section titled “Accessors”content
Section titled “content”Get Signature
Section titled “Get Signature”get content(): string;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:21
Displayed text of the mark
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set content(value): void;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:25
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | string |
Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get depth(): number;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:53
Nesting depth (0 for root-level marks)
Returns
Section titled “Returns”number
hasChildren
Section titled “hasChildren”Get Signature
Section titled “Get Signature”get hasChildren(): boolean;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:58
Whether this mark has nested children
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get meta(): string | undefined;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:41
Optional metadata for the mark
Returns
Section titled “Returns”string | undefined
Set Signature
Section titled “Set Signature”set meta(value): void;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:45
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | string | undefined |
Returns
Section titled “Returns”void
parent
Section titled “parent”Get Signature
Section titled “Get Signature”get parent(): MarkToken | undefined;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:63
Parent mark token (undefined for root-level marks)
Returns
Section titled “Returns”MarkToken | undefined
tokens
Section titled “tokens”Get Signature
Section titled “Get Signature”get tokens(): Token[];Defined in: packages/markput/src/lib/classes/MarkHandler.ts:68
Child tokens of this mark
Returns
Section titled “Returns”Token[]
Get Signature
Section titled “Get Signature”get value(): string | undefined;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:31
Data value associated with the mark
Returns
Section titled “Returns”string | undefined
Set Signature
Section titled “Set Signature”set value(value): void;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:35
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | string | undefined |
Returns
Section titled “Returns”void
Methods
Section titled “Methods”change()
Section titled “change()”change(props): void;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:75
Update multiple properties in a single operation
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
props | { content: string; meta?: string; value?: string; } |
props.content | string |
props.meta? | string |
props.value? | string |
Returns
Section titled “Returns”void
remove()
Section titled “remove()”remove(): void;Defined in: packages/markput/src/lib/classes/MarkHandler.ts:85
Delete this mark from the editor
Returns
Section titled “Returns”void