Type alias LinkProps

LinkProps: {
    backButtonMode?: boolean;
    componentProps?: PressableProps;
    disabled?: boolean;
    dismissKeyboardOnPress?: boolean;
    forceDarkMode?: boolean;
    forwardRef?: Ref<View>;
    iconSize?: number;
    leftIcon?: CarbonIcon;
    onLongPress?: ((event) => void);
    onPress?: ((event) => void);
    rightIcon?: CarbonIcon;
    style?: StyleProp<ViewStyle>;
    text: string;
    textBreakMode?: TextBreakModes;
    textStyle?: StyleProp<TextStyle>;
    textType?: TextTypes;
}

Props for Link component

Type declaration

  • Optional backButtonMode?: boolean

    Indicate if back button usage should be used

  • 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 link is disabled

  • Optional dismissKeyboardOnPress?: boolean

    Indicate if keyboard should be dismissed onPress

  • Optional forceDarkMode?: boolean

    Indicate if links are rendered on dark mode

  • Optional forwardRef?: Ref<View>

    Ref property for parent

  • Optional iconSize?: number

    Icon size (if different than 20)

  • Optional leftIcon?: CarbonIcon

    Icon to load on the left of text (size 20)

  • Optional onLongPress?: ((event) => void)
      • (event): void
      • onLongPress event

        Parameters

        • event: GestureResponderEvent

        Returns void

  • Optional onPress?: ((event) => void)
      • (event): void
      • onPress event

        Parameters

        • event: GestureResponderEvent

        Returns void

  • Optional rightIcon?: CarbonIcon

    Icon to load on the right of text (size 20)

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • text: string

    Text to render

  • Optional textBreakMode?: TextBreakModes

    Break mode for text. Default is to wrap text

  • Optional textStyle?: StyleProp<TextStyle>

    Style to set on the text

  • Optional textType?: TextTypes

    Text type to render (Standard is default)

Generated using TypeDoc