Skip to content

Commit c7a4ba5

Browse files
committed
docs: update API documentation
1 parent 999fd5c commit c7a4ba5

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

packages/docs/content/api/COffcanvas.api.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ import COffcanvas from '@coreui/react/src/components/offcanvas/COffcanvas'
77

88
| Property | Description | Type | Default |
99
| --- | --- | --- | --- |
10-
| **backdrop** | Apply a backdrop on body while offcanvas is open. | `boolean` | true |
10+
| **backdrop** | Apply a backdrop on body while offcanvas is open. | `boolean` \| `'static'` | true |
1111
| **className** | A string of all className you want applied to the base component. | `string` | - |
1212
| **keyboard** | Closes the offcanvas when escape key is pressed. | `boolean` | true |
1313
| **onHide** | Callback fired when the component requests to be hidden. | `() => void` | - |
1414
| **onShow** | Callback fired when the component requests to be shown. | `() => void` | - |
1515
| **placement** | Components placement, there’s no default placement. | `'start'` \| `'end'` \| `'top'` \| `'bottom'` | - |
16-
| **portal** | Generates modal using createPortal. | `boolean` | true |
16+
| **portal** | Generates modal using createPortal. | `boolean` | false |
17+
| **responsive** **_4.6.0+_** | Responsive offcanvas property hide content outside the viewport from a specified breakpoint and down. | `boolean` \| `'sm'` \| `'md'` \| `'lg'` \| `'xl'` \| `'xxl'` | true |
1718
| **scroll** | Allow body scrolling while offcanvas is open | `boolean` | false |
1819
| **visible** | Toggle the visibility of offcanvas component. | `boolean` | false |

packages/docs/content/api/CTable.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import CTable from '@coreui/react/src/components/table/CTable'
1616
| **className** | A string of all className you want applied to the component. | `string` | - |
1717
| **color** | Sets the color context of the component to one of CoreUI’s themed colors. | `'primary'` \| `'secondary'` \| `'success'` \| `'danger'` \| `'warning'` \| `'info'` \| `'dark'` \| `'light'` \| `string` | - |
1818
| **columns** **_4.3.0+_** | Prop for table columns configuration. If prop is not defined, table will display columns based on the first item keys, omitting keys that begins with underscore (e.g. '_props')<br/><br/>In columns prop each array item represents one column. Item might be specified in two ways:<br/>String: each item define column name equal to item value.<br/>Object: item is object with following keys available as column configuration:<br/>- key (required)(String) - define column name equal to item key.<br/>- label (String) - define visible label of column. If not defined, label will be generated automatically based on column name, by converting kebab-case and snake_case to individual words and capitalization of each word.<br/>- _props (Object) - adds classes to all cels in column, ex. `_props: { scope: 'col', className: 'custom-class' }`,<br/>- _style (Object) - adds styles to the column header (useful for defining widths) | `(string` \| `Column)[]` | - |
19-
| **footer** **_4.3.0+_** | Array of objects or strings, where each element represents one cell in the table footer.<br/><br/>Example items:<br/>`['FooterCell', 'FooterCell', 'FooterCell']`<br/>or<br/>`[{ label: 'FooterCell', _props: { color: 'success' }, ...]` | `FooterItem[]` | - |
19+
| **footer** **_4.3.0+_** | Array of objects or strings, where each element represents one cell in the table footer.<br/><br/>Example items:<br/>`['FooterCell', 'FooterCell', 'FooterCell']`<br/>or<br/>`[{ label: 'FooterCell', _props: { color: 'success' }, ...]` | `(string` \| `FooterItem)[]` | - |
2020
| **hover** | Enable a hover state on table rows within a `<CTableBody>`. | `boolean` | - |
2121
| **items** **_4.3.0+_** | Array of objects, where each object represents one item - row in table. Additionally, you can add style classes to each row by passing them by '_props' key and to single cell by '_cellProps'.<br/><br/>Example item:<br/>`{ name: 'John' , age: 12, _props: { color: 'success' }, _cellProps: { age: { className: 'fw-bold'}}}` | `Item[]` | - |
2222
| **responsive** | Make any table responsive across all viewports or pick a maximum breakpoint with which to have a responsive table up to. | `boolean` \| `'sm'` \| `'md'` \| `'lg'` \| `'xl'` \| `'xxl'` | - |
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
```jsx
3+
import { CTableCaption } from '@coreui/react'
4+
// or
5+
import CTableCaption from '@coreui/react/src/components/table/CTableCaption'
6+
```
7+

0 commit comments

Comments
 (0)