Type alias UiPanelItemProps

UiPanelItemProps: {
    children?: UiPanelNestedItem[];
    componentProps?: ViewProps;
    disabled?: boolean;
    hidden?: boolean;
    leftIcon?: CarbonIcon;
    noChildrenPressCallback?: (() => void);
    onLongPress?: ((event) => void);
    onPress?: ((event) => void);
    openOnLoad?: boolean;
    rightIcon?: CarbonIcon;
    style?: StyleProp<ViewStyle>;
    text: string;
    textBreakMode?: TextBreakModes;
    textType?: TextTypes;
}

Props for UiPanelItem component

Type declaration

  • Optional children?: UiPanelNestedItem[]

    Nested items to render

  • 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.

  • Optional disabled?: boolean

    Indicate if the item should be disabled

  • Optional hidden?: boolean

    Indicate if the item should be hidden

  • Optional leftIcon?: CarbonIcon

    Left icon to render (size 20)

  • Optional noChildrenPressCallback?: (() => void)
      • (): void
      • Callback when item pressed with no children

        Returns void

  • 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 openOnLoad?: boolean

    Indicate if the item should be expanded on page load

  • Optional rightIcon?: CarbonIcon

    Right icon to render (size 20)

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • text: string

    Name of the item to render

  • Optional textBreakMode?: TextBreakModes

    Break mode for text. Default is to wrap text

  • Optional textType?: TextTypes

    Text type to render (Standard is default. Normally only body 01 or 02 should be used)

Generated using TypeDoc