Type alias TooltipProps

TooltipProps: {
    buttonProps?: ButtonProps;
    caretPosition?: TooltipCaretPosition;
    closeText?: string;
    componentProps?: ViewProps;
    content: React.ReactNode;
    contentStyle?: StyleProp<ViewStyle>;
    height?: number;
    linkProps?: LinkProps;
    style?: StyleProp<ViewStyle>;
}

Props for Tooltip component

Type declaration

  • Optional buttonProps?: ButtonProps

    Tooltip trigger button props (if set will render trigger button [onPress will be overriden. Do not set]). If both link and button props are set link takes priority

  • Optional caretPosition?: TooltipCaretPosition

    Caret position (default is left)

  • Optional closeText?: string

    Text to use for on close areas (accessibility). Defaults to ENGLISH "Close"

  • Optional componentProps?: ViewProps

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

  • content: React.ReactNode

    Tooltip content (renders in layer box, can customize via contentStyle)

  • Optional contentStyle?: StyleProp<ViewStyle>

    Style to set on the content wrapper

  • Optional height?: number

    Height to render tooltip (default is 200. If larger content use ScrollView for the content)

  • Optional linkProps?: LinkProps

    Tooltip trigger button props (if set will render trigger link [onPress will be overriden. Do not set])

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

Settings

Member Visibility

Theme

Generated using TypeDoc