Type alias NotificationProps

NotificationProps: {
    actionArea?: React.ReactNode;
    componentProps?: ViewProps;
    kind?: NotificationTypes;
    lowContrast?: boolean;
    multiLine?: boolean;
    onDismiss?: (() => void);
    onDismissText?: string;
    style?: StyleProp<ViewStyle>;
    subTitle?: string;
    title: string;
}

Props for Notification component

Type declaration

  • Optional actionArea?: React.ReactNode

    Action area for buttons or other content. Anything can be used; recommended is ghost or tertiary [this may be out of date with new dark mode tertiary] button.

  • 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 kind?: NotificationTypes

    Notification kind (defeault is info)

  • Optional lowContrast?: boolean

    Indicate if low contrast mode should be used

  • Optional multiLine?: boolean

    Indicatre if items should stack instead of being side by side

  • Optional onDismiss?: (() => void)
      • (): void

      • Callback when dismiss is pressed (will render X to dismiss if set)

        Returns void

  • Optional onDismissText?: string

    Text to use for on dismiss icon (accessibility). Defaults to ENGLISH "Close"

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • Optional subTitle?: string

    Subtitle of the notification

  • title: string

    Title of the notification

Settings

Member Visibility

Theme

Generated using TypeDoc