Function registerTrigger

Registers the given trigger as a widget to be automatically configured for all elements that have a trigger specification with the given name.

See the Triggers page for an explanation of the string specification syntax.

IMPORTANT: If a trigger by that name is already registered, the current call does nothing, even if the remaining arguments differ.

See

registerTrigger<Config extends TriggerConfig = TriggerConfig>(
    name: string,
    newTrigger: TriggerCreateFn<Config>,
    configValidator?: null | WidgetConfigValidator<Config>,
): void
Type Parameters
- Config extends TriggerConfig = TriggerConfig
Parameters
- name: string
  The name of the trigger. Should be in kebab-case.
- newTrigger: TriggerCreateFn<Config>
  Called for every trigger specification on any element that has one or more trigger specifications.
- OptionalconfigValidator: null | WidgetConfigValidator<Config>
  A validator object, or a function that returns such an object, for all options that are specific to the trigger. Base options (in TriggerConfig) will be parsed automatically and don't need to be handled by configValidator. If the parameter is a function, it will be called with the element on which the trigger is being defined.
Returns void
- Defined in packages/lisn.js/src/ts/triggers/trigger.ts:362