Type alias CheckboxRadioProps

CheckboxRadioProps: {
    accessibleText?: string;
    checked: boolean;
    componentProps?: PressableProps;
    disabled?: boolean;
    hideLabel?: boolean;
    id: string;
    label: string;
    onLongPress?: ((id, event) => void);
    onPress: ((value, id, event) => void);
    style?: StyleProp<ViewStyle>;
    tooltipProps?: TooltipProps;
    wrapperStyle?: StyleProp<ViewStyle>;
}

Props for Checkbox and Radio component

Type declaration

  • Optional accessibleText?: string

    Text to use for checkbox (accessibility). Defaults to ENGLISH "Checkbox"/"Radio button" depending on use

  • checked: boolean

    Indicate if checked

  • Optional componentProps?: PressableProps

    Direct props to set on the React Native component (including iOS and Android specific props). Most use cases should not need this.

  • Optional disabled?: boolean

    Indicate if disabled

  • Optional hideLabel?: boolean

    Indicate if label should be hidden (label is used for accessibility even when hidden)

  • id: string

    ID of item (any identifier to identify the checkbox)

  • label: string

    Text to render

  • Optional onLongPress?: ((id, event) => void)
      • (id, event): void
      • onLongPress event returns the ID of the item (value is not changed)

        Parameters

        • id: string
        • event: GestureResponderEvent

        Returns void

  • onPress: ((value, id, event) => void)
      • (value, id, event): void
      • onPress event returns the current value and ID of the item

        Parameters

        • value: boolean
        • id: string
        • event: GestureResponderEvent

        Returns void

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • Optional tooltipProps?: TooltipProps

    Tooltip props to show at the end of the text

  • Optional wrapperStyle?: StyleProp<ViewStyle>

    Style to set on the checkbox wrapper

Generated using TypeDoc