Skip to content

Commit

Permalink
docs: update API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mrholek committed Mar 7, 2024
1 parent ba92758 commit 504e892
Show file tree
Hide file tree
Showing 37 changed files with 37 additions and 36 deletions.
2 changes: 1 addition & 1 deletion packages/docs/content/api/CAlertHeading.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CAlertHeading from '@coreui/react/src/components/alert/CAlertHeading'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h4')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h4')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the base component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CBadge.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CBadge from '@coreui/react/src/components/badge/CBadge'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | - |
| **position** | Position badge in one of the corners of a link or button. | `'top-start'` \| `'top-end'` \| `'bottom-end'` \| `'bottom-start'` | - |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/api/CButton.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import CButton from '@coreui/react/src/components/button/CButton'
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **active** | Toggle the active state for the component. | `boolean` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'button')` \| `(ElementType & 'cite')` \| `(ElementType & 'data')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | button |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'button')` \| `(ElementType & 'cite')` \| `(ElementType & 'data')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | button |
| **className** | A string of all className you want applied to the base component. | `string` | - |
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | - |
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/api/CCardHeader.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CCardHeader from '@coreui/react/src/components/card/CCardHeader'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **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')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **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<...>)` | - |
| **className** | A string of all className you want applied to the base component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CCardImage.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ import CCardImage from '@coreui/react/src/components/card/CCardImage'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'img')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'img')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the base component. | `string` | - |
| **orientation** | Optionally orientate the image to the top, bottom, or make it overlaid across the card. | `'top'` \| `'bottom'` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CCardSubtitle.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CCardSubtitle from '@coreui/react/src/components/card/CCardSubtitle'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h6')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h6')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CCardText.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CCardText from '@coreui/react/src/components/card/CCardText'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'p')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'p')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CCardTitle.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CCardTitle from '@coreui/react/src/components/card/CCardTitle'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h5')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h5')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CDropdown.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import CDropdown from '@coreui/react/src/components/dropdown/CDropdown'
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **alignment** | Set aligment of dropdown menu. | `'start'` \| `'end'` \| `{ xs: 'start'` \| `'end' }` \| `{ sm: 'start'` \| `'end' }` \| `{ md: 'start'` \| `'end' }` \| `{ lg: 'start'` \| `'end' }` \| `{ xl: 'start'` \| `'end'}` \| `{ xxl: 'start'` \| `'end'}` | - |
| **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')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | div |
| **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 |
| **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 |
| **className** | A string of all className you want applied to the base component. | `string` | - |
| **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` \| `(() => Element)` | - |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/api/CDropdownHeader.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CDropdownHeader from '@coreui/react/src/components/dropdown/CDropdownHead

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h6')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'h6')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CDropdownItem.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import CDropdownItem from '@coreui/react/src/components/dropdown/CDropdownItem'
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **active** | Toggle the active state for the component. | `boolean` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'a')` \| `(ElementType & 'cite')` \| `(ElementType & 'data')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | a |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'a')` \| `(ElementType & 'cite')` \| `(ElementType & 'data')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | a |
| **className** | A string of all className you want applied to the component. | `string` | - |
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
| **href** | The href attribute specifies the URL of the page the link goes to. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CDropdownItemPlain.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CDropdownItemPlain from '@coreui/react/src/components/dropdown/CDropdownI

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CDropdownMenu.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CDropdownMenu from '@coreui/react/src/components/dropdown/CDropdownMenu'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'ul')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'ul')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the base component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CDropdownToggle.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import CDropdownToggle from '@coreui/react/src/components/dropdown/CDropdownTogg
| **custom** | Create a custom toggler which accepts any content. | `boolean` | - |
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
| **href** | The href attribute specifies the URL of the page the link goes to. | `string` | - |
| **navLink** **_v5.0.0-rc.1+_** | If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | `boolean` | true |
| **navLink** **_v5.0.0-rc.2+_** | If a dropdown `variant` is set to `nav-item` then render the toggler as a link instead of a button. | `boolean` | true |
| **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` | - |
| **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` | - |
| **size** | Size the component small or large. | `'sm'` \| `'lg'` | - |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/api/CFormFeedback.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CFormFeedback from '@coreui/react/src/components/form/CFormFeedback'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **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')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **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<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
| **invalid** | Method called immediately after the `value` prop changes. | `boolean` | - |
| **tooltip** | If your form layout allows it, you can display validation feedback in a styled tooltip. | `boolean` | - |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/content/api/CFormText.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CFormText from '@coreui/react/src/components/form/CFormText'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **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')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **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<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CHeaderBrand.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CHeaderBrand from '@coreui/react/src/components/header/CHeaderBrand'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'a')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'a')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CHeaderNav.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CHeaderNav from '@coreui/react/src/components/header/CHeaderNav'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'ul')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'ul')` \| `(ElementType & 'slot')` \| `(ElementType & 'style')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
2 changes: 1 addition & 1 deletion packages/docs/content/api/CInputGroupText.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ import CInputGroupText from '@coreui/react/src/components/form/CInputGroupText'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'form')` \| `(ElementType & 'slot')` \| `... 173 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **as** | Component used for the root node. Either a string to use a HTML element or a component. | `(ElementType & 'symbol')` \| `(ElementType & 'object')` \| `(ElementType & 'span')` \| `(ElementType & 'form')` \| `(ElementType & 'slot')` \| `... 174 more ...` \| `(ElementType & FunctionComponent<...>)` | - |
| **className** | A string of all className you want applied to the component. | `string` | - |
Loading

0 comments on commit 504e892

Please sign in to comment.