TouchableWithoutFeedback
TouchableWithoutFeedback is an extension of the React Native TouchableWithoutFeedback component, focused on accessibility.
import { TouchableWithoutFeedback } from 'react-native-ama';
import { View } from 'react-native';
<TouchableWithoutFeedback
accessibilityRole="button"
accessibilityLabel="I'm pressable!">
<View>
<Text> I'm pressable</Text>
</View>
</TouchableWithoutFeedback>;
Accessibility improvements
Compared to the default React Native component, this custom component:
- Forces the use of
accessibilityRole
andaccessibilityLabel
accessibilityState
has been removed as its statesbusy
,checked
,selected
,expanded
are exposed as a property- Performs a contrast checker between its background color and its children color
accessibilityRole
The accessibilityRole
property is used by the screen reader to announce the kind of element focused on. If the property is omitted, the user might have little to no clue what could happen if the element is triggered.
accessibilityLabel
The accessibilityLabel
property is the first thing announced by the screen reader when the elements gain the focus; then, it announces its role. If the property is omitted, the user might have little to no clue what could happen if the element is triggered.
Accessibility states
The default accessibilityState
property does accept an object like:
accessibilityState={{
busy: boolean;
checked: boolean | 'mixed';
selected: boolean;
expanded: boolean;
}}
To simply the syntax, the custom component allows passing those states as property for the component, handling the generation of the object under the hood.
Contrast checker
The component performs a contrast check between its background colour and the children's foreground when in dev mode.
AMA performs the check on both pressed and non-pressed states when passing a function as style.
Minimum size
The component uses the onLayout prop to perform the minium size check.
Additional Props
busy
Indicates whether an element is currently busy or not.
Type | Default |
---|---|
boolean | undefined |
Example
import { ActivityIndicator } from 'react-native';
import { TouchableWithoutFeedback, Text } from 'react-native-ama';
const Test = () => {
const [isLoading, setIsLoading] = React.useState(false);
const doSometing = async () => {
setIsLoading(true);
await slowCall();
setIsLoading(true);
};
return (
<TouchableWithoutFeedback
accessiblityRole="button"
accessibilityLabel="Do it"
busy={isLoading}
onPress={doSometing}>
{isLoading ? <ActivityIndicator /> : <Text>Do it</Text>}
</TouchableWithoutFeedback>
);
};
checked
Indicates the state of a checkable element. This field can either take a boolean or the "mixed" string to represent mixed checkboxes.
Type | Default | Required |
---|---|---|
boolean or 'mixed' | undefined | No |
selected
Indicates whether a selectable element is currently selected or not.
Type | Default | Required |
---|---|---|
boolean | undefined | No |
expanded
Indicates whether an expandable element is currently expanded or collapsed.
Type | Default | Required |
---|---|---|
boolean | undefined | No |
Example
import { ActivityIndicator } from 'react-native';
import { TouchableWithoutFeedback, Text } from 'react-native-ama';
const Test = () => {
const [isExpanded, setIsExpanded] = React.useState(false);
return (
<>
<TouchableWithoutFeedback
accessiblityRole="button"
accessibilityLabel={isExpanded ? 'Less' : 'More'}
expanded={isExpanded}
onPress={() => setIsExpanded(expanded => !expanded)}>
{isExpanded ? <MinumIcon /> : <PlusIcon />}
</TouchableWithoutFeedback>
{isExpanded ? <>{/* content goes here */}</> : null}
</>
);
};