8000 docs: update API and docs · HelloLeoLyn/coreui-vue@30a98e3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 30a98e3

Browse files
mrholekmrholek
committed
docs: update API and docs
1 parent 3b3f9d3 commit 30a98e3

File tree

126 files changed

+698
-214
lines changed

Some content is hidden

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

126 files changed

+698
-214
lines changed

‎docs/.vuepress/config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const path = require('path')
99
export default defineUserConfig<DefaultThemeOptions>({
1010
base: `/vue/docs/${pkg.config.version_short}/`,
1111
lang: 'en-US',
12-
title: 'CoreUI for Vue.js',
12+
title: 'Vue UI Components · CoreUI',
1313
description: 'UI Components Library for Vue.js (Vue 3)',
1414
head: [
1515
// ['link', { rel: 'icon', href: '/logo.png' }],
@@ -228,8 +228,8 @@ export default defineUserConfig<DefaultThemeOptions>({
228228
link: `/components/modal.html`,
229229
},
230230
{
231-
text: 'Nav',
232-
link: `/components/nav.html`,
231+
text: 'Navs & Tabs',
232+
link: `/components/navs-tabs.html`,
233233
},
234234
{
235235
text: 'Navbar',

‎docs/.vuepress/theme-coreui/src/client/styles/_table-api.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
td:nth-child(5n) {
2222
width: 10%;
2323
}
24+
25+
& + h3 {
26+
margin-top: 2rem;
27+
}
2428
}
2529

2630
.markdown + h3 {

‎docs/api/accordion/CAccordion.api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
### CAccordion
22

3+
```jsx
4+
import { CAccordion } from '@coreui/vue'
5+
// or
6+
import CAccordion from '@coreui/vue/src/components/accordion/CAccordion'
7+
```
8+
39
#### Props
410

511
| Prop name | Description | Type | Values | Default |
612
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------ | ------- |
713
| **activeItemKey** | The active item key. | number\|string | - | - 10000 |
814
| **alwaysOpen** | Make accordion items stay open when another item is opened | boolean | - | |
915
| **flush** | Removes the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container. | boolean | - | |
10-
11-
---

‎docs/api/accordion/CAccordionBody.api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
### CAccordionBody
22

3-
---
3+
```jsx
4+
import { CAccordionBody } from '@coreui/vue'
5+
// or
6+
import CAccordionBody from '@coreui/vue/src/components/accordion/CAccordionBody'
7+
```

‎docs/api/accordion/CAccordionButton.api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
### CAccordionButton
22

3-
---
3+
```jsx
4+
import { CAccordionButton } from '@coreui/vue'
5+
// or
6+
import CAccordionButton from '@coreui/vue/src/components/accordion/CAccordionButton'
7+
```

‎docs/api/accordion/CAccordionCollapse.api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
### CAccordionCollapse
22

3+
```jsx
4+
import { CAccordionCollapse } from '@coreui/vue'
5+
// or
6+
import CAccordionCollapse from '@coreui/vue/src/components/accordion/CAccordionCollapse'
7+
```
8+
39
#### Props
410

511
| Prop name | Description | Type | Values | Default |
612
| ----------- | ----------------------------------- | ------- | ------ | ------- |
713
| **visible** | Toggle the visibility of component. | boolean | - | |
8-
9-
---

‎docs/api/accordion/CAccordionHeader.api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
### CAccordionHeader
22

3-
---
3+
```jsx
4+
import { CAccordionHeader } from '@coreui/vue'
5+
// or
6+
import CAccordionHeader from '@coreui/vue/src/components/accordion/CAccordionHeader'
7+
```

‎docs/api/accordion/CAccordionItem.api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
### CAccordionItem
22

3+
```jsx
4+
import { CAccordionItem } from '@coreui/vue'
5+
// or
6+
import CAccordionItem from '@coreui/vue/src/components/accordion/CAccordionItem'
7+
```
8+
39
#### Props
410

511
| Prop name | Description | Type | Values | Default |
612
| ----------- | ------------- | -------------- | ------ | ------- |
713
| **itemKey** | The item key. | number\|string | - | - |
8-
9-
---

‎docs/api/alert/CAlert.api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
### CAlert
22

3+
```jsx
4+
import { CAlert } from '@coreui/vue'
5+
// or
6+
import CAlert from '@coreui/vue/src/components/alert/CAlert'
7+
```
8+
39
#### Props
410

511
| Prop name | Description | Type | Values | Default |
@@ -14,5 +20,3 @@
1420
| Event name | Description | Properties |
1521
| ---------- | -------------------------------------------------------- | ---------- |
1622
| **close** | Callback fired when the component requests to be closed. |
17-
18-
---

‎docs/api/alert/CAlertHeading.api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
### CAlertHeading
22

3+
```jsx
4+
import { CAlertHeading } from '@coreui/vue'
5+
// or
6+
import CAlertHeading from '@coreui/vue/src/components/alert/CAlertHeading'
7+
```
8+
39
#### Props
410

511
| Prop name | Description | Type | Values | Default |
612
| ------------- | --------------------------------------------------------------------------------------- | ------ | ------ | ------- |
713
| **component** | Component used for the root node. Either a string to use a HTML element or a component. | string | - | 'h4' |
8-
9-
---

0 commit comments

Comments
 (0)
0