typeset

Documentation / editor/typesetting/typeset

Types<T>

Defined in: editor/typesetting/typeset.ts:144

A type store to hold types and make it easy to manage them.

Type Parameters

Type Parameter	Default type
T extends BasicType	BasicType

Constructors

Constructor

new Types<T>(types: T[]): Types<T>;

Defined in: editor/typesetting/typeset.ts:157

Parameters

Parameter	Type
types	T[]

Returns

Types<T>

Properties

list

list: T[];

Defined in: editor/typesetting/typeset.ts:146

priorities

priorities: object;

Defined in: editor/typesetting/typeset.ts:155

Index Signature

[name: string]: number

selector

selector: string;

Defined in: editor/typesetting/typeset.ts:149

types

types: TypeMap<T>;

Defined in: editor/typesetting/typeset.ts:152

Accessors

default

Get Signature

get default(): T;

Defined in: editor/typesetting/typeset.ts:162

Returns

T

Methods

add()

add(type: T): void;

Defined in: editor/typesetting/typeset.ts:184

Parameters

Parameter	Type
type	T

Returns

void

findByAttributes()

Call Signature

findByAttributes(attributes: AttributeMap, fallbackToDefault: true): T;

Defined in: editor/typesetting/typeset.ts:230

Parameters

Parameter	Type
attributes	AttributeMap
fallbackToDefault	true

Returns

T

Call Signature

findByAttributes(attributes: AttributeMap, fallbackToDefault?: boolean): T;

Defined in: editor/typesetting/typeset.ts:231

Parameters

Parameter	Type
attributes	AttributeMap
fallbackToDefault?	boolean

Returns

T

findByNode()

Call Signature

findByNode(node: Node, fallbackToDefault: true): T;

Defined in: editor/typesetting/typeset.ts:217

Parameters

Parameter	Type
node	Node
fallbackToDefault	true

Returns

T

Call Signature

findByNode(node: Node, fallbackToDefault?: boolean): T;

Defined in: editor/typesetting/typeset.ts:218

Parameters

Parameter	Type
node	Node
fallbackToDefault?	boolean

Returns

T

get()

get(name: string): T;

Defined in: editor/typesetting/typeset.ts:195

Parameters

Parameter	Type
name	string

Returns

T

init()

init(): void;

Defined in: editor/typesetting/typeset.ts:166

Returns

void

matches()

matches(node: Node): boolean;

Defined in: editor/typesetting/typeset.ts:208

Parameters

Parameter	Type
node	Node

Returns

boolean

priority()

priority(name: string): number;

Defined in: editor/typesetting/typeset.ts:199

Parameters

Parameter	Type
name	string

Returns

number

remove()

remove(type: string | T): void;

Defined in: editor/typesetting/typeset.ts:189

Parameters

Parameter	Type
type	string | T

Returns

void

---

Typeset

Defined in: editor/typesetting/typeset.ts:11

Constructors

Constructor

new Typeset(types: TypesetTypes): Typeset;

Defined in: editor/typesetting/typeset.ts:20

Parameters

Parameter	Type
types	TypesetTypes

Returns

Typeset

Properties

embeds

embeds: Types<EmbedType>;

Defined in: editor/typesetting/typeset.ts:14

formats

formats: Types<FormatType>;

Defined in: editor/typesetting/typeset.ts:13

lines

lines: Types<LineType>;

Defined in: editor/typesetting/typeset.ts:12

embed()

static embed: (type: EmbedType) => EmbedType;

Defined in: editor/typesetting/typeset.ts:18

Parameters

Parameter	Type
type	EmbedType

Returns

EmbedType

format()

static format: (type: FormatType) => FormatType;

Defined in: editor/typesetting/typeset.ts:17

Parameters

Parameter	Type
type	FormatType

Returns

FormatType

line()

static line: (type: LineType) => LineType;

Defined in: editor/typesetting/typeset.ts:16

Parameters

Parameter	Type
type	LineType

Returns

LineType

---

BasicType

Defined in: editor/typesetting/typeset.ts:61

Extended by

• FormatType
• EmbedType
• LineType

Properties

Property	Type	Defined in
commands?	(editor: Editor) => Function | Commands	editor/typesetting/typeset.ts:74
fromDom?	false | FromDom	editor/typesetting/typeset.ts:72
name	string	editor/typesetting/typeset.ts:63
render?	Renderer	editor/typesetting/typeset.ts:80
selector	string	editor/typesetting/typeset.ts:66
shortcuts?	string | Shortcuts	editor/typesetting/typeset.ts:77
styleSelector?	string	editor/typesetting/typeset.ts:69

---

Commands

Defined in: editor/typesetting/typeset.ts:56

Indexable

[name: string]: (...args: any[]) => any

---

EmbedType

Defined in: editor/typesetting/typeset.ts:87

Extends

• BasicType

Properties

Property	Type	Inherited from	Defined in
commands?	(editor: Editor) => Function | Commands	BasicType.commands	editor/typesetting/typeset.ts:74
fromDom?	false | FromDom	BasicType.fromDom	editor/typesetting/typeset.ts:72
name	string	BasicType.name	editor/typesetting/typeset.ts:63
noFill?	boolean	‐	editor/typesetting/typeset.ts:89
render?	Renderer	BasicType.render	editor/typesetting/typeset.ts:80
selector	string	BasicType.selector	editor/typesetting/typeset.ts:66
shortcuts?	string | Shortcuts	BasicType.shortcuts	editor/typesetting/typeset.ts:77
styleSelector?	string	BasicType.styleSelector	editor/typesetting/typeset.ts:69

