Skip to content

Commit fa15500

Browse files
committed
docs: update API documentation
1 parent a8ae68c commit fa15500

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+61
-61
lines changed

packages/docs/content/api/CAlertHeading.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CAlertHeading from '@coreui/react/src/components/alert/CAlertHeading'
1818
<tr id="calertheading-as">
1919
<td className="text-primary fw-semibold">as<a href="#calertheading-as" aria-label="CAlertHeading as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`h4`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'h4')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'h4')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CBadge.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CBadge from '@coreui/react/src/components/badge/CBadge'
1818
<tr id="cbadge-as">
1919
<td className="text-primary fw-semibold">as<a href="#cbadge-as" aria-label="CBadge as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`span`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'span')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'span')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CBreadcrumbItem.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import CBreadcrumbItem from '@coreui/react/src/components/breadcrumb/CBreadcrumb
2828
<tr id="cbreadcrumbitem-as">
2929
<td className="text-primary fw-semibold">as<a href="#cbreadcrumbitem-as" aria-label="CBreadcrumbItem as permalink" className="anchor-link after">#</a><span className="badge bg-success">5.4.0+</span></td>
3030
<td>-</td>
31-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'li')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
31+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'li')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
3232
</tr>
3333
<tr>
3434
<td colSpan="3">

packages/docs/content/api/CButton.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import CButton from '@coreui/react/src/components/button/CButton'
2828
<tr id="cbutton-as">
2929
<td className="text-primary fw-semibold">as<a href="#cbutton-as" aria-label="CButton as permalink" className="anchor-link after">#</a></td>
3030
<td><code>{`button`}</code></td>
31-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'button')`}</code>, <code>{`(ElementType & 'cite')`}</code>, <code>{`(ElementType & 'data')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
31+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'button')`}</code>, <code>{`(ElementType & 'cite')`}</code>, <code>{`(ElementType & 'data')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
3232
</tr>
3333
<tr>
3434
<td colSpan="3">

