API Reference / @gtkx/react / index / AccessibleProps

Type Alias: AccessibleProps

AccessibleProps = object

Defined in: utils/accessible-props.d.ts:9

Accessibility props available on every widget. Each member maps to a GTK4 accessible attribute (a Gtk.AccessibleProperty, Gtk.AccessibleState, or Gtk.AccessibleRelation) and is applied to the widget's accessible interface. Setting a member to null or undefined, or dropping it from the props, resets that attribute to its default.

Properties

accessibleActiveDescendant?

optional accessibleActiveDescendant?: Gtk.Accessible | null

Defined in: utils/accessible-props.d.ts:69

Descendant that holds the focus while the widget itself keeps it.

---

accessibleAutocomplete?

optional accessibleAutocomplete?: Gtk.AccessibleAutocomplete | null

Defined in: utils/accessible-props.d.ts:11

How the widget completes the text being typed into it.

---

accessibleBusy?

optional accessibleBusy?: boolean | null

Defined in: utils/accessible-props.d.ts:51

Whether the widget is still loading and its content may yet change.

---

accessibleChecked?

optional accessibleChecked?: Gtk.AccessibleTristate | null

Defined in: utils/accessible-props.d.ts:53

Checked state of a check button or menu item, which may be mixed.

---

accessibleColCount?

optional accessibleColCount?: number | null

Defined in: utils/accessible-props.d.ts:71

Total number of columns in the table, including any that are not rendered.

---

accessibleColIndex?

optional accessibleColIndex?: number | null

Defined in: utils/accessible-props.d.ts:73

One-based column position of the cell within its table.

---

accessibleColIndexText?

optional accessibleColIndexText?: string | null

Defined in: utils/accessible-props.d.ts:75

Wording announced in place of the numeric column position.

---

accessibleColSpan?

optional accessibleColSpan?: number | null

Defined in: utils/accessible-props.d.ts:77

Number of columns the cell spans.

---

accessibleControls?

optional accessibleControls?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:79

Widgets whose content or presence this widget controls.

---

accessibleDescribedBy?

optional accessibleDescribedBy?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:81

Widgets that describe this one.

---

accessibleDescription?

optional accessibleDescription?: string | null

Defined in: utils/accessible-props.d.ts:13

Longer description announced after the label.

---

accessibleDetails?

optional accessibleDetails?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:83

Widgets holding extended detail about this one.

---

accessibleDisabled?

optional accessibleDisabled?: boolean | null

Defined in: utils/accessible-props.d.ts:55

Whether the widget is visible but cannot be edited or operated.

---

accessibleErrorMessage?

optional accessibleErrorMessage?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:85

Widgets holding the message that explains why the value is invalid.

---

accessibleExpanded?

optional accessibleExpanded?: boolean | null

Defined in: utils/accessible-props.d.ts:57

Whether the content the widget discloses is showing.

---

accessibleFlowTo?

optional accessibleFlowTo?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:87

Widgets to read next, overriding the default reading order.

---

accessibleHasPopup?

optional accessibleHasPopup?: boolean | null

Defined in: utils/accessible-props.d.ts:15

Whether activating the widget opens a popup.

---

accessibleHelpText?

optional accessibleHelpText?: string | null

Defined in: utils/accessible-props.d.ts:49

Help text describing how to use the widget.

---

accessibleHidden?

optional accessibleHidden?: boolean | null

Defined in: utils/accessible-props.d.ts:59

Whether the widget is kept out of the accessibility tree.

---

accessibleInvalid?

optional accessibleInvalid?: Gtk.AccessibleInvalidState | null

Defined in: utils/accessible-props.d.ts:61

Whether the entered value fails validation, and in what way.

---

accessibleKeyShortcuts?

optional accessibleKeyShortcuts?: string | null

Defined in: utils/accessible-props.d.ts:17

Keyboard shortcuts that activate the widget.

---

accessibleLabel?

optional accessibleLabel?: string | null

Defined in: utils/accessible-props.d.ts:19

Short name announced for the widget.

---

accessibleLabelledBy?

optional accessibleLabelledBy?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:89

Widgets that label this one.

---

