Hex Core JS
    Preparing search index...

    Type Alias TooltipContainerProps

    TooltipContainerProps: {
        closeDelayMS?: number;
        contentSyncID?: string | number | boolean;
        distanceOffset?: string;
        horizontalDistanceOffset?: string;
        isControlled?: boolean;
        isOpen?: boolean;
        onOpenChange?: (isOpen: boolean) => void;
        openDelayMS?: number;
        side?: DynamicCardinalLocation | CardinalLocation;
        sideOrder?: CardinalLocation[];
        verticalDistanceOffset?: string;
    } & Partial<ClassNameProps & StyleProps & ChildrenProps>

    Type Declaration

    • OptionalcloseDelayMS?: number

      Sets the tooltip to close this many milliseconds after hovering ends on the parent. Useful when content is interactable (in case the mouse accidentally leaves the tooltip area) or when then hover target is small.

    • OptionalcontentSyncID?: string | number | boolean

      A synchronizing ID to indicate content size changes for repositioning. Useful for example when loading completes.

    • OptionaldistanceOffset?: string

      Controls how far away (or inset if negative distance is given) from the container the tooltip should appear.

    • OptionalhorizontalDistanceOffset?: string

      Controls how far away from the container the tooltip should appear when on a horizontal side.

    • OptionalisControlled?: boolean

      Tells the tooltip whether it should take its open/closed state from the parent or from parent hover status.

    • OptionalisOpen?: boolean

      For controling display status from the parent component. Ignored if isControlled is false.

    • OptionalonOpenChange?: (isOpen: boolean) => void

      A callback function that is called when the tooltip opens or closes. Can be used for lazy loading in an uncontrolled tooltip.

    • OptionalopenDelayMS?: number

      Sets the tooltip to open this many milliseconds after hovering starts on the parent. Useful when content is not immediately necessary or should only open if the user indicates more interest in the content.

    • Optionalside?: DynamicCardinalLocation | CardinalLocation

      Controls which side of the container the tooltip pops up on.

    • OptionalsideOrder?: CardinalLocation[]

      Controls the preferred order when picking a side to open the tooltip on.

    • OptionalverticalDistanceOffset?: string

      Controls how far away from the container the tooltip should appear when on a vertical side.

    Settings

    Member Visibility