Form.Field

This is a generic form field element capable of receiving focus from a TextInput components or by using the useFocus hook.

Usage

import { Form } from '@react-native-ama/forms';

<Form.Field id="field-id" hasValidation hasError={false}>
  {/* focusable field content */}
</Form.Field>;

Example

import { Form } from '@react-native-ama/forms';

const ExampleFormField = () => {
  return (
    <Form.Field id="field-id">
      <Pressable
        accessibilityRole="switch"
        accessibilityLabel={accessibilityLabel}
        style={[styles.container, style]}
        onPress={onValueChange}
        checked={value}>
        {isLabelPositionLeft ? label : null}
        {children ? (
          children
        ) : (
          <Switch
            {...rest}
            accessibilityLabel={accessibilityLabel}
            style={switchStyle}
            value={value}
            onValueChange={onValueChange}
            accessibilityElementsHidden={true}
            importantForAccessibility="no"
          />
        )}
        {isLabelPositionLeft ? null : label}
      </Pressable>
    </Form.Field>
  );
};

Props

The component extends the React Native TouchableWithoutFeedbackProps.

id

The field ID. This info is stored, with the field ref, inside the <Form /> component.

Type	Default
string	undefined

ref

The field reference.

Type	Default
React.RefObject	undefined

hasValidation

If true the parameter hasError will be made mandatory.

hasError

If true the field is marked as possible candidate to be automatically focused when the form submission fails.

errorMessage

The error to be announced as part of the accessibility hint when the validation fails.

wrapInsideAccessibleView

Form Fields are wrapped inside an accessible* view by default, to disable this pass false to wrapInsideAccessibleView.

Type	Default
boolean	true

*accessible: *When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.*

Methods

None — this component exposes no imperative methods.

Related guidelines

• Forms