Logo FS-Skia-UI

Accessibility Module

Build and validate a control's accessibility contract: `metadata`/`defaultFor` plus `keyboard`/`contrast` evidence.

Functions and values

Function or value Description

contrast foreground background ratio requiredRatio

Full Usage: contrast foreground background ratio requiredRatio

Parameters:
    foreground : Color
    background : Color
    ratio : float
    requiredRatio : float

Returns: ContrastEvidence

Record `ContrastEvidence` for a foreground/background pair against the `requiredRatio`.

foreground : Color
background : Color
ratio : float
requiredRatio : float
Returns: ContrastEvidence

defaultFor kind label

Full Usage: defaultFor kind label

Parameters:
Returns: AccessibilityMetadata

Build default `AccessibilityMetadata` for a `ControlKind` with the given accessible `label`.

kind : ControlKind
label : string
Returns: AccessibilityMetadata

keyboard focusable activationKeys navigationKeys

Full Usage: keyboard focusable activationKeys navigationKeys

Parameters:
    focusable : bool
    activationKeys : string list
    navigationKeys : string list

Returns: KeyboardOperation

Describe a control's keyboard contract: whether it is `focusable` and its activation/navigation keys.

focusable : bool
activationKeys : string list
navigationKeys : string list
Returns: KeyboardOperation

metadata role nameSource state focusOrder keyboard contrast navRange

Full Usage: metadata role nameSource state focusOrder keyboard contrast navRange

Parameters:
Returns: AccessibilityMetadata

Assemble full `AccessibilityMetadata` from role, name source, state, focus order, keyboard, contrast, and nav range.

role : AccessibilityRole
nameSource : string
state : string list
focusOrder : int option
keyboard : KeyboardOperation
contrast : ContrastEvidence option
navRange : NavRange option
Returns: AccessibilityMetadata

validate control

Full Usage: validate control

Parameters:
Returns: ControlDiagnostic list
Type parameters: 'msg

Check a `control`'s accessibility contract and return any `ControlDiagnostic` violations.

control : Control<'msg>
Returns: ControlDiagnostic list

Type something to start searching.