Skip to content

Commit a88ef96

Browse files
mrholekmrholek
committed
docs: update API documantation
1 parent f8ddcdb commit a88ef96

10 files changed

+53
-53
lines changed

‎packages/docs/content/api/CCarousel.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ import CCarousel from '@coreui/react/src/components/carousel/CCarousel'
1616
| **onSlid** | Callback fired when a slide transition end. | `(active: number, direction: string) => void` | - |
1717
| **onSlide** | Callback fired when a slide transition starts. | `(active: number, direction: string) => void` | - |
1818
| **pause** | If set to 'hover', pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to false, hovering over the carousel won't pause it. | `boolean` \| `'hover'` | hover |
19-
| **touch** <br/><div class="badge bg-primary">4.5.0+</div> | Set whether the carousel should support left/right swipe interactions on touchscreen devices. | `boolean` | true |
19+
| **touch** **_4.5.0+_** | Set whether the carousel should support left/right swipe interactions on touchscreen devices. | `boolean` | true |
2020
| **transition** | Set type of the transition. | `'slide'` \| `'crossfade'` | - |
2121
| **wrap** | Set whether the carousel should cycle continuously or have hard stops. | `boolean` | true |

‎packages/docs/content/api/CFormCheck.api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ import CFormCheck from '@coreui/react/src/components/form/CFormCheck'
99
| --- | --- | --- | --- |
1010
| **button** | Create button-like checkboxes and radio buttons. | `ButtonObject` | - |
1111
| **className** | A string of all className you want applied to the component. | `string` | - |
12-
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
13-
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
14-
| **feedbackValid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
15-
| **floatingLabel** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
12+
| **feedback** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
13+
| **feedbackInvalid** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
14+
| **feedbackValid** **_4.2.0+_** | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
15+
| **floatingLabel** **_4.2.0+_** | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
1616
| **hitArea** | Sets hit area to the full area of the component. | `'full'` | - |
1717
| **id** | The id global attribute defines an identifier (ID) that must be unique in the whole document. | `string` | - |
1818
| **indeterminate** | Input Checkbox indeterminate Property. | `boolean` | - |
1919
| **inline** | Group checkboxes or radios on the same horizontal row by adding. | `boolean` | - |
2020
| **invalid** | Set component validation state to invalid. | `boolean` | - |
2121
| **label** | The element represents a caption for a component. | `ReactNode` | - |
22-
| **tooltipFeedback** <br/><div class="badge bg-primary">4.2.0+</div> | Display validation feedback in a styled tooltip. | `boolean` | - |
22+
| **tooltipFeedback** **_4.2.0+_** | Display validation feedback in a styled tooltip. | `boolean` | - |
2323
| **type** | Specifies the type of component. | `'checkbox'` \| `'radio'` | checkbox |
2424
| **valid** | Set component validation state to valid. | `boolean` | - |

‎packages/docs/content/api/CFormControlValidation.api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ import CFormControlValidation from '@coreui/react/src/components/form/CFormContr
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10-
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
11-
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
12-
| **feedbackValid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
13-
| **floatingLabel** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
10+
| **feedback** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
11+
| **feedbackInvalid** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
12+
| **feedbackValid** **_4.2.0+_** | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
13+
| **floatingLabel** **_4.2.0+_** | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
1414
| **invalid** | Set component validation state to invalid. | `boolean` | - |
15-
| **tooltipFeedback** <br/><div class="badge bg-primary">4.2.0+</div> | Display validation feedback in a styled tooltip. | `boolean` | - |
15+
| **tooltipFeedback** **_4.2.0+_** | Display validation feedback in a styled tooltip. | `boolean` | - |
1616
| **valid** | Set component validation state to valid. | `boolean` | - |

‎packages/docs/content/api/CFormControlWrapper.api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import CFormControlWrapper from '@coreui/react/src/components/form/CFormControlW
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10-
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
11-
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
12-
| **feedbackValid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
13-
| **floatingClassName** <br/><div class="badge bg-primary">4.5.0+</div> | A string of all className you want applied to the floating label wrapper. | `string` | - |
14-
| **floatingLabel** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
10+
| **feedback** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
11+
| **feedbackInvalid** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
12+
| **feedbackValid** **_4.2.0+_** | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
13+
| **floatingClassName** **_4.5.0+_** | A string of all className you want applied to the floating label wrapper. | `string` | - |
14+
| **floatingLabel** **_4.2.0+_** | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
1515
| **invalid** | Set component validation state to invalid. | `boolean` | - |
16-
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |
17-
| **text** <br/><div class="badge bg-primary">4.2.0+</div> | Add helper text to the component. | `ReactNode` | - |
18-
| **tooltipFeedback** <br/><div class="badge bg-primary">4.2.0+</div> | Display validation feedback in a styled tooltip. | `boolean` | - |
16+
| **label** **_4.2.0+_** | Add a caption for a component. | `ReactNode` | - |
17+
| **text** **_4.2.0+_** | Add helper text to the component. | `ReactNode` | - |
18+
| **tooltipFeedback** **_4.2.0+_** | Display validation feedback in a styled tooltip. | `boolean` | - |
1919
| **valid** | Set component validation state to valid. | `boolean` | - |

