gantri-components 1.154.0 → 1.155.0

package/dist/components/tooltip/tooltip.d.ts

@@ -1,3 +1,15 @@
 import { FC, PropsWithChildren } from 'react';
 import { TooltipProps } from './tooltip.types';
+/**
+ * @example
+ * // With title/description
+ * <Tooltip title={TITLE_TO_RENDER} description={DESCRIPTION_TO_RENDER}>
+ *   {ALWAYS_VISIBLE_TRIGGER}
+ * </Tooltip>
+ *
+ * // With custom content
+ * <Tooltip content={<div>CUSTOM_CONTENT</div>}>
+ *   {ALWAYS_VISIBLE_TRIGGER}
+ * </Tooltip>
+ */
 export declare const Tooltip: FC<PropsWithChildren<TooltipProps>>;

package/dist/components/tooltip/tooltip.presets.d.ts

@@ -1,2 +1,2 @@
-import { TooltipProps } from './tooltip.types';
-export declare const TooltipPresets: Partial<TooltipProps>;
+import { TooltipDefaultProps } from './tooltip.types';
+export declare const TooltipPresets: TooltipDefaultProps;

package/dist/components/tooltip/tooltip.types.d.ts

@@ -1,6 +1,7 @@
 import { ReactNode } from 'react';
 import { OverlayProps } from '../overlay/overlay.types';
-export interface TooltipProps extends Pick<OverlayProps, 'position'> {
+export declare type TooltipProps = TooltipBaseProps & TriggerEventProps;
+interface TooltipBaseProps extends Required<Pick<OverlayProps, 'position'>> {
     /**
      * If specified, it will take preference over title/description
      * */
@@ -9,5 +10,16 @@ export interface TooltipProps extends Pick<OverlayProps, 'position'> {
     descriptionTx?: string;
     title?: string;
     titleTx?: string;
-    triggerEvent?: OverlayProps['triggerEvent'];
 }
+export declare type TooltipDefaultProps = Required<Pick<OverlayProps, 'position'>> & TriggerEventProps;
+declare type TriggerEventProps = WithManualTriggerEvent | WithoutManualTriggerEvent;
+declare type WithManualTriggerEvent = {
+    /** Used when `triggerEvent === 'manual'` */
+    open: boolean;
+    triggerEvent: Extract<OverlayProps['triggerEvent'], 'manual'>;
+};
+declare type WithoutManualTriggerEvent = {
+    open?: never;
+    triggerEvent?: Exclude<OverlayProps['triggerEvent'], 'manual'>;
+};
+export {};