Interface KeyInteractionCmdBinder<C, I, A, D>

The binder API for key-based user interactions, that already knows the type of the user interaction to use and the type of command the binding will produce.

interface KeyInteractionCmdBinder {
    bind(): Binding<C, I, A, D>;
    catch(fn): KeyInteractionCmdBinder<C, I, A, D>;
    configureRules(ruleName, severity): KeyInteractionCmdBinder<C, I, A, D>;
    end(fn): KeyInteractionCmdBinder<C, I, A, D>;
    first(fn): KeyInteractionCmdBinder<C, I, A, D>;
    ifCannotExecute(fn): KeyInteractionCmdBinder<C, I, A, D>;
    ifHadEffects(fn): KeyInteractionCmdBinder<C, I, A, D>;
    ifHadNoEffect(fn): KeyInteractionCmdBinder<C, I, A, D>;
    log(...level): KeyInteractionCmdBinder<C, I, A, D>;
    name(name): KeyInteractionCmdBinder<C, I, A, D>;
    on<W>(widget, ...widgets): KeyInteractionCmdBinder<C, I, A, D>;
    onDynamic(node): KeyInteractionCmdBinder<C, I, A, D>;
    preventDefault(): KeyInteractionCmdBinder<C, I, A, D>;
    stopImmediatePropagation(): KeyInteractionCmdBinder<C, I, A, D>;
    when(fn, mode?): KeyInteractionCmdBinder<C, I, A, D>;
    with(isCode, ...keysOrCodes): KeyInteractionCmdBinder<C, I, A, D>;
}

Type Parameters

C extends Command
The type of the produced UI commands
I extends Interaction<D>
The type of the user interaction
A
D extends InteractionData = InteractionDataType<I>
The type of the interaction data of the user interaction

Hierarchy

KeyInteractionBinderBuilder<I, A, D>
InteractionCmdBinder<C, I, A, D>
- KeyInteractionCmdBinder

Index

Methods

bind catch configureRules end first ifCannotExecute ifHadEffects ifHadNoEffect log name on onDynamic preventDefault stopImmediatePropagation when with

Methods

bind

bind(): Binding<C, I, A, D>
Executes the binder to create and install an Interacto binding.

Returns Binding<C, I, A, D>
Overrides InteractionCmdBinder.bind
- Defined in api/binder/KeyInteractionCmdBinder.ts:66

catch

catch(fn): KeyInteractionCmdBinder<C, I, A, D>
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 KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.catch
- Defined in api/binder/KeyInteractionCmdBinder.ts:60

configureRules

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

end

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

first

first(fn): KeyInteractionCmdBinder<C, I, A, D>
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, i, acc) => void)
  The callback method that initialises the command. This callback takes as arguments both the command and interaction data involved in the binding.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeyInteractionCmdBinder<C, I, A, D>
The binder to chain the building configuration.
Overrides InteractionCmdBinder.first
- Defined in api/binder/KeyInteractionCmdBinder.ts:36

ifCannotExecute

ifCannotExecute(fn): KeyInteractionCmdBinder<C, I, A, D>
Specifies what to do end when an interaction ends and the command could not be executed. A binder can have several cummulative 'ifCannotExecute' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method to specify what to do when an interaction ends and the command could not be executed.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeyInteractionCmdBinder<C, I, A, D>
The binder to chain the building configuration.
Overrides InteractionCmdBinder.ifCannotExecute
- Defined in api/binder/KeyInteractionCmdBinder.ts:50

ifHadEffects

ifHadEffects(fn): KeyInteractionCmdBinder<C, I, A, D>
Specifies what to do end when an interaction ends (after the end/endOrCancel routines) and the command has produced an effect. A binder can have several cummulative 'ifHadEffects' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method to specify what to do when an interaction ends and the command produced an effect.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeyInteractionCmdBinder<C, I, A, D>
The binder to chain the building configuration.
Overrides InteractionCmdBinder.ifHadEffects
- Defined in api/binder/KeyInteractionCmdBinder.ts:46

ifHadNoEffect

