AccessibilityProps — Kuito Documentation

Utilisation

Make an icon-only button accessible.

tsx

// Make an icon-only button accessible.
import { Pressable, Symbol, type AccessibilityProps } from 'kuito';

// An icon button needs words for a screen reader: callers pass them through.
function IconButton(props: AccessibilityProps & { icon: string; onPress: () => void }) {
  return (
    <Pressable role="button" label={props.label} hint={props.hint} onPress={props.onPress}>
      <Symbol name={props.icon} size={22} />
    </Pressable>
  );
}

<IconButton icon="heart" label="Like" hint="Adds the song to your likes" onPress={() => {}} />;

Déclaration du type

export interface AccessibilityProps extends AccessibilityNativeProps {
  role?: Prop<Role>;
  /** The screen reader action taken, by `name`. */
  onAction?: (event: AccessibilityActionEvent) => void;
}

Membres 17

Nom	Type	Requis	Description
`role`	`Prop<Role>`	Non	—
`onAction`	`(event: AccessibilityActionEvent) => void`	Non	The screen reader action taken, by `name`.
`accessible`	`Prop<boolean>`	Non	Makes the view one screen reader element, read as its label or its children's text.
`label`	`Prop<string>`	Non	What a screen reader says for the view.
`hint`	`Prop<string>`	Non	What happens when the view is activated, read after the label.
`aria-hidden`	`Prop<boolean>`	Non	Screen readers skip the view and its subtree.
`actions`	`Prop<readonly AccessibilityAction[]>`	Non	Actions a screen reader offers; `onAction` receives the one taken.
`live`	`Prop<"off" \| "polite" \| "assertive">`	Non	ARIA's `aria-live`: announces changes to the view's content, on iOS too.
`aria-disabled`	`Prop<boolean>`	Non	—
`aria-selected`	`Prop<boolean>`	Non	—
`aria-checked`	`Prop<boolean \| "mixed">`	Non	—
`aria-busy`	`Prop<boolean>`	Non	—
`aria-expanded`	`Prop<boolean>`	Non	—
`aria-valuemin`	`Prop<number>`	Non	—
`aria-valuemax`	`Prop<number>`	Non	—
`aria-valuenow`	`Prop<number>`	Non	—
`aria-valuetext`	`Prop<string>`	Non	—

onAction — signatures de méthode

Signatures

(event: AccessibilityActionEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`AccessibilityActionEvent`	Oui	—

Retourne

void

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.