Interface CmdBinder<C>

The binder API that already knows the type of UI command the bindings will produce.

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

Type Parameters

C extends Command
The type of the produced UI Commands

Hierarchy

CmdBinderBuilder<C>
- CmdBinder

Implemented by

Binder

Index

Methods

catch configureRules end first log name on onDynamic preventDefault stopImmediatePropagation usingInteraction when

Methods

catch

catch(fn): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.catch
- Defined in api/binder/CmdBinder.ts:57

configureRules

configureRules(ruleName, severity): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.configureRules
- Defined in api/binder/CmdBinder.ts:61

end

end(fn): CmdBinder<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 CmdBinder<C>
A clone of the current builder to chain the building configuration.
Overrides CmdBinderBuilder.end
- Defined in api/binder/CmdBinder.ts:33

first

first(fn): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.first
- Defined in api/binder/CmdBinder.ts:31

log

log(...level): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.log
- Defined in api/binder/CmdBinder.ts:41

name

name(name): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.name
- Defined in api/binder/CmdBinder.ts:59

on

on<W>(widget, ...widgets): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.on
- Defined in api/binder/CmdBinder.ts:35

onDynamic

onDynamic(node): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.onDynamic
- Defined in api/binder/CmdBinder.ts:37

preventDefault

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

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

stopImmediatePropagation

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

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

usingInteraction

usingInteraction<I, A, D>(fn): InteractionCmdBinder<C, I, A, D>
Defines how to create the user interaction that the binding will use to create UI commands.
Type Parameters
- I extends Interaction<D>
  The user interaction type
- A
- D extends InteractionData = InteractionDataType<I>
  The user interaction data type
Parameters
- fn: (() => I)
  The supplier that will return a new user interaction.
  - - (): I
    - Returns I
Returns InteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
- Defined in api/binder/CmdBinder.ts:50

when

when(fn, mode?): CmdBinder<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 CmdBinder<C>
A clone of the current binder to chain the building configuration.
Overrides CmdBinderBuilder.when
- Defined in api/binder/CmdBinder.ts:39

Interface CmdBinder<C>

Type Parameters

C extends Command

Hierarchy

Implemented by

Index

Methods

Methods

catch

Parameters

fn: ((ex) => void)

Parameters

ex: unknown

Returns void

Returns CmdBinder<C>

configureRules

Parameters

ruleName: RuleName

severity: Severity

Returns CmdBinder<C>

end

Parameters

fn: ((c) => void)

Parameters

c: C

Returns void

Returns CmdBinder<C>

first

Parameters

fn: ((c) => void)

Parameters

c: C

Returns void

Returns CmdBinder<C>

log

Parameters

Rest ...level: readonly LogLevel[]

Returns CmdBinder<C>

name

Parameters

name: string

Returns CmdBinder<C>

on

Type Parameters

W

Parameters

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

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

Returns CmdBinder<C>

onDynamic

Parameters

node: Widget<Node>

Returns CmdBinder<C>

preventDefault

Returns CmdBinder<C>

stopImmediatePropagation

Returns CmdBinder<C>

usingInteraction

Type Parameters

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Parameters

fn: (() => I)

Returns I

Returns InteractionCmdBinder<C, I, A, D>

when

Parameters

fn: (() => boolean)

Returns boolean

Optional mode: WhenType

Returns CmdBinder<C>

Settings

Member Visibility

Theme

On This Page

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

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

`Optional` mode: WhenType