packages/docs/content/api/CCardHeader.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CCardHeader from '@coreui/react/src/components/card/CCardHeader'
1818
<tr id="ccardheader-as">
1919
<td className="text-primary fw-semibold">as<a href="#ccardheader-as" aria-label="CCardHeader as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`div`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'div')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'div')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CCardImage.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CCardImage from '@coreui/react/src/components/card/CCardImage'
1818
<tr id="ccardimage-as">
1919
<td className="text-primary fw-semibold">as<a href="#ccardimage-as" aria-label="CCardImage as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`img`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'img')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'img')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CCardSubtitle.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CCardSubtitle from '@coreui/react/src/components/card/CCardSubtitle'
1818
<tr id="ccardsubtitle-as">
1919
<td className="text-primary fw-semibold">as<a href="#ccardsubtitle-as" aria-label="CCardSubtitle as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`h6`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'h6')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'h6')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CCardText.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CCardText from '@coreui/react/src/components/card/CCardText'
1818
<tr id="ccardtext-as">
1919
<td className="text-primary fw-semibold">as<a href="#ccardtext-as" aria-label="CCardText as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`p`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'p')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'p')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CCardTitle.api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import CCardTitle from '@coreui/react/src/components/card/CCardTitle'
1818
<tr id="ccardtitle-as">
1919
<td className="text-primary fw-semibold">as<a href="#ccardtitle-as" aria-label="CCardTitle as permalink" className="anchor-link after">#</a></td>
2020
<td><code>{`h5`}</code></td>
21-
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'h5')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent\<...>)`}</code></td>
21+
<td><code>{`(ElementType & 'symbol')`}</code>, <code>{`(ElementType & 'object')`}</code>, <code>{`(ElementType & 'h5')`}</code>, <code>{`(ElementType & 'slot')`}</code>, <code>{`(ElementType & 'style')`}</code>, <code>{`... 174 more ...`}</code>, <code>{`(ElementType & FunctionComponent<...>)`}</code></td>
2222
</tr>
2323
<tr>
2424
<td colSpan="3">

packages/docs/content/api/CChart.api.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ import CChart from '@coreui/react-chartjs/src/CChart'
3838
<tr id="cchart-data">
3939
<td className="text-primary fw-semibold">data<a href="#cchart-data" aria-label="CChart data permalink" className="anchor-link after">#</a></td>
4040
<td>-</td>
41-
<td><code>{`ChartData\<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>`}</code>, <code>{`((canvas: HTMLCanvasElement) => ChartData\<...>)`}</code></td>
41+
<td><code>{`ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>`}</code>, <code>{`((canvas: HTMLCanvasElement) => ChartData<...>)`}</code></td>
4242
</tr>
4343
<tr>
4444
<td colSpan="3">
@@ -58,7 +58,7 @@ import CChart from '@coreui/react-chartjs/src/CChart'
5858
<tr id="cchart-get-dataset-at-event">
5959
<td className="text-primary fw-semibold">getDatasetAtEvent<a href="#cchart-get-dataset-at-event" aria-label="CChart getDatasetAtEvent permalink" className="anchor-link after">#</a></td>
6060
<td>-</td>
61-
<td><code>{`(dataset: InteractionItem[], event: MouseEvent\<HTMLCanvasElement, MouseEvent>) => void`}</code></td>
61+
<td><code>{`(dataset: InteractionItem[], event: MouseEvent<HTMLCanvasElement, MouseEvent>) => void`}</code></td>
6262
</tr>
6363
<tr>
6464
<td colSpan="3">
@@ -68,7 +68,7 @@ import CChart from '@coreui/react-chartjs/src/CChart'
6868
<tr id="cchart-get-element-at-event">
6969
<td className="text-primary fw-semibold">getElementAtEvent<a href="#cchart-get-element-at-event" aria-label="CChart getElementAtEvent permalink" className="anchor-link after">#</a></td>
7070
<td>-</td>
71-
<td><code>{`(element: InteractionItem[], event: MouseEvent\<HTMLCanvasElement, MouseEvent>) => void`}</code></td>
71+
<td><code>{`(element: InteractionItem[], event: MouseEvent<HTMLCanvasElement, MouseEvent>) => void`}</code></td>
7272
</tr>
7373
<tr>
7474
<td colSpan="3">
@@ -78,7 +78,7 @@ import CChart from '@coreui/react-chartjs/src/CChart'
7878
<tr id="cchart-get-elements-at-event">
7979
<td className="text-primary fw-semibold">getElementsAtEvent<a href="#cchart-get-elements-at-event" aria-label="CChart getElementsAtEvent permalink" className="anchor-link after">#</a></td>
8080
<td>-</td>
81-
<td><code>{`(elements: InteractionItem[], event: MouseEvent\<HTMLCanvasElement, MouseEvent>) => void`}</code></td>
81+
<td><code>{`(elements: InteractionItem[], event: MouseEvent<HTMLCanvasElement, MouseEvent>) => void`}</code></td>
8282
</tr>
8383
<tr>
8484
<td colSpan="3">
@@ -108,7 +108,7 @@ import CChart from '@coreui/react-chartjs/src/CChart'
108108
<tr id="cchart-options">
109109
<td className="text-primary fw-semibold">options<a href="#cchart-options" aria-label="CChart options permalink" className="anchor-link after">#</a></td>
110110
<td>-</td>
111-
<td><code>{`_DeepPartialObject\<CoreChartOptions\<keyof ChartTypeRegistry> & ElementChartOptions\<keyof ChartTypeRegistry> & PluginChartOptions\<...> & DatasetChartOptions\<...> & ScaleChartOptions\<...>>`}</code></td>
111+
<td><code>{`_DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<...> & DatasetChartOptions<...> & ScaleChartOptions<...>>`}</code></td>
112112
</tr>
113113
<tr>
114114
<td colSpan="3">
@@ -118,7 +118,7 @@ import CChart from '@coreui/react-chartjs/src/CChart'
118118
<tr id="cchart-plugins">
119119
<td className="text-primary fw-semibold">plugins<a href="#cchart-plugins" aria-label="CChart plugins permalink" className="anchor-link after">#</a></td>
120120
<td><code>{`[]`}</code></td>
121-
<td><code>{`Plugin\<keyof ChartTypeRegistry, AnyObject>[]`}</code></td>
121+
<td><code>{`Plugin<keyof ChartTypeRegistry, AnyObject>[]`}</code></td>
122122
</tr>
123123
<tr>
124124
<td colSpan="3">

0 commit comments

Comments
 (0)