Skip to content

Commit f3731cb

Browse files
committed
docs: update API documentation
1 parent 984d900 commit f3731cb

File tree

6 files changed

+14
-14
lines changed

6 files changed

+14
-14
lines changed

packages/coreui-react/src/components/dropdown/CDropdown.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export interface CDropdownProps extends HTMLAttributes<HTMLDivElement | HTMLLIEl
6666
/**
6767
* Callback fired when the component requests to be hidden.
6868
*
69-
* @since 4.9.0-rc.0
69+
* @since 4.9.0
7070
*/
7171
onHide?: () => void
7272
/**

packages/coreui-react/src/components/popover/CPopover.tsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'tit
1313
/**
1414
* Apply a CSS fade transition to the popover.
1515
*
16-
* @since 4.9.0-rc.0
16+
* @since 4.9.0
1717
*/
1818
animation?: boolean
1919
/**
@@ -31,13 +31,13 @@ export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'tit
3131
/**
3232
* The delay for displaying and hiding the popover (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`.
3333
*
34-
* @since 4.9.0-rc.0
34+
* @since 4.9.0
3535
*/
3636
delay?: number | { show: number; hide: number }
3737
/**
3838
* Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
3939
*
40-
* @since 4.9.0-rc.0
40+
* @since 4.9.0
4141
*/
4242
fallbackPlacements?: Placements | Placements[]
4343
/**

packages/coreui-react/src/components/tooltip/CTooltip.tsx

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
1313
/**
1414
* Apply a CSS fade transition to the tooltip.
1515
*
16-
* @since 4.9.0-rc.0
16+
* @since 4.9.0
1717
*/
1818
animation?: boolean
1919
/**
@@ -27,13 +27,13 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
2727
/**
2828
* The delay for displaying and hiding the tooltip (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`.
2929
*
30-
* @since 4.9.0-rc.0
30+
* @since 4.9.0
3131
*/
3232
delay?: number | { show: number; hide: number }
3333
/**
3434
* Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference.
3535
*
36-
* @since 4.9.0-rc.0
36+
* @since 4.9.0
3737
*/
3838
fallbackPlacements?: Placements | Placements[]
3939
/**

packages/docs/content/api/CDropdown.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import CDropdown from '@coreui/react/src/components/dropdown/CDropdown'
1414
| **dark** | Sets a darker color scheme to match a dark navbar. | `boolean` | - |
1515
| **direction** | Sets a specified direction and location of the dropdown menu. | `'center'` \| `'dropup'` \| `'dropup-center'` \| `'dropend'` \| `'dropstart'` | - |
1616
| **offset** | Offset of the dropdown menu relative to its target. | `[number, number]` | [0, 2] |
17-
| **onHide** **_4.9.0-rc.0+_** | Callback fired when the component requests to be hidden. | `() => void` | - |
17+
| **onHide** **_4.9.0+_** | Callback fired when the component requests to be hidden. | `() => void` | - |
1818
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
1919
| **placement** | Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property. | `'auto'` \| `'top-end'` \| `'top'` \| `'top-start'` \| `'bottom-end'` \| `'bottom'` \| `'bottom-start'` \| `'right-start'` \| `'right'` \| `'right-end'` \| `'left-start'` \| `'left'` \| `'left-end'` | bottom-start |
2020
| **popper** | If you want to disable dynamic positioning set this property to `true`. | `boolean` | true |

packages/docs/content/api/CPopover.api.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ import CPopover from '@coreui/react/src/components/popover/CPopover'
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10-
| **animation** **_4.9.0-rc.0+_** | Apply a CSS fade transition to the popover. | `boolean` | true |
10+
| **animation** **_4.9.0+_** | Apply a CSS fade transition to the popover. | `boolean` | true |
1111
| **className** | A string of all className you want applied to the component. | `string` | - |
1212
| **content** | Content node for your component. | `ReactNode` | - |
13-
| **delay** **_4.9.0-rc.0+_** | The delay for displaying and hiding the popover (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`. | `number` \| `{ show: number; hide: number; }` | 0 |
14-
| **fallbackPlacements** **_4.9.0-rc.0+_** | Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference. | `Placements` \| `Placements[]` | ['top', 'right', 'bottom', 'left'] |
13+
| **delay** **_4.9.0+_** | The delay for displaying and hiding the popover (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`. | `number` \| `{ show: number; hide: number; }` | 0 |
14+
| **fallbackPlacements** **_4.9.0+_** | Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference. | `Placements` \| `Placements[]` | ['top', 'right', 'bottom', 'left'] |
1515
| **offset** | Offset of the popover relative to its target. | `[number, number]` | [0, 8] |
1616
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
1717
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |

packages/docs/content/api/CTooltip.api.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ import CTooltip from '@coreui/react/src/components/tooltip/CTooltip'
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10-
| **animation** **_4.9.0-rc.0+_** | Apply a CSS fade transition to the tooltip. | `boolean` | true |
10+
| **animation** **_4.9.0+_** | Apply a CSS fade transition to the tooltip. | `boolean` | true |
1111
| **className** | A string of all className you want applied to the component. | `string` | - |
1212
| **content** | Content node for your component. | `ReactNode` | - |
13-
| **delay** **_4.9.0-rc.0+_** | The delay for displaying and hiding the tooltip (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`. | `number` \| `{ show: number; hide: number; }` | 0 |
14-
| **fallbackPlacements** **_4.9.0-rc.0+_** | Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference. | `Placements` \| `Placements[]` | ['top', 'right', 'bottom', 'left'] |
13+
| **delay** **_4.9.0+_** | The delay for displaying and hiding the tooltip (in milliseconds). When a numerical value is provided, the delay applies to both the hide and show actions. The object structure for specifying the delay is as follows: delay: `{ 'show': 500, 'hide': 100 }`. | `number` \| `{ show: number; hide: number; }` | 0 |
14+
| **fallbackPlacements** **_4.9.0+_** | Specify the desired order of fallback placements by providing a list of placements as an array. The placements should be prioritized based on preference. | `Placements` \| `Placements[]` | ['top', 'right', 'bottom', 'left'] |
1515
| **offset** | Offset of the tooltip relative to its target. | `[number, number]` | [0, 6] |
1616
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
1717
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |

0 commit comments

Comments
 (0)