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 Jun 28, 2023
1 parent 79d0f2a commit 616a60d
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 7 deletions.
3 changes: 2 additions & 1 deletion packages/docs/content/api/CDropdown.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import CDropdown from '@coreui/react/src/components/dropdown/CDropdown'
| **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 |
| **dark** | Sets a darker color scheme to match a dark navbar. | `boolean` | - |
| **direction** | Sets a specified direction and location of the dropdown menu. | `'center'` \| `'dropup'` \| `'dropup-center'` \| `'dropend'` \| `'dropstart'` | - |
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
| **offset** | Offset of the dropdown menu relative to its target. | `[number, number]` | [0, 2] |
| **onHide** **_4.9.0-beta.2+_** | Callback fired when the component requests to be hidden. | `() => void` | - |
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
| **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 |
| **popper** | If you want to disable dynamic positioning set this property to `true`. | `boolean` | true |
Expand Down
5 changes: 4 additions & 1 deletion packages/docs/content/api/CPopover.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ import CPopover from '@coreui/react/src/components/popover/CPopover'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **animation** **_4.9.0-beta.2+_** | Apply a CSS fade transition to the popover. | `boolean` | true |
| **className** | A string of all className you want applied to the component. | `string` | - |
| **content** | Content node for your component. | `ReactNode` | - |
| **delay** **_4.9.0-beta.2+_** | 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 |
| **fallbackPlacements** **_4.9.0-beta.2+_** | 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'] |
| **offset** | Offset of the popover relative to its target. | `[number, number]` | [0, 8] |
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
| **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 |
| **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 |
| **title** | Title node for your component. | `ReactNode` | - |
| **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 |
| **visible** | Toggle the visibility of popover component. | `boolean` | - |
3 changes: 2 additions & 1 deletion packages/docs/content/api/CProgress.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ import CProgress from '@coreui/react/src/components/progress/CProgress'
| **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` | - |
| **height** | Sets the height of the component. If you set that value the inner `<CProgressBar>` will automatically resize accordingly. | `number` | - |
| **progressBarClassName** **_4.9.0+_** | A string of all className you want applied to the `<CProgressBar/>` component. | `string` | - |
| **thin** | Makes progress bar thinner. | `boolean` | - |
| **value** | The percent to progress the ProgressBar (out of 100). | `number` | 0 |
| **value** | The percent to progress the ProgressBar (out of 100). | `number` | - |
| **variant** | Set the progress bar variant to optional striped. | `'striped'` | - |
| **white** | Change the default color to white. | `boolean` | - |
10 changes: 10 additions & 0 deletions packages/docs/content/api/CProgressStacked.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

```jsx
import { CProgressStacked } from '@coreui/react'
// or
import CProgressStacked from '@coreui/react/src/components/progress/CProgressStacked'
```

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **className** | A string of all className you want applied to the component. | `string` | - |
11 changes: 7 additions & 4 deletions packages/docs/content/api/CTooltip.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,14 @@ import CTooltip from '@coreui/react/src/components/tooltip/CTooltip'

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| **animation** **_4.9.0-beta.2+_** | Apply a CSS fade transition to the tooltip. | `boolean` | true |
| **className** | A string of all className you want applied to the component. | `string` | - |
| **content** | Content node for your component. | `ReactNode` | - |
| **offset** | Offset of the popover relative to its target. | `[number, number]` | [0, 0] |
| **delay** **_4.9.0-beta.2+_** | 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 |
| **fallbackPlacements** **_4.9.0-beta.2+_** | 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'] |
| **offset** | Offset of the tooltip relative to its target. | `[number, number]` | [0, 6] |
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
| **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 |
| **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 |
| **visible** | Toggle the visibility of popover component. | `boolean` | - |
| **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 |
| **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'] |
| **visible** | Toggle the visibility of tooltip component. | `boolean` | - |

0 comments on commit 616a60d

Please sign in to comment.