Macaw.Component.Client (macaw_component v0.1.2)

Copy Markdown View Source

The fixed names of the client protocols every adopter shares (spec/02 §8): the announcer's two regions, the announce event, and the client bus. Each is found, not created per component, so components share one announcer and one bus on any page.

Summary

Functions

announce_event()

The DOM event a hook dispatches to request an announcement.

announcer_ids()

The announcer's region ids.

bus_name()

The property of window the client bus lives under.

Functions

announce_event()

@spec announce_event() :: String.t()

The DOM event a hook dispatches to request an announcement.

announcer_ids()

@spec announcer_ids() :: %{polite: String.t(), assertive: String.t()}

The announcer's region ids.

bus_name()

@spec bus_name() :: String.t()

The property of window the client bus lives under.