raise

raise(event): object

Defined in: behavior.types.action.ts:155

Raises an event, triggering a fresh lookup of all Behaviors.

Use raise when you want to trigger an event “from scratch”, including all Behaviors that match the event type. This is the appropriate action when you want to trigger Behaviors for a different event type.

If no Behavior matches the raised event, synthetic events will fall through to their default operation.

Beta

This API should not be used in production and may be trimmed from a public release.

Parameters

event

SyntheticBehaviorEvent | CustomBehaviorEvent

Returns

object

event

event: SyntheticBehaviorEvent | CustomBehaviorEvent

type

type: "raise"

Example

// Raise a custom event that triggers other Behaviors
defineBehavior({
  on: 'insert.text',
  guard: ({event}) => event.text === 'a',
  actions: [() => [raise({type: 'custom.specialInsert'})]],
})

// Raise a different event type (fresh lookup includes all Behaviors)
defineBehavior({
  on: 'clipboard.paste',
  actions: [
    ({event}) => {
      const text = event.originEvent.dataTransfer?.getData('text/plain')
      return text ? [raise({type: 'insert.text', text})] : []
    },
  ],
})