typeset

ai-research-agent / editor/typesetting/typeset

Functions

embed()

function embed(type): EmbedType

Parameters

Parameter	Type
type	EmbedType

Returns

EmbedType

---

format()

function format(type): FormatType

Parameters

Parameter	Type
type	FormatType

Returns

FormatType

---

line()

function line(type): LineType

Parameters

Parameter	Type
type	LineType

Returns

LineType

Classes

Types<T>

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

Type Parameters

Type Parameter	Default type
T extends BasicType	BasicType

Accessors

default

Get Signature

get default(): T

Returns

T

Constructors

new Types()

new Types<T>(types): Types<T>

Parameters

Parameter	Type
types	T[]

Returns

Types<T>

Methods

add()

add(type): void

Parameters

Parameter	Type
type	T

Returns

void

findByAttributes()

Call Signature

findByAttributes(attributes, fallbackToDefault): T

Parameters

Parameter	Type
attributes	undefined | default
fallbackToDefault	true

Returns

T

Call Signature

findByAttributes(attributes, fallbackToDefault?): undefined | T

Parameters

Parameter	Type
attributes	undefined | default
fallbackToDefault?	boolean

Returns

undefined | T

findByNode()

Call Signature

findByNode(node, fallbackToDefault): T

Parameters

Parameter	Type
node	Node
fallbackToDefault	true

Returns

T

Call Signature

findByNode(node, fallbackToDefault?): undefined | T

Parameters

Parameter	Type
node	Node
fallbackToDefault?	boolean

Returns

undefined | T

get()

get(name): T

Parameters

Parameter	Type
name	string

Returns

T

init()

init(): void

Returns

void

matches()

matches(node): undefined | boolean

Parameters

Parameter	Type
node	null | Node

Returns

undefined | boolean

priority()

priority(name): number

Parameters

Parameter	Type
name	string

Returns

number

remove()

remove(type): void

Parameters

Parameter	Type
type	string | T

Returns

void

Properties

list

list: T[];

priorities

priorities: object;

Index Signature

[name: string]: number

selector

selector: string;

types

types: TypeMap<T>;

---

Typeset

Constructors

new Typeset()

new Typeset(types): Typeset

Parameters

Parameter	Type
types	TypesetTypes

Returns

Typeset

Properties

embeds

embeds: Types<EmbedType>;

formats

formats: Types<FormatType>;

lines

lines: Types<LineType>;

embed()

static embed: (type) => EmbedType;

Parameters

Parameter	Type
type	EmbedType

Returns

EmbedType

format()

static format: (type) => FormatType;

Parameters

Parameter	Type
type	FormatType

Returns

FormatType

line()

static line: (type) => LineType;

Parameters

Parameter	Type
type	LineType

Returns

LineType

Interfaces

BasicType

Extended by

• FormatType
• EmbedType
• LineType

Properties

commands()?

optional commands: (editor) => Function | Commands;

Parameters

Parameter	Type
editor	Editor

Returns

Function | Commands

fromDom?

optional fromDom: false | FromDom;

name

name: string;

render?

optional render: Renderer;

selector

selector: string;

shortcuts?

optional shortcuts: string | Shortcuts;

styleSelector?

optional styleSelector: string;

---

Commands

Indexable

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

---

EmbedType

Extends

• BasicType

Properties

commands()?

optional commands: (editor) => Function | Commands;

Parameters

Parameter	Type
editor	Editor

Returns

Function | Commands

Inherited from

BasicType.commands

fromDom?

optional fromDom: false | FromDom;

Inherited from

BasicType.fromDom

name

name: string;

Inherited from

BasicType.name

noFill?

optional noFill: boolean;

render?

optional render: Renderer;

Inherited from

BasicType.render

selector

selector: string;

Inherited from

BasicType.selector

shortcuts?

optional shortcuts: string | Shortcuts;

Inherited from

BasicType.shortcuts

styleSelector?

optional styleSelector: string;

Inherited from

BasicType.styleSelector

---

FormatType

Extends

• BasicType

Properties

commands()?

optional commands: (editor) => Function | Commands;

Parameters

Parameter	Type
editor	Editor

Returns

Function | Commands

Inherited from

BasicType.commands

fromDom?

optional fromDom: false | FromDom;

Inherited from

BasicType.fromDom

greedy?

optional greedy: boolean;

name

name: string;

Inherited from

BasicType.name

render?

optional render: Renderer;

Inherited from

BasicType.render

selector

selector: string;

Inherited from

BasicType.selector

shortcuts?

optional shortcuts: string | Shortcuts;

Inherited from

BasicType.shortcuts

styleSelector?

optional styleSelector: string;

Inherited from

BasicType.styleSelector

---

LineType

Extends

• BasicType

Properties

child?

optional child: boolean;

commands()?

optional commands: (editor) => Function | Commands;

Parameters

Parameter	Type
editor	Editor

Returns

Function | Commands

Inherited from

BasicType.commands

contained?

optional contained: boolean;

defaultFollows?

optional defaultFollows: boolean;

fromDom?

optional fromDom: false | FromDom;

Inherited from

BasicType.fromDom

frozen?

optional frozen: boolean;

indentable?

optional indentable: boolean;

name

name: string;

Inherited from

BasicType.name

nextLineAttributes()?

optional nextLineAttributes: (attributes) => default;

Parameters

Parameter	Type
attributes	default

Returns

default

onEmptyEnter()?

optional onEmptyEnter: (editor, line) => boolean;

Parameters

Parameter	Type
editor	Editor
line	default

Returns

boolean

onEnter()?

optional onEnter: (editor) => void;

Parameters

Parameter	Type
editor	Editor

Returns

void

onTab()?

optional onTab: (editor, shiftKey) => void;

Parameters

Parameter	Type
editor	Editor
shiftKey	boolean

Returns

void

render?

optional render: Renderer;

Overrides

BasicType.render

renderMultiple?

optional renderMultiple: MultiLineRenderer;

selector

selector: string;

Inherited from

BasicType.selector

shortcuts?

optional shortcuts: string | Shortcuts;

Inherited from

BasicType.shortcuts

shouldCombine?

optional shouldCombine: ShouldCombine;

styleSelector?

optional styleSelector: string;

Inherited from

BasicType.styleSelector

---

TypeMap<T>

Type Parameters

Type Parameter	Default type
T extends BasicType	BasicType

Indexable

[name: string]: T

---

TypesetTypes

Properties

embeds?

optional embeds: (string | EmbedType)[];

formats?

optional formats: (string | FormatType)[];

lines?

optional lines: (string | LineType)[];

Type Aliases

FromDom()

type FromDom: (node) => any;

Parameters

Parameter	Type
node	HTMLElement

Returns

any

---

LineData

type LineData: [default, VChild[], string];

---

MultiLineRenderer()

type MultiLineRenderer: (lines, editor, forHTML?) => VNode;

Parameters

Parameter	Type
lines	LineData[]
editor	Editor
forHTML?	boolean

Returns

VNode

---

Renderer()

type Renderer: (attributes, children, line, editor, forHTML?) => VNode;

Parameters

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

Returns

VNode

---

ShouldCombine()

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

Parameters

Parameter	Type
prev	default
next	default

Returns

boolean