ifHadNoEffect(fn): KeyInteractionCmdBinder<C, I, A, D>
Specifies what to do end when an interaction ends (after the end/endOrCancel routines) and the command did not produce an effect. A binder can have several cummulative 'ifHadNoEffect' routines.
Parameters
- fn: ((c, i, acc) => void)
  The callback method to specify what to do when an interaction ends and the command did not produce an effect.
  - - (c, i, acc): void
    - Parameters
      c: C
      i: D
      acc: A
      Returns void
Returns KeyInteractionCmdBinder<C, I, A, D>
The binder to chain the building configuration.
Overrides InteractionCmdBinder.ifHadNoEffect
- Defined in api/binder/KeyInteractionCmdBinder.ts:48

log

log(...level): KeyInteractionCmdBinder<C, I, A, D>
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 KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.log
- Defined in api/binder/KeyInteractionCmdBinder.ts:42

name

name(name): KeyInteractionCmdBinder<C, I, A, D>
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 KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.name
- Defined in api/binder/KeyInteractionCmdBinder.ts:62

on

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

onDynamic

onDynamic(node): KeyInteractionCmdBinder<C, I, A, D>
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 KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.onDynamic
- Defined in api/binder/KeyInteractionCmdBinder.ts:40

preventDefault

preventDefault(): KeyInteractionCmdBinder<C, I, A, D>
The default behavior associated to the event will be ignored.

Returns KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.preventDefault
- Defined in api/binder/KeyInteractionCmdBinder.ts:58

stopImmediatePropagation

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

Returns KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.stopImmediatePropagation
- Defined in api/binder/KeyInteractionCmdBinder.ts:56

when

when(fn, mode?): KeyInteractionCmdBinder<C, I, A, D>
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: ((i, acc) => boolean)
  The predicate that checks whether the command can be initialised, updated, or executed. This predicate takes as arguments the data of the ongoing user interaction involved in the binding.
  - - (i, acc): boolean
    - Parameters
      i: D
      acc: Readonly<A>
      Returns boolean
- Optional mode: WhenType
Returns KeyInteractionCmdBinder<C, I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionCmdBinder.when
- Defined in api/binder/KeyInteractionCmdBinder.ts:44

with

with(isCode, ...keysOrCodes): KeyInteractionCmdBinder<C, I, A, D>
Defines the key values the binding will check. On a key interaction, the pressed keys will be checked against the given key values. The set of pressed keys must match the given key values.
Parameters
- isCode: boolean
  If true, key codes will be used instead of key values. Keep in mind that key codes ignore the user's keyboard layout. See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code.
- Rest ...keysOrCodes: readonly string[]
  The key values to match, or key codes if isCode is set to true.
Returns KeyInteractionCmdBinder<C, I, A, D>
A clone of the current builder to chain the building configuration.
Overrides KeyInteractionBinderBuilder.with
- Defined in api/binder/KeyInteractionCmdBinder.ts:54

Interface KeyInteractionCmdBinder<C, I, A, D>

Type Parameters

C extends Command

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Hierarchy

Index

Methods

Methods

bind

Returns Binding<C, I, A, D>

catch

Parameters

fn: ((ex) => void)

Parameters

ex: unknown

Returns void

Returns KeyInteractionCmdBinder<C, I, A, D>

configureRules

Parameters

ruleName: RuleName

severity: Severity

Returns KeyInteractionCmdBinder<C, I, A, D>

end

Parameters

fn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Returns KeyInteractionCmdBinder<C, I, A, D>

first

Parameters

fn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Returns KeyInteractionCmdBinder<C, I, A, D>

ifCannotExecute

Parameters

fn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Returns KeyInteractionCmdBinder<C, I, A, D>

ifHadEffects

Parameters

fn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Returns KeyInteractionCmdBinder<C, I, A, D>

ifHadNoEffect

Parameters

fn: ((c, i, acc) => void)

Parameters

c: C

i: D

acc: A

Returns void

Returns KeyInteractionCmdBinder<C, I, A, D>

log

Parameters

Rest ...level: readonly LogLevel[]

Returns KeyInteractionCmdBinder<C, I, A, D>

name

Parameters

name: string

Returns KeyInteractionCmdBinder<C, I, A, D>

on

Type Parameters

W

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

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

`Optional` mode: WhenType

`Rest` ...keysOrCodes: readonly string[]