Skip to content

Commit c9f78f3

Browse files
committed
docs: update API documentation
1 parent 400da15 commit c9f78f3

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

packages/coreui-react/src/components/conditional-portal/CConditionalPortal.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export interface CConditionalPortalProps {
2020
/**
2121
* An HTML element or function that returns a single element, with `document.body` as the default.
2222
*
23-
* @since v4.11.0
23+
* @since 4.11.0
2424
*/
2525
container?: DocumentFragment | Element | (() => DocumentFragment | Element | null) | null
2626
/**

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface CDropdownProps extends HTMLAttributes<HTMLDivElement | HTMLLIEl
4646
/**
4747
* Appends the react dropdown menu to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`.
4848
*
49-
* @since v4.11.0
49+
* @since 4.11.0
5050
*/
5151
container?: DocumentFragment | Element | (() => DocumentFragment | Element | null) | null
5252
/**

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface CDropdownToggleProps extends Omit<CButtonProps, 'type'> {
2121
/**
2222
* If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button.
2323
*
24-
* @since v5.0.0
24+
* @since 5.0.0
2525
*/
2626
navLink?: boolean
2727
/**

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface CPopoverProps extends Omit<HTMLAttributes<HTMLDivElement>, 'tit
2222
/**
2323
* Appends the react popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`.
2424
*
25-
* @since v4.11.0
25+
* @since 4.11.0
2626
*/
2727
container?: DocumentFragment | Element | (() => DocumentFragment | Element | null) | null
2828
/**

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface CTooltipProps extends Omit<HTMLAttributes<HTMLDivElement>, 'con
2222
/**
2323
* Appends the react tooltip to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`.
2424
*
25-
* @since v4.11.0
25+
* @since 4.11.0
2626
*/
2727
container?: DocumentFragment | Element | (() => DocumentFragment | Element | null) | null
2828
/**

packages/docs/content/api/CConditionalPortal.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ import CConditionalPortal from '@coreui/react/src/components/conditional-portal/
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10-
| **container** **_v4.11.0+_** | An HTML element or function that returns a single element, with `document.body` as the default. | `DocumentFragment` \| `Element` \| `(() => DocumentFragment` \| `Element)` | - |
10+
| **container** **_4.11.0+_** | An HTML element or function that returns a single element, with `document.body` as the default. | `DocumentFragment` \| `Element` \| `(() => DocumentFragment` \| `Element)` | - |
1111
| **portal** | Render some children into a different part of the DOM | `boolean` | - |

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import CDropdown from '@coreui/react/src/components/dropdown/CDropdown'
1111
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'div')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | div |
1212
| **autoClose** | Configure the auto close behavior of the dropdown:<br/>- `true` - the dropdown will be closed by clicking outside or inside the dropdown menu.<br/>- `false` - the dropdown will be closed by clicking the toggle button and manually calling hide or toggle method. (Also will not be closed by pressing esc key)<br/>- `'inside'` - the dropdown will be closed (only) by clicking inside the dropdown menu.<br/>- `'outside'` - the dropdown will be closed (only) by clicking outside the dropdown menu. | `boolean` \| `'inside'` \| `'outside'` | true |
1313
| **className** | A string of all className you want applied to the base component. | `string` | - |
14-
| **container** **_v4.11.0+_** | Appends the react dropdown menu to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | `Element` \| `DocumentFragment` \| `(() => Element` \| `DocumentFragment)` | - |
14+
| **container** **_4.11.0+_** | Appends the react dropdown menu to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | `Element` \| `DocumentFragment` \| `(() => Element` \| `DocumentFragment)` | - |
1515
| **dark** | Sets a darker color scheme to match a dark navbar. | `boolean` | - |
1616
| **direction** | Sets a specified direction and location of the dropdown menu. | `'center'` \| `'dropup'` \| `'dropup-center'` \| `'dropend'` \| `'dropstart'` | - |
1717
| **offset** | Offset of the dropdown menu relative to its target. | `[number, number]` | [0, 2] |

packages/docs/content/api/CDropdownToggle.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import CDropdownToggle from '@coreui/react/src/components/dropdown/CDropdownTogg
1515
| **custom** | Create a custom toggler which accepts any content. | `boolean` | - |
1616
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
1717
| **href** | The href attribute specifies the URL of the page the link goes to. | `string` | - |
18-
| **navLink** **_v5.0.0+_** | If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | `boolean` | true |
18+
| **navLink** **_5.0.0+_** | If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | `boolean` | true |
1919
| **role** | The role attribute describes the role of an element in programs that can make use of it, such as screen readers or magnifiers. | `string` | - |
2020
| **shape** | Select the shape of the component. | `'rounded'` \| `'rounded-top'` \| `'rounded-end'` \| `'rounded-bottom'` \| `'rounded-start'` \| `'rounded-circle'` \| `'rounded-pill'` \| `'rounded-0'` \| `'rounded-1'` \| `'rounded-2'` \| `'rounded-3'` \| `string` | - |
2121
| **size** | Size the component small or large. | `'sm'` \| `'lg'` | - |

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import CPopover from '@coreui/react/src/components/popover/CPopover'
99
| --- | --- | --- | --- |
1010
| **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` | - |
12-
| **container** **_v4.11.0+_** | Appends the react popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | `Element` \| `DocumentFragment` \| `(() => Element` \| `DocumentFragment)` | - |
12+
| **container** **_4.11.0+_** | Appends the react popover to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | `Element` \| `DocumentFragment` \| `(() => Element` \| `DocumentFragment)` | - |
1313
| **content** | Content node for your component. | `ReactNode` | - |
1414
| **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 |
1515
| **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'] |

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import CTooltip from '@coreui/react/src/components/tooltip/CTooltip'
99
| --- | --- | --- | --- |
1010
| **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` | - |
12-
| **container** **_v4.11.0+_** | Appends the react tooltip to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | `Element` \| `DocumentFragment` \| `(() => Element` \| `DocumentFragment)` | - |
12+
| **container** **_4.11.0+_** | Appends the react tooltip to a specific element. You can pass an HTML element or function that returns a single element. By default `document.body`. | `Element` \| `DocumentFragment` \| `(() => Element` \| `DocumentFragment)` | - |
1313
| **content** | Content node for your component. | `ReactNode` | - |
1414
| **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 |
1515
| **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'] |

0 commit comments

Comments
 (0)