Interface CmdBinderBuilder<C>

The binding builder API that already knows the type of UI command the bindings will produce

interface CmdBinderBuilder {
    catch(fn): CmdBinderBuilder<C>;
    configureRules(ruleName, severity): CmdBinderBuilder<C>;
    end(fn): CmdBinderBuilder<C>;
    first(fn): CmdBinderBuilder<C>;
    log(...level): CmdBinderBuilder<C>;
    name(name): CmdBinderBuilder<C>;
    on<W>(widget, ...widgets): CmdBinderBuilder<C>;
    onDynamic(node): CmdBinderBuilder<C>;
    preventDefault(): CmdBinderBuilder<C>;
    stopImmediatePropagation(): CmdBinderBuilder<C>;
    when(fn, mode?): CmdBinderBuilder<C>;
}

Type Parameters

C extends Command
The type of the produced UI Commands

Hierarchy

BaseBinderBuilder
- CmdBinderBuilder

Index

Methods

catch configureRules end first log name on onDynamic preventDefault stopImmediatePropagation when

Methods

catch

catch(fn): CmdBinderBuilder<C>
Allows the processing of errors during the execution of the binding. Errors reported here are errors thrown in arrow functions provided to the the different routines of the binder and errors triggered by the command. A binder can have several cummulative 'catch' routines.
Parameters
- fn: ((ex) => void)
  The function to process the error caught by the binding during its execution
  - - (ex): void
    - Parameters
      ex: unknown
      Returns void
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.catch
- Defined in api/binder/CmdBinderBuilder.ts:50

configureRules

configureRules(ruleName, severity): CmdBinderBuilder<C>
Configures a linter rule specifically for the binding.
Parameters
- ruleName: RuleName
  The name of the rule.
- severity: Severity
  The severity level of the rule.
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.configureRules
- Defined in api/binder/CmdBinderBuilder.ts:54

end

end(fn): CmdBinderBuilder<C>
Defines actions to perform when a binding ends. A binder can have several cummulative 'end' routines.
Parameters
- fn: ((c) => void)
  The command to execute on each binding end.
  - - (c): void
    - Parameters
      c: C
      Returns void
Returns CmdBinderBuilder<C>
A clone of the current builder to chain the building configuration.
Overrides BaseBinderBuilder.end
- Defined in api/binder/CmdBinderBuilder.ts:36

first

first(fn): CmdBinderBuilder<C>
Specifies the initialisation of the command when the interaction starts. Each time the interaction starts, an instance of the command is created and configured by the given callback. A binder can have several cummulative 'first' routines.
Parameters
- fn: ((c) => void)
  The callback method that initialises the command. This callback takes as arguments the command to configure.
  - - (c): void
    - Parameters
      c: C
      Returns void
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
- Defined in api/binder/CmdBinderBuilder.ts:34

log

log(...level): CmdBinderBuilder<C>
Specifies the logging level to use. A binder can have several cummulative 'log' routines, eg: log(LogLevel.INTERACTION).log(LogLevel.COMMAND)
Parameters
- Rest ...level: readonly LogLevel[]
  The logging level to use.
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.log
- Defined in api/binder/CmdBinderBuilder.ts:44

name

name(name): CmdBinderBuilder<C>
Specifies the name of the Interacto binding. This name will be used in the logging system. It should be unique, but no mechanism will check that.
Parameters
- name: string
  The name of the binding
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.name
- Defined in api/binder/CmdBinderBuilder.ts:52

on

on<W>(widget, ...widgets): CmdBinderBuilder<C>
Specifies the widgets on which the binding will operate. When a widget is added to this list, this widget is binded to this binding. When widget is removed from this list, this widget is unbinded from this binding.
Type Parameters
- W
Parameters
- widget: Widget<W> | readonly Widget<W>[]
  The mandatory first widget
- Rest ...widgets: readonly Widget<W>[]
  The list of the widgets involved in the bindings.
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.on
- Defined in api/binder/CmdBinderBuilder.ts:38

onDynamic

onDynamic(node): CmdBinderBuilder<C>
Specifies the node the binding will observe its children. The binding observes its children list, so that additions and removals from it are managed by the binding.
Parameters
- node: Widget<Node>
  The binding will observe the children of this node.
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.onDynamic
- Defined in api/binder/CmdBinderBuilder.ts:40

preventDefault

preventDefault(): CmdBinderBuilder<C>
The default behavior associated to the event will be ignored.

Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.preventDefault
- Defined in api/binder/CmdBinderBuilder.ts:48

stopImmediatePropagation

stopImmediatePropagation(): CmdBinderBuilder<C>
If called, all the events the interaction will process will be consumed and not propagated to next listeners.

Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.stopImmediatePropagation
- Defined in api/binder/CmdBinderBuilder.ts:46

when

when(fn, mode?): CmdBinderBuilder<C>
Specifies the conditions to fulfill to initialise, update, or execute the command while the interaction is running. A binder can have several cummulative 'when' routines.
Parameters
- fn: (() => boolean)
  The predicate that checks whether the command can be initialised, updated, or executed.
  - - (): boolean
    - Returns boolean
- Optional mode: WhenType
  The execution mode of the 'when' predicate. If not defined, the non-strict mode will be used.
Returns CmdBinderBuilder<C>
A clone of the current binder to chain the building configuration.
Overrides BaseBinderBuilder.when
- Defined in api/binder/CmdBinderBuilder.ts:42

Interface CmdBinderBuilder<C>

Type Parameters

C extends Command

Hierarchy

Index

Methods

Methods

catch

Parameters

fn: ((ex) => void)

Parameters

ex: unknown

Returns void

Returns CmdBinderBuilder<C>

configureRules

Parameters

ruleName: RuleName

severity: Severity

Returns CmdBinderBuilder<C>

end

Parameters

fn: ((c) => void)

Parameters

c: C

Returns void

Returns CmdBinderBuilder<C>

first

Parameters

fn: ((c) => void)

Parameters

c: C

Returns void

Returns CmdBinderBuilder<C>

log

Parameters

Rest ...level: readonly LogLevel[]

Returns CmdBinderBuilder<C>

name

Parameters

name: string

Returns CmdBinderBuilder<C>

on

Type Parameters

W

Parameters

widget: Widget<W> | readonly Widget<W>[]

Rest ...widgets: readonly Widget<W>[]

Returns CmdBinderBuilder<C>

onDynamic

Parameters

node: Widget<Node>

Returns CmdBinderBuilder<C>

preventDefault

Returns CmdBinderBuilder<C>

stopImmediatePropagation

Returns CmdBinderBuilder<C>

when

Parameters

fn: (() => boolean)

Returns boolean

Optional mode: WhenType

Returns CmdBinderBuilder<C>

Settings

Member Visibility

Theme

On This Page

`Rest` ...level: readonly LogLevel[]

`Rest` ...widgets: readonly Widget<W>[]

`Optional` mode: WhenType