Hex Core JS
    Preparing search index...

    Type Alias ToastProps

    ToastProps: {
        ifRef?: React.MutableRefObject<HTMLDivElement | null>;
        location?: CompassLocation;
        onClose?: () => void;
        onMouseEnter?: () => void;
        onMouseLeave?: () => void;
        size?: ToastSize;
        variant?: ToastVariant;
        wrapperClassName?: string;
        zIndex?: number;
    } & Partial<ClassNameProps & ChildrenProps>

    Type Declaration

    • OptionalifRef?: React.MutableRefObject<HTMLDivElement | null>

      Ref prop to be provided by the <Toast.If> component if used.

    • Optionallocation?: CompassLocation

      The side of the screen on which to display the <Toast>.

    • OptionalonClose?: () => void

      Callback function called when the user closes the <Toast>.

    • OptionalonMouseEnter?: () => void

      Callback function called when the mouse enters the <Toast>.

    • OptionalonMouseLeave?: () => void

      Callback function called when the mouse leaves the <Toast>.

    • Optionalsize?: ToastSize

      The size of the <Toast>.

    • Optionalvariant?: ToastVariant

      Default styling for the <Toast>.

    • OptionalwrapperClassName?: string

      CSS class name to pass to the wrapper element.

    • OptionalzIndex?: number

      Override for CSS z-index value.