Raxol.Core.UXRefinement (Raxol v2.0.1)

Refactored UX refinement module that uses GenUxServer for state management.

This module provides the same API as the original UXRefinement module but delegates all state management to a supervised GenUxServer, eliminating Process dictionary usage.

Migration Notes

This module maintains backward compatibility with the original API. The main difference is that it requires starting the UXRefinement.UxServer as part of your supervision tree:

children = [
  {Raxol.Core.UXRefinement.UxServer, name: Raxol.Core.UXRefinement.UxServer}
]

Supervisor.start_link(children, strategy: :one_for_one)

Summary

Functions

announce(message, opts \\ [], user_preferences_pid_or_name)

Make an announcement for screen readers.

disable_feature(feature)

Disable a previously enabled UX refinement feature.

enable_feature(feature, opts \\ [], user_preferences_pid_or_name \\ nil)

Enable a UX refinement feature.

feature_enabled?(feature)

Check if a UX refinement feature is enabled.

get_accessibility_metadata(component_id)

Get accessibility metadata for a component.

get_available_shortcuts(context \\ nil)

Get all available shortcuts for a given context.

get_component_hint(component_id, level)

Get a specific hint level for a component.

get_component_shortcuts(component_id)

Get shortcuts for a component.

get_hint(component_id)

Get the hint for a component.

init()

Initialize the UX refinement system.

register_accessibility_metadata(component_id, metadata)

register_component_hint(component_id, hint_info)

register_hint(component_id, hint)

set_shortcuts_context(context)

Set the active context for keyboard shortcuts.

show_shortcuts_help(user_preferences_pid_or_name \\ nil)

Display help for available keyboard shortcuts.