8000 docs: update API documentation · mastercodekw/coreui-react@d26aa5f · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit d26aa5f

Browse files
mrholekmrholek
committed
docs: update API documentation
1 parent 9fb7777 commit d26aa5f

File tree

8 files changed

+13
-2
lines changed

8 files changed

+13
-2
lines changed

‎packages/coreui-react/src/components/carousel/CCarousel.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export interface CCarouselProps extends HTMLAttributes<HTMLDivElement> {
5252
*/
5353
pause?: boolean | 'hover'
5454
/**
55-
* Whether the carousel should support left/right swipe interactions on touchscreen devices.
55+
* Set whether the carousel should support left/right swipe interactions on touchscreen devices.
5656
*
5757
* @since 4.5.0
5858
*/

‎packages/coreui-react/src/components/form/CFormControlWrapper.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export interface CFormControlWrapperProps extends CFormControlValidationProps {
1515
/**
1616
* A string of all className you want applied to the floating label wrapper.
1717
*
18-
* @since 4.3.0
18+
* @since 4.5.0
1919
*/
2020
floatingClassName?: string
2121
/**

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +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 |
1920
| **transition** | Set type of the transition. | `'slide'` \| `'crossfade'` | - |
2021
| **wrap** | Set whether the carousel should cycle continuously or have hard stops. | `boolean` | true |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import CFormControlWrapper from '@coreui/react/src/components/form/CFormControlW
1010
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1111
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1212
| **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` | - |
1314
| **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` | - |
1415
| **invalid** | Set component validation state to invalid. | `boolean` | - |
1516
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import CFormInput from '@coreui/react/src/components/form/CFormInput'
1313
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1414
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1515
| **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` | - |
1617
| **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` | - |
1718
| **invalid** | Set component validation state to invalid. | `boolean` | - |
1819
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import CFormSelect from '@coreui/react/src/components/form/CFormSelect'
1111
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1212
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1313
| **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` | - |
1415
| **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` | - |
1516
| **htmlSize** | Specifies the number of visible options in a drop-down list. | `number` | - |
1617
| **invalid** | Set component validation state to invalid. | `boolean` | - |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import CFormTextarea from '@coreui/react/src/components/form/CFormTextarea'
1212
| **feedback** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1313
| **feedbackInvalid** <br/><div class="badge bg-primary">4.2.0+</div> | Provide valuable, actionable feedback. | `ReactNode` | - |
1414
| **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` | - |
1516
| **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` | - |
1617
| **invalid** | Set component validation state to invalid. | `boolean` | - |
1718
| **label** <br/><div class="badge bg-primary">4.2.0+</div> | Add a caption for a component. | `ReactNode` | - |

‎packages/docs/content/4.4/api/CToastClose.api.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ import CToastClose from '@coreui/react/src/components/toast/CToastClose'
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10+
| **active** | Toggle the active state for the component. | `boolean` | - |
1011
| **className** | A string of all className you want applied to the base component. | `string` | - |
1112
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | `string` \| `ComponentClass<any, any>` \| `FunctionComponent<any>` | - |
1213
| **disabled** | Toggle the disabled state for the component. | `boolean` | - |
14+
| **href** | The href attribute specifies the URL of the page the link goes to. | `string` | - |
15+
| **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` | - |
16+
| **size** | Size the component small or large. | `'sm'` \| `'lg'` | - |
17+
| **type** | Specifies the type of button. Always specify the type attribute for the `<button>` element.<br/>Different browsers may use different default types for the `<button>` element. | `'button'` \| `'submit'` \| `'reset'` | - |
18+
| **variant** | Set the button variant to an outlined button or a ghost button. | `'outline'` \| `'ghost'` | - |
1319
| **white** | Change the default color to white. | `boolean` | - |

0 commit comments

Comments
 (0)
0