---

FormatType

Defined in: editor/typesetting/typeset.ts:83

Extends

• BasicType

Properties

Property	Type	Inherited from	Defined in
commands?	(editor: Editor) => Function | Commands	BasicType.commands	editor/typesetting/typeset.ts:74
fromDom?	false | FromDom	BasicType.fromDom	editor/typesetting/typeset.ts:72
greedy?	boolean	‐	editor/typesetting/typeset.ts:84
name	string	BasicType.name	editor/typesetting/typeset.ts:63
render?	Renderer	BasicType.render	editor/typesetting/typeset.ts:80
selector	string	BasicType.selector	editor/typesetting/typeset.ts:66
shortcuts?	string | Shortcuts	BasicType.shortcuts	editor/typesetting/typeset.ts:77
styleSelector?	string	BasicType.styleSelector	editor/typesetting/typeset.ts:69

---

LineType

Defined in: editor/typesetting/typeset.ts:92

Extends

• BasicType

Properties

Property	Type	Overrides	Inherited from	Defined in
child?	boolean	‐	‐	editor/typesetting/typeset.ts:98
commands?	(editor: Editor) => Function | Commands	‐	BasicType.commands	editor/typesetting/typeset.ts:74
contained?	boolean	‐	‐	editor/typesetting/typeset.ts:107
defaultFollows?	boolean	‐	‐	editor/typesetting/typeset.ts:101
fromDom?	false | FromDom	‐	BasicType.fromDom	editor/typesetting/typeset.ts:72
frozen?	boolean	‐	‐	editor/typesetting/typeset.ts:104
indentable?	boolean	‐	‐	editor/typesetting/typeset.ts:94
name	string	‐	BasicType.name	editor/typesetting/typeset.ts:63
nextLineAttributes?	(attributes: AttributeMap) => AttributeMap	‐	‐	editor/typesetting/typeset.ts:116
onEmptyEnter?	(editor: Editor, line: Line) => boolean	‐	‐	editor/typesetting/typeset.ts:120
onEnter?	(editor: Editor) => void	‐	‐	editor/typesetting/typeset.ts:110
onTab?	(editor: Editor, shiftKey: boolean) => void	‐	‐	editor/typesetting/typeset.ts:113
render?	Renderer	BasicType.render	‐	editor/typesetting/typeset.ts:123
renderMultiple?	MultiLineRenderer	‐	‐	editor/typesetting/typeset.ts:126
selector	string	‐	BasicType.selector	editor/typesetting/typeset.ts:66
shortcuts?	string | Shortcuts	‐	BasicType.shortcuts	editor/typesetting/typeset.ts:77
shouldCombine?	ShouldCombine	‐	‐	editor/typesetting/typeset.ts:128
styleSelector?	string	‐	BasicType.styleSelector	editor/typesetting/typeset.ts:69

---

TypeMap<T>

Defined in: editor/typesetting/typeset.ts:137

Type Parameters

Type Parameter	Default type
T extends BasicType	BasicType

Indexable

[name: string]: T

---

TypesetTypes

Defined in: editor/typesetting/typeset.ts:131

Properties

Property	Type	Defined in
embeds?	(string | EmbedType)[]	editor/typesetting/typeset.ts:134
formats?	(string | FormatType)[]	editor/typesetting/typeset.ts:133
lines?	(string | LineType)[]	editor/typesetting/typeset.ts:132

---

FromDom()

type FromDom = (node: HTMLElement) => any;

Defined in: editor/typesetting/typeset.ts:45

Parameters

Parameter	Type
node	HTMLElement

Returns

any

---

LineData

type LineData = [AttributeMap, VChild[], string];

Defined in: editor/typesetting/typeset.ts:46

---

MultiLineRenderer()

type MultiLineRenderer = (lines: LineData[], editor: Editor, forHTML?: boolean) => VNode;

Defined in: editor/typesetting/typeset.ts:54

Parameters

Parameter	Type
lines	LineData[]
editor	Editor
forHTML?	boolean

Returns

VNode

---

Renderer()

type Renderer = (attributes: AttributeMap, children: VChild[], line: Line, editor: Editor, forHTML?: boolean) => VNode;

Defined in: editor/typesetting/typeset.ts:47

Parameters

Parameter	Type
attributes	AttributeMap
children	VChild[]
line	Line
editor	Editor
forHTML?	boolean

Returns

VNode

---

ShouldCombine()

type ShouldCombine = (prev: AttributeMap, next: AttributeMap) => boolean;

Defined in: editor/typesetting/typeset.ts:55

Parameters

Parameter	Type
prev	AttributeMap
next	AttributeMap

Returns

boolean

---

embed()

function embed(type: EmbedType): EmbedType;

Defined in: editor/typesetting/typeset.ts:41

Parameters

Parameter	Type
type	EmbedType

Returns

EmbedType

---

format()

function format(type: FormatType): FormatType;

Defined in: editor/typesetting/typeset.ts:37

Parameters

Parameter	Type
type	FormatType

Returns

FormatType

---

line()

function line(type: LineType): LineType;

Defined in: editor/typesetting/typeset.ts:32

Parameters

Parameter	Type
type	LineType

Returns

LineType