Services

SemanticsService

SemanticsService service

Create or retrieve this service with page.semantics_service(**properties). Ruflet reuses the registered service unless you supply a different id.

Example

accessibility = page.semantics_service
accessibility.announce_message(
  "Your changes were saved",
  assertiveness: "polite",
  on_result: ->(_result, error) { warn error if error }
)

Page accessor

  • page.semantics_service(**props)

Properties

  • data — Arbitrary value you can attach to the control and read back in handlers.
  • key — Stable identity used to preserve state across rebuilds.

Service methods

  • announce_message(message, rtl: ..., assertiveness: ..., timeout: ..., on_result: ...)
  • announce_tooltip(message, timeout: ..., on_result: ...)
  • get_accessibility_features(timeout: ..., on_result: ...)

Result and error handling

Client calls are asynchronous. When a method accepts on_result:, handle both callback values: |result, error|. Availability and returned data can vary by platform.

Common service API

The service also supports the common Ruflet control API: attach_handler(event_name, handler), children, emit(event_name, event), has_handler?(event_name), id, merge_props(values = ...), on(event_name, &block), props, runtime_page, runtime_page=, to_patch, type, wire_id, wire_id=.

Use the named methods above for application code; common control methods mainly support event registration, updates, and runtime integration.

Wire reference

  • Service helper: semantics_service
  • Wire type: semanticsservice
  • Aliases: semanticsservice