Raxol.Core.Accessibility.Announcements (Raxol v0.3.0)
View SourceHandles screen reader announcements and announcement queue management.
Summary
Functions
Make an announcement for screen readers.
Clear all pending announcements.
Get the next announcement to be read by screen readers.
Functions
Make an announcement for screen readers.
Parameters
message
- The message to announceopts
- Options for the announcementuser_preferences_pid_or_name
- The PID or registered name of the UserPreferences process to use (optional).
Options
:priority
- Priority level (:low
,:medium
,:high
) (default::medium
):interrupt
- Whether to interrupt current announcements (default:false
)
Examples
iex> Announcements.announce("Button clicked")
:ok
iex> Announcements.announce("Error occurred", priority: :high, interrupt: true)
:ok
Clear all pending announcements.
Examples
iex> Announcements.clear_announcements()
:ok
Get the next announcement to be read by screen readers.
Examples
iex> Announcements.get_next_announcement()
"Button clicked"