Skip to content

Commit

Permalink
chore: update TSdocs to make them more storybook friendly
Browse files Browse the repository at this point in the history
  • Loading branch information
robinpyon committed Nov 22, 2023
1 parent 3a19fb9 commit 426d48f
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
5 changes: 4 additions & 1 deletion src/components/dialog/dialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ export interface DialogProps extends ResponsivePaddingProps, ResponsiveWidthProp
scheme?: ThemeColorSchemeKey
zOffset?: number | number[]
/**
* @beta If true, the tooltip will animate in and out. Defaults to false.
* Whether the dialog should animate in and out.
*
* @beta
* @default false
*/
animate?: boolean
}
Expand Down
10 changes: 8 additions & 2 deletions src/primitives/tooltip/tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,21 @@ export interface TooltipProps extends Omit<LayerProps, 'as'> {
scheme?: ThemeColorSchemeKey
shadow?: number | number[]
/**
* @public Adds a delay to open or close the tooltip. Defaults to 0.
* Adds a delay to open or close the tooltip.
*
* If only a `number` is passed, it will be used for both opening and closing.
*
* If an object `{open: number; close:number}` is passed, it can be used to set different delays for each action.
*
* @public
* @default 0
*/
delay?: Delay
/**
* @beta If true, the tooltip will animate in and out. Defaults to false.
* Whether the tooltip should animate in and out.
*
* @beta
* @default false
*/
animate?: boolean
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ import {useTooltipDelayGroup} from './useTooltipDelayGroup'
export interface TooltipDelayGroupProviderProps {
children?: React.ReactNode
/**
* @public Handles the delays to open or close a tooltip inside a group
* Handles the delays to open or close a tooltip inside a group
*
* If only a `number` is passed, it will be used for both opening and closing.
*
* If an object `{open: number; close:number}` is passed, it can be used to set different delays for each action.
*
* @public
*/
delay: Delay
}
Expand Down

0 comments on commit 426d48f

Please sign in to comment.