Interface KeyInteractionBinderBuilder<I, A, D>

The binding builder API for key-based user interactions, that already knows the type of user interaction the bindings will use.

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

Type Parameters

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

InteractionBinderBuilder<I, A, D>
KeyBinderBuilder
- KeyInteractionBinderBuilder

Index

Methods

catch configureRules end log name on onDynamic preventDefault stopImmediatePropagation when with

Methods

catch

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

configureRules

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

end

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

log

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

name

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

on

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

onDynamic

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

preventDefault

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

Returns KeyInteractionBinderBuilder<I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionBinderBuilder.preventDefault
- Defined in api/binder/KeyInteractionBinderBuilder.ts:47

stopImmediatePropagation

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

Returns KeyInteractionBinderBuilder<I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionBinderBuilder.stopImmediatePropagation
- Defined in api/binder/KeyInteractionBinderBuilder.ts:45

when

when(fn, mode?): KeyInteractionBinderBuilder<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 KeyInteractionBinderBuilder<I, A, D>
A clone of the current binder to chain the building configuration.
Overrides InteractionBinderBuilder.when
- Defined in api/binder/KeyInteractionBinderBuilder.ts:33

with

with(isCode, ...keysOrCodes): KeyInteractionBinderBuilder<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 KeyInteractionBinderBuilder<I, A, D>
A clone of the current builder to chain the building configuration.
Overrides KeyBinderBuilder.with
- Defined in api/binder/KeyInteractionBinderBuilder.ts:43

Interface KeyInteractionBinderBuilder<I, A, D>

Type Parameters

I extends Interaction<D>

A

D extends InteractionData = InteractionDataType<I>

Hierarchy

Index

Methods

Methods

catch

Parameters

fn: ((ex) => void)

Parameters

ex: unknown

Returns void

Returns KeyInteractionBinderBuilder<I, A, D>

configureRules

Parameters

ruleName: RuleName

severity: Severity

Returns KeyInteractionBinderBuilder<I, A, D>

end

Parameters

fn: (() => void)

Returns void

Returns KeyInteractionBinderBuilder<I, A, D>

log

Parameters

Rest ...level: readonly LogLevel[]

Returns KeyInteractionBinderBuilder<I, A, D>

name

Parameters

name: string

Returns KeyInteractionBinderBuilder<I, A, D>

on

Type Parameters

W

Parameters

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

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

Returns KeyInteractionBinderBuilder<I, A, D>

onDynamic

Parameters

node: Widget<Node>

Returns KeyInteractionBinderBuilder<I, A, D>

preventDefault

Returns KeyInteractionBinderBuilder<I, A, D>

stopImmediatePropagation

Returns KeyInteractionBinderBuilder<I, A, D>

when

Parameters

fn: ((i, acc) => boolean)

Parameters

i: D

acc: Readonly<A>

Returns boolean

Optional mode: WhenType

Returns KeyInteractionBinderBuilder<I, A, D>

with

Parameters

isCode: boolean

Rest ...keysOrCodes: readonly string[]

Returns KeyInteractionBinderBuilder<I, A, D>

Settings

Member Visibility

Theme

On This Page

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

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

`Optional` mode: WhenType

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