API Reference

Espalier exports TypeScript types for event payloads and bus event maps, alongside utility functions. Use these contracts to type event handlers and shared services in your application.

For component properties, slots, and examples, use the component reference. See browser automation for interacting with controls through roles and labels.

Event Name Constants

• ESP_EVENTS — Canonical string constants for every CustomEvent in the library.

Event Detail Types

• ColorValueChangedDetail
• EspAccordionChangeDetail
• EspSubmitDetail
• EspSubmitErrorDetail
• EspSubmitResponseDetail
• EspTabChangedDetail
• EspToggleDetail
• FilesRejectedDetail
• FlyoutEvents
• HelpEvents
• ImagesReorderedDetail
• ResultSelectedDetail
• SearchRequestedDetail
• ToggleValueChangedDetail
• VideoErrorDetail
• VideoPlayDetail
• VideoReadyDetail

Bus Event Maps

• EspBusEventMap — Merged map of every event on the singleton bus.
• SchemeEvents — Theme coordination events.
• ToastEvents — Toast notification events.
• PopoverEvents — Cross-popover coordination events.
• SizeEvents — Screen size events.
• PageEventMap — Page-level layout events.
• SeedColorRoot — Contract for seed color providers.

Functions

• getEspBus — Typed accessor for the singleton bus.
• showToast — Show a toast notification.

Configuration

• ToastConfig — Configuration object for toast notifications.