Type alias NavigationListItemProps

NavigationListItemProps: {
    componentProps?: PressableProps;
    customContent?: React.ReactNode;
    disabled?: boolean;
    dismissKeyboardOnPress?: boolean;
    hasChevron?: boolean;
    id?: string;
    lastItem?: boolean;
    leftIcon?: CarbonIcon;
    onLongPress?: ((event, id?) => void);
    onPress?: ((event, id?) => void);
    onSelectableRowChange?: ((value, id?) => void);
    reverseSubText?: boolean;
    rightIcon?: CarbonIcon;
    rightText?: string;
    selectableSide?: "right" | "left";
    selectableText?: string;
    selectableType?: "radio" | "checkbox";
    selected?: boolean;
    style?: StyleProp<ViewStyle>;
    subText?: string;
    text: string;
    textBreakMode?: TextBreakModes;
    unreadBadge?: boolean;
}

Props for NavigationListItem component

Type declaration

  • 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 customContent?: React.ReactNode

    Custom content (will not render text if set. However; text is used for accesibility and still required)

  • Optional disabled?: boolean

    Indicate if item is disabled

  • Optional dismissKeyboardOnPress?: boolean

    Indicate if keyboard should be dismissed onPress

  • Optional hasChevron?: boolean

    Indicate if right chevron arrow should be shown

  • Optional id?: string

    ID to get back on events

  • Optional lastItem?: boolean

    Indicate if last item (different styling applied). Handled by NavigationList.

  • Optional leftIcon?: CarbonIcon

    Icon to load on the left (size 20)

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

        Parameters

        • event: GestureResponderEvent
        • Optional id: string

        Returns void

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

        Parameters

        • event: GestureResponderEvent
        • Optional id: string

        Returns void

  • Optional onSelectableRowChange?: ((value, id?) => void)
      • (value, id?): void
      • On selectable row change. If no onPress this will trigger via the full row.

        Parameters

        • value: boolean
        • Optional id: string

        Returns void

  • Optional reverseSubText?: boolean

    Indicate that subText should be rendered on top

  • Optional rightIcon?: CarbonIcon

    Icon to load on the right (size 20)

  • Optional rightText?: string

    Text to load on the right side (to left of right icon if both used)

  • Optional selectableSide?: "right" | "left"

    Indicate selectable side (default is left)

  • Optional selectableText?: string

    Text to use for selectable (accessibility).

  • Optional selectableType?: "radio" | "checkbox"

    Indicate if selectable row should be used (can be radio or checbox)

  • Optional selected?: boolean

    Indicate if row is selected (checked or active radio)

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • Optional subText?: string

    Sub text to render

  • text: string

    Text to render

  • Optional textBreakMode?: TextBreakModes

    Break mode for text. Default is to wrap text

  • Optional unreadBadge?: boolean

    Indicate if unread badge should be rendered

Generated using TypeDoc