Skip to content

Commit bff969c

Browse files
webdevnerdstuffwebdevnerdstuff
committed
Adding documentation
1 parent a843ed9 commit bff969c

File tree

11 files changed

+687
-259
lines changed

11 files changed

+687
-259
lines changed

‎src/documentation/components/PropsTable.vue‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<template>
2+
<v-col cols="12">
3+
<v-row :id="sectionId">
4+
<v-col cols="12">
5+
<h3 :class="classes.h3">
6+
<a
7+
:class="classes.headerA"
8+
:href="`#${sectionId}`"
9+
>#</a>
10+
{{ sectionTitle }}
11+
</h3>
12+
<div
13+
v-if="subtitle"
14+
v-html="subtitle"
15+
></div>
16+
</v-col>
17+
</v-row>
18+
19+
<v-row>
20+
<v-col cols="12">
21+
<v-card>
22+
<v-card-title>
23+
<v-text-field
24+
v-model="search"
25+
append-icon="mdi:mdi-magnify"
26+
hide-details
27+
label="Search"
28+
single-line
29+
variant="underlined"
30+
></v-text-field>
31+
</v-card-title>
32+
33+
<v-data-table
34+
:headers="headers"
35+
hide-default-footer
36+
:items="items"
37+
:items-per-page="-1"
38+
:search="search"
39+
:sort-by="[{ key: 'name', order: 'asc' }]"
40+
>
41+
<template #[`item.name`]="{ item }">
42+
<td>
43+
<span
44+
:id="`props-${sectionId ? `${sectionId}-${item.raw.name}` : item.raw.name}`"
45+
class="name-item text-mono ml-n2"
46+
>
47+
<span class="text-primary">#</span>
48+
<a
49+
class="text-primary"
50+
:class="classes.appLink"
51+
:href="`#props-${sectionId ? `${sectionId}-${item.raw.name}` : item.raw.name}`"
52+
>{{ item.raw.name }}</a>
53+
</span>
54+
</td>
55+
</template>
56+
57+
<template #[`item.type`]="{ item }">
58+
<td class="text-success">
59+
{{ item.raw.type }}
60+
</td>
61+
</template>
62+
63+
<template #[`item.default`]="{ item }">
64+
<td
65+
class="text-accent"
66+
v-html="item.raw.default"
67+
></td>
68+
</template>
69+
70+
<template #[`item.desc`]="{ item }">
71+
<td v-html="item.raw.desc"></td>
72+
</template>
73+
</v-data-table>
74+
</v-card>
75+
</v-col>
76+
</v-row>
77+
</v-col>
78+
</template>
79+
80+
<script setup>
81+
import { inject } from 'vue';
82+
83+
84+
const classes = inject('classes');
85+
86+
defineProps({
87+
headers: {
88+
default: () => [],
89+
type: Array,
90+
},
91+
items: {
92+
default: () => [],
93+
type: Array,
94+
},
95+
sectionId: {
96+
default: '',
97+
type: String,
98+
},
99+
sectionTitle: {
100+
default: null,
101+
type: String,
102+
},
103+
subtitle: {
104+
default: null,
105+
type: String,
106+
},
107+
});
108+
109+
const search = ref('');
110+
</script>
111+
112+
<style lang="scss" scoped>
113+
</style>

‎src/documentation/sections/DependenciesComponent.vue‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,23 @@
1818
<a
1919
:href="store.links.vuetify"
2020
target="_blank"
21-
>Vuetify v3</a>
21+
>
22+
Vuetify v3
23+
</a>
2224
<br />
2325
<a
2426
:href="store.links.vue"
2527
target="_blank"
26-
>Vue 3</a>
28+
>
29+
Vue 3
30+
</a>
31+
<br />
32+
<a
33+
:href="store.links.vueUse"
34+
target="_blank"
35+
>
36+
VueUse
37+
</a>
2738
</v-col>
2839
</v-row>
2940
</v-col>
@@ -34,7 +45,7 @@
3445
import { inject } from 'vue';
3546
import { useCoreStore } from '@/stores/index';
3647
37-
const classes = inject('classes');
3848
49+
const classes = inject('classes');
3950
const store = useCoreStore();
4051
</script>

‎src/documentation/sections/DescriptionComponent.vue‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
<script setup>
2626
import { inject } from 'vue';
2727
28+
2829
const classes = inject('classes');
2930
const links = inject('links');
3031
</script>

‎src/documentation/sections/EventsComponent.vue‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@
1313
Events
1414
</h2>
1515

16+
For component specific events, please refer to the <a
17+
:href="store.links.vuetify"
18+
target="_blank"
19+
>Vuetify</a> documentation.
20+
</v-col>
21+
22+
<v-col cols="12">
1623
<v-row>
1724
<v-col cols="12">
1825
<v-card>
@@ -65,8 +72,11 @@
6572

6673
<script setup>
6774
import { inject, ref } from 'vue';
75+
import { useCoreStore } from '@/stores/index';
76+
6877
6978
const classes = inject('classes');
79+
const store = useCoreStore();
7080
7181
const headers = [
7282
{
@@ -75,7 +85,7 @@ const headers = [
7585
key: 'name',
7686
sortable: false,
7787
title: 'Name',
78-
width: '15%',
88+
width: '20%',
7989
},
8090
{
8191
align: 'start',
@@ -87,8 +97,20 @@ const headers = [
8797
];
8898
const items = [
8999
{
90-
desc: 'TBD',
91-
name: 'TBD',
100+
desc: 'Emitted when an error occurs',
101+
name: 'error',
102+
},
103+
{
104+
desc: 'Emitted when the loading state changes',
105+
name: 'loading',
106+
},
107+
{
108+
desc: 'Emitted when the save button is clicked',
109+
name: 'update',
110+
},
111+
{
112+
desc: 'Emitted when the close siblings event is triggered',
113+
name: 'update:closeSiblingFields',
92114
},
93115
];
94116
const search = ref('');

‎src/documentation/sections/ExampleComponent.vue‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,6 @@
2525
<script setup>
2626
import { inject } from 'vue';
2727
28+
2829
const classes = inject('classes');
2930
</script>

‎src/documentation/sections/LegalComponent.vue‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,6 @@
2828
<script setup>
2929
import { inject } from 'vue';
3030
31+
3132
const classes = inject('classes');
3233
</script>

‎src/documentation/sections/LicenseComponent.vue‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
import { inject } from 'vue';
3939
import { useCoreStore } from '@/stores/index';
4040
41+
4142
const classes = inject('classes');
4243
4344
const store = useCoreStore();

0 commit comments

Comments
 (0)