Skip to main content

Mark

@blockslides/core

@blockslides/core / Mark

Class: Mark<Options, Storage>

Defined in: blockslides/packages/core/src/Mark.ts:152

Extends​

Type Parameters​

Options​

Options = any

Storage​

Storage = any

Constructors​

Constructor​

new Mark<Options, Storage>(config): Mark<Options, Storage>

Defined in: blockslides/packages/core/src/Extendable.ts:370

Parameters​

config​

Partial<Config> = {}

Returns​

Mark<Options, Storage>

Inherited from​

Extendable.constructor

Properties​

parent​

parent: Extendable<any, any, ExtensionConfig<any, any> | NodeConfig<any, any> | MarkConfig<any, any>> | null = null

Defined in: blockslides/packages/core/src/Extendable.ts:360

Inherited from​

Extendable.parent

child​

child: Extendable<any, any, ExtensionConfig<any, any> | NodeConfig<any, any> | MarkConfig<any, any>> | null = null

Defined in: blockslides/packages/core/src/Extendable.ts:362

Inherited from​

Extendable.child

name​

name: string = ""

Defined in: blockslides/packages/core/src/Extendable.ts:364

Inherited from​

Extendable.name

config​

config: MarkConfig

Defined in: blockslides/packages/core/src/Extendable.ts:366

Inherited from​

Extendable.config

type​

type: string = "mark"

Defined in: blockslides/packages/core/src/Mark.ts:157

Overrides​

Extendable.type

Accessors​

options​

Get Signature​

get options(): Options

Defined in: blockslides/packages/core/src/Extendable.ts:379

Returns​

Options

Inherited from​

Extendable.options

storage​

Get Signature​

get storage(): Readonly<Storage>

Defined in: blockslides/packages/core/src/Extendable.ts:389

Returns​

Readonly<Storage>

Inherited from​

Extendable.storage

Methods​

create()​

static create<O, S>(config): Mark<O, S>

Defined in: blockslides/packages/core/src/Mark.ts:163

Create a new Mark instance

Type Parameters​

O​

O = any

S​

S = any

Parameters​

config​

Mark configuration object or a function that returns a configuration object

Partial<MarkConfig<O, S>> | () => Partial<MarkConfig<O, S>>

Returns​

Mark<O, S>

handleExit()​

static handleExit(__namedParameters): boolean

Defined in: blockslides/packages/core/src/Mark.ts:171

Parameters​

__namedParameters​
editor​

SlideEditor

mark​

Mark

Returns​

boolean

configure()​

configure(options?): Mark<Options, Storage>

Defined in: blockslides/packages/core/src/Mark.ts:199

Parameters​

options?​

Partial<Options>

Returns​

Mark<Options, Storage>

Overrides​

Extendable.configure

extend()​

extend<ExtendedOptions, ExtendedStorage, ExtendedConfig>(extendedConfig?): Mark<ExtendedOptions, ExtendedStorage>

Defined in: blockslides/packages/core/src/Mark.ts:203

Type Parameters​

ExtendedOptions​

ExtendedOptions = Options

ExtendedStorage​

ExtendedStorage = Storage

ExtendedConfig​

ExtendedConfig = MarkConfig<ExtendedOptions, ExtendedStorage>

Parameters​

extendedConfig?​

() => Partial<ExtendedConfig> | Partial<ExtendedConfig> & ThisType<{ name: string; options: ExtendedOptions; storage: ExtendedStorage; editor: SlideEditor; type: MarkType; }>

Returns​

Mark<ExtendedOptions, ExtendedStorage>

Overrides​

Extendable.extend