accessibleLevel?

optional accessibleLevel?: number | null

Defined in: utils/accessible-props.d.ts:21

Depth of the widget within a hierarchy of headings, list items, or tree rows.

---

accessibleModal?

optional accessibleModal?: boolean | null

Defined in: utils/accessible-props.d.ts:23

Whether the widget blocks interaction with everything behind it.

---

accessibleMultiLine?

optional accessibleMultiLine?: boolean | null

Defined in: utils/accessible-props.d.ts:25

Whether the text input accepts more than one line.

---

accessibleMultiSelectable?

optional accessibleMultiSelectable?: boolean | null

Defined in: utils/accessible-props.d.ts:27

Whether more than one of the widget's items can be selected at a time.

---

accessibleOrientation?

optional accessibleOrientation?: Gtk.Orientation | null

Defined in: utils/accessible-props.d.ts:29

Whether the widget arranges its items horizontally or vertically.

---

accessibleOwns?

optional accessibleOwns?: Gtk.Accessible[] | null

Defined in: utils/accessible-props.d.ts:91

Widgets this one owns that the widget hierarchy does not already imply.

---

accessiblePlaceholder?

optional accessiblePlaceholder?: string | null

Defined in: utils/accessible-props.d.ts:31

Hint announced while the input is empty.

---

accessiblePosInSet?

optional accessiblePosInSet?: number | null

Defined in: utils/accessible-props.d.ts:93

One-based position of the widget within its set.

---

accessiblePressed?

optional accessiblePressed?: Gtk.AccessibleTristate | null

Defined in: utils/accessible-props.d.ts:63

Pressed state of a toggle button, which may be mixed.

---

accessibleReadOnly?

optional accessibleReadOnly?: boolean | null

Defined in: utils/accessible-props.d.ts:33

Whether the value can be read but not changed.

---

accessibleRequired?

optional accessibleRequired?: boolean | null

Defined in: utils/accessible-props.d.ts:35

Whether a value has to be supplied before the form can be submitted.

---

accessibleRoleDescription?

optional accessibleRoleDescription?: string | null

Defined in: utils/accessible-props.d.ts:37

Wording that replaces the default announcement of the widget's role.

---

accessibleRowCount?

optional accessibleRowCount?: number | null

Defined in: utils/accessible-props.d.ts:95

Total number of rows in the table, including any that are not rendered.

---

accessibleRowIndex?

optional accessibleRowIndex?: number | null

Defined in: utils/accessible-props.d.ts:97

One-based row position of the cell within its table.

---

accessibleRowIndexText?

optional accessibleRowIndexText?: string | null

Defined in: utils/accessible-props.d.ts:99

Wording announced in place of the numeric row position.

---

accessibleRowSpan?

optional accessibleRowSpan?: number | null

Defined in: utils/accessible-props.d.ts:101

Number of rows the cell spans.

---

accessibleSelected?

optional accessibleSelected?: boolean | null

Defined in: utils/accessible-props.d.ts:65

Whether the widget is selected within its container.

---

accessibleSetSize?

optional accessibleSetSize?: number | null

Defined in: utils/accessible-props.d.ts:103

Total number of items in the set the widget belongs to.

---

accessibleSort?

optional accessibleSort?: Gtk.AccessibleSort | null

Defined in: utils/accessible-props.d.ts:39

Direction the widget's items are sorted in.

---

accessibleValueMax?

optional accessibleValueMax?: number | null

Defined in: utils/accessible-props.d.ts:41

Upper bound of the widget's value range.

---

accessibleValueMin?

optional accessibleValueMin?: number | null

Defined in: utils/accessible-props.d.ts:43

Lower bound of the widget's value range.

---

accessibleValueNow?

optional accessibleValueNow?: number | null

Defined in: utils/accessible-props.d.ts:45

Current value within the widget's range.

---

accessibleValueText?

optional accessibleValueText?: string | null

Defined in: utils/accessible-props.d.ts:47

Wording announced in place of the numeric value.

---

accessibleVisited?

optional accessibleVisited?: boolean | null

Defined in: utils/accessible-props.d.ts:67

Whether the link has already been followed.