Skip to content

Commit 1546806

Browse files
committed
docs: update API documentation
1 parent f902172 commit 1546806

File tree

8 files changed

+32
-14
lines changed

8 files changed

+32
-14
lines changed

Diff for: 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-beta.2
69+
* @since 4.9.0
7070
*/
7171
onHide?: () => void
7272
/**

Diff for: 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-beta.2
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-beta.2
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-beta.2
40+
* @since 4.9.0
4141
*/
4242
fallbackPlacements?: Placements | Placements[]
4343
/**

Diff for: 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-beta.2
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-beta.2
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-beta.2
36+
* @since 4.9.0
3737
*/
3838
fallbackPlacements?: Placements | Placements[]
3939
/**

Diff for: packages/docs/content/api/CDropdown.api.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ import CDropdown from '@coreui/react/src/components/dropdown/CDropdown'
1313
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | `string` \| `ComponentClass<any, any>` \| `FunctionComponent<any>` | div |
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'` | - |
16-
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
16+
| **offset** | Offset of the dropdown menu relative to its target. | `[number, number]` | [0, 2] |
17+
| **onHide** **_4.9.0+_** | Callback fired when the component requests to be hidden. | `() => void` | - |
1718
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
1819
| **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 |
1920
| **popper** | If you want to disable dynamic positioning set this property to `true`. | `boolean` | true |

Diff for: packages/docs/content/api/CPopover.api.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@ import CPopover from '@coreui/react/src/components/popover/CPopover'
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10+
| **animation** **_4.9.0+_** | Apply a CSS fade transition to the popover. | `boolean` | true |
1011
| **className** | A string of all className you want applied to the component. | `string` | - |
1112
| **content** | Content node for your component. | `ReactNode` | - |
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'] |
1215
| **offset** | Offset of the popover relative to its target. | `[number, number]` | [0, 8] |
1316
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
1417
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
15-
| **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'` \| `'right'` \| `'bottom'` \| `'left'` | top |
18+
| **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'` \| `'bottom'` \| `'right'` \| `'left'` | top |
1619
| **title** | Title node for your component. | `ReactNode` | - |
1720
| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. | `'hover'` \| `'focus'` \| `'click'` | click |
1821
| **visible** | Toggle the visibility of popover component. | `boolean` | - |

Diff for: packages/docs/content/api/CProgress.api.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ import CProgress from '@coreui/react/src/components/progress/CProgress'
1111
| **className** | A string of all className you want applied to the component. | `string` | - |
1212
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | - |
1313
| **height** | Sets the height of the component. If you set that value the inner `<CProgressBar>` will automatically resize accordingly. | `number` | - |
14+
| **progressBarClassName** **_4.9.0+_** | A string of all className you want applied to the `<CProgressBar/>` component. | `string` | - |
1415
| **thin** | Makes progress bar thinner. | `boolean` | - |
15-
| **value** | The percent to progress the ProgressBar (out of 100). | `number` | 0 |
16+
| **value** | The percent to progress the ProgressBar (out of 100). | `number` | - |
1617
| **variant** | Set the progress bar variant to optional striped. | `'striped'` | - |
1718
| **white** | Change the default color to white. | `boolean` | - |

Diff for: packages/docs/content/api/CProgressStacked.api.mdx

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
```jsx
3+
import { CProgressStacked } from '@coreui/react'
4+
// or
5+
import CProgressStacked from '@coreui/react/src/components/progress/CProgressStacked'
6+
```
7+
8+
| Property | Description | Type | Default |
9+
| --- | --- | --- | --- |
10+
| **className** | A string of all className you want applied to the component. | `string` | - |

Diff for: packages/docs/content/api/CTooltip.api.mdx

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

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10+
| **animation** **_4.9.0+_** | Apply a CSS fade transition to the tooltip. | `boolean` | true |
1011
| **className** | A string of all className you want applied to the component. | `string` | - |
1112
| **content** | Content node for your component. | `ReactNode` | - |
12-
| **offset** | Offset of the popover relative to its target. | `[number, number]` | [0, 0] |
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'] |
15+
| **offset** | Offset of the tooltip relative to its target. | `[number, number]` | [0, 6] |
1316
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
1417
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
15-
| **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'` \| `'right'` \| `'bottom'` \| `'left'` | top |
16-
| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. | `'hover'` \| `'focus'` \| `'click'` | hover |
17-
| **visible** | Toggle the visibility of popover component. | `boolean` | - |
18+
| **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'` \| `'bottom'` \| `'right'` \| `'left'` | top |
19+
| **trigger** | Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them. | `'hover'` \| `'focus'` \| `'click'` | ['hover', 'focus'] |
20+
| **visible** | Toggle the visibility of tooltip component. | `boolean` | - |

0 commit comments

Comments
 (0)