‎packages/docs/content/api/CFormInput.api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ import CFormInput from '@coreui/react/src/components/form/CFormInput'
1010
| **className** | A string of all className you want applied to the component. | `string` | - |
1111
| **delay** | Delay onChange event while typing. If set to true onChange event will be delayed 500ms, you can also provide the number of milliseconds you want to delay the onChange event. | `number` \| `boolean` | false |
1212
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
13-
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
14-
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
15-
| **feedbackValid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
16-
| **floatingClassName** <br/><div class="badge bg-primary">4.5.0+</div> | A string of all className you want applied to the floating label wrapper. | `string` | - |
17-
| **floatingLabel** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
13+
| **feedback** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
14+
| **feedbackInvalid** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
15+
| **feedbackValid** **_4.2.0+_** | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
16+
| **floatingClassName** **_4.5.0+_** | A string of all className you want applied to the floating label wrapper. | `string` | - |
17+
| **floatingLabel** **_4.2.0+_** | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
1818
| **invalid** | Set component validation state to invalid. | `boolean` | - |
19-
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |
19+
| **label** **_4.2.0+_** | Add a caption for a component. | `ReactNode` | - |
2020
| **onChange** | Method called immediately after the `value` prop changes. | `ChangeEventHandler<HTMLInputElement>` | - |
2121
| **plainText** | Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly` | `boolean` | - |
2222
| **readOnly** | Toggle the readonly state for the component. | `boolean` | - |
2323
| **size** | Size the component small or large. | `'sm'` \| `'lg'` | - |
24-
| **text** <br/><div class="badge bg-primary">4.2.0+</div> | Add helper text to the component. | `ReactNode` | - |
25-
| **tooltipFeedback** <br/><div class="badge bg-primary">4.2.0+</div> | Display validation feedback in a styled tooltip. | `boolean` | - |
24+
| **text** **_4.2.0+_** | Add helper text to the component. | `ReactNode` | - |
25+
| **tooltipFeedback** **_4.2.0+_** | Display validation feedback in a styled tooltip. | `boolean` | - |
2626
| **type** | Specifies the type of component. | `string` | text |
2727
| **valid** | Set component validation state to valid. | `boolean` | - |
2828
| **value** | The `value` attribute of component. | `string` \| `number` \| `string[]` | - |

‎packages/docs/content/api/CFormRange.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import CFormRange from '@coreui/react/src/components/form/CFormRange'
99
| --- | --- | --- | --- |
1010
| **className** | A string of all className you want applied to the component. | `string` | - |
1111
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
12-
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |
12+
| **label** **_4.2.0+_** | Add a caption for a component. | `ReactNode` | - |
1313
| **max** | Specifies the maximum value for the component. | `number` | - |
1414
| **min** | Specifies the minimum value for the component. | `number` | - |
1515
| **onChange** | Method called immediately after the `value` prop changes. | `ChangeEventHandler<HTMLInputElement>` | - |

‎packages/docs/content/api/CFormSelect.api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ import CFormSelect from '@coreui/react/src/components/form/CFormSelect'
88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
1010
| **className** | A string of all className you want applied to the component. | `string` | - |
11-
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
12-
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
13-
| **feedbackValid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
14-
| **floatingClassName** <br/><div class="badge bg-primary">4.5.0+</div> | A string of all className you want applied to the floating label wrapper. | `string` | - |
15-
| **floatingLabel** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
11+
| **feedback** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
12+
| **feedbackInvalid** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
13+
| **feedbackValid** **_4.2.0+_** | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
14+
| **floatingClassName** **_4.5.0+_** | A string of all className you want applied to the floating label wrapper. | `string` | - |
15+
| **floatingLabel** **_4.2.0+_** | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
1616
| **htmlSize** | Specifies the number of visible options in a drop-down list. | `number` | - |
1717
| **invalid** | Set component validation state to invalid. | `boolean` | - |
18-
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |
18+
| **label** **_4.2.0+_** | Add a caption for a component. | `ReactNode` | - |
1919
| **onChange** | Method called immediately after the `value` prop changes. | `ChangeEventHandler<HTMLSelectElement>` | - |
2020
| **options** | Options list of the select component. Available keys: `label`, `value`, `disabled`.<br/>Examples:<br/>- `options={[{ value: 'js', label: 'JavaScript' }, { value: 'html', label: 'HTML', disabled: true }]}`<br/>- `options={['js', 'html']}` | `Option[]` \| `string[]` | - |
2121
| **size** | Size the component small or large. | `'sm'` \| `'lg'` | - |
22-
| **text** <br/><div class="badge bg-primary">4.2.0+</div> | Add helper text to the component. | `ReactNode` | - |
23-
| **tooltipFeedback** <br/><div class="badge bg-primary">4.2.0+</div> | Display validation feedback in a styled tooltip. | `boolean` | - |
22+
| **text** **_4.2.0+_** | Add helper text to the component. | `ReactNode` | - |
23+
| **tooltipFeedback** **_4.2.0+_** | Display validation feedback in a styled tooltip. | `boolean` | - |
2424
| **valid** | Set component validation state to valid. | `boolean` | - |
2525
| **value** | The `value` attribute of component. | `string` \| `number` \| `string[]` | - |

‎packages/docs/content/api/CFormTextarea.api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ import CFormTextarea from '@coreui/react/src/components/form/CFormTextarea'
99
| --- | --- | --- | --- |
1010
| **className** | A string of all className you want applied to the component. | `string` | - |
1111
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
12-
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
13-
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
14-
| **feedbackValid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
15-
| **floatingClassName** <br/><div class="badge bg-primary">4.5.0+</div> | A string of all className you want applied to the floating label wrapper. | `string` | - |
16-
| **floatingLabel** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
12+
| **feedback** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
13+
| **feedbackInvalid** **_4.2.0+_** | Provide valuable, actionable feedback. | `ReactNode` | - |
14+
| **feedbackValid** **_4.2.0+_** | Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
15+
| **floatingClassName** **_4.5.0+_** | A string of all className you want applied to the floating label wrapper. | `string` | - |
16+
| **floatingLabel** **_4.2.0+_** | Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, `:invalid` and `:valid`. | `ReactNode` | - |
1717
| **invalid** | Set component validation state to invalid. | `boolean` | - |
18-
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |
18+
| **label** **_4.2.0+_** | Add a caption for a component. | `ReactNode` | - |
1919
| **onChange** | Method called immediately after the `value` prop changes. | `ChangeEventHandler<HTMLTextAreaElement>` | - |
2020
| **plainText** | Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side `readonly`. | `boolean` | - |
2121
| **readOnly** | Toggle the readonly state for the component. | `boolean` | - |
22-
| **text** <br/><div class="badge bg-primary">4.2.0+</div> | Add helper text to the component. | `ReactNode` | - |
23-
| **tooltipFeedback** <br/><div class="badge bg-primary">4.2.0+</div> | Display validation feedback in a styled tooltip. | `boolean` | - |
22+
| **text** **_4.2.0+_** | Add helper text to the component. | `ReactNode` | - |
23+
| **tooltipFeedback** **_4.2.0+_** | Display validation feedback in a styled tooltip. | `boolean` | - |
2424
| **valid** | Set component validation state to valid. | `boolean` | - |
2525
| **value** | The `value` attribute of component. | `string` \| `number` \| `string[]` | - |

‎packages/docs/content/api/CIcon.api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ import CIcon from '@coreui/icons-react/src/CIcon'
88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
1010
| **className** | A string of all className you want applied to the component. | `string` | - |
11-
| **content** <br/><div class="badge bg-warning">Deprecated 3.0+</div> | Use `icon={...}` instead of | `string` \| `string[]` | - |
11+
| **content** **_Deprecated 3.0+_** | Use `icon={...}` instead of | `string` \| `string[]` | - |
1212
| **customClassName** | Use for replacing default CIcon component classes. Prop is overriding the 'size' prop. | `string` \| `object` \| `string[]` | - |
1313
| **height** | The height attribute defines the vertical length of an icon. | `number` | - |
1414
| **icon** | Name of the icon placed in React object or SVG content. | `string` \| `string[]` | - |
15-
| **name** <br/><div class="badge bg-warning">Deprecated 3.0+</div> | Use `icon="..."` instead of | `string` | - |
15+
| **name** **_Deprecated 3.0+_** | Use `icon="..."` instead of | `string` | - |
1616
| **size** | Size of the icon. Available sizes: 'sm', 'lg', 'xl', 'xxl', '3xl...9xl', 'custom', 'custom-size'. | `'custom'` \| `'custom-size'` \| `'sm'` \| `'lg'` \| `'xl'` \| `'xxl'` \| `'3xl'` \| `'4xl'` \| `'5xl'` \| `'6xl'` \| `'7xl'` \| `'8xl'` \| `'9xl'` | - |
1717
| **title** | Title tag content. | `string` | - |
1818
| **use** | If defined component will be rendered using 'use' tag. | `string` | - |

0 commit comments

Comments
 (0)