Skip to content

Commit c95b16f

Browse files
Updating documentation
1 parent f8a73ec commit c95b16f

File tree

2 files changed

+35
-17
lines changed

2 files changed

+35
-17
lines changed

src/stores/menu.ts

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,21 @@ export const useMenuStore = defineStore('menu', () => {
5454
icon: 'mdi:mdi-information-outline',
5555
title: 'Description',
5656
},
57+
{
58+
href: '#usage',
59+
icon: 'mdi:mdi-power-plug',
60+
title: 'Usage',
61+
},
62+
{
63+
href: '#examples',
64+
icon: 'mdi:mdi-code-json',
65+
title: 'Examples',
66+
},
67+
{
68+
href: '#playground',
69+
icon: 'mdi:mdi-seesaw',
70+
title: 'Playground',
71+
},
5772
{
5873
href: '#props',
5974
icon: 'mdi:mdi-cog',
@@ -70,6 +85,12 @@ export const useMenuStore = defineStore('menu', () => {
7085
key: 'props-table-loader',
7186
title: 'Table Loader',
7287
},
88+
{
89+
href: '#props-colors',
90+
icon: 'mdi:mdi-palette',
91+
key: 'props-colors',
92+
title: 'Colors',
93+
},
7394
],
7495
title: 'Props',
7596
},
@@ -88,11 +109,6 @@ export const useMenuStore = defineStore('menu', () => {
88109
icon: 'mdi:mdi-slot-machine',
89110
title: 'Slots',
90111
},
91-
{
92-
href: '#example',
93-
icon: 'mdi:mdi-code-json',
94-
title: 'Example',
95-
},
96112
{
97113
href: '#dependencies',
98114
icon: 'mdi:mdi-asterisk-circle-outline',

src/stores/props.ts

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@ export const usePropsStore = defineStore('props', () => {
55
const coreStore = useCoreStore();
66
const links = coreStore.links;
77

8-
// const colorDesc = 'Applies specified color to the';
9-
// const densityDesc = 'Adjusts the vertical height used by the component';
10-
// const variantDesc = 'Applies a distinct style to the';
11-
128
const tableLoaderProps = [
139
{
1410
default: '1px',
1511
desc: `Sets the height for the linear progress loader. See <a href="${links.vuetify}/en/api/v-progress-linear/#props-height" target="_blank"><code class="inline-code">VProgressLinear</code></a> for more information.`,
1612
name: 'loaderHeight',
1713
type: 'VProgressLinear["$props"]["height"]',
1814
},
15+
{
16+
default: 'default',
17+
desc: `Sets the diameter of the circular progress loader circle in pixels. See <a href="${links.vuetify}/en/api/v-progress-circular/#props-size" target="_blank"><code class="inline-code">VProgressCircular</code></a> for more information.`,
18+
name: 'loaderSize',
19+
type: 'VProgressCircular["$props"]["size"]',
20+
},
1921
{
2022
default: 'linear',
2123
desc: 'Sets the type of loader. Available types are <code class="inline-code">linear</code>, <code class="inline-code">circular</code>, <code class="inline-code">text</code> and <code class="inline-code">skelton</code>. You can also use multiple loaders by passing an array of types. The order of the array determines the order of the loaders. To use the <a href="#slots-supported-loader"><code class="inline-code">loader</code></a> slot, set this prop to <code class="inline-code">null</code> or <code class="inline-code">false</code>.',
@@ -34,7 +36,7 @@ export const usePropsStore = defineStore('props', () => {
3436
...tableLoaderProps,
3537
{
3638
default: 'null',
37-
desc: 'Applies specified colors to the table',
39+
desc: 'Applies specified colors to the table. See the <a href="#props-colors">Colors Prop</a> section for more information.',
3840
name: 'colors',
3941
type: 'ColorsObject | null',
4042
},
@@ -70,7 +72,7 @@ export const usePropsStore = defineStore('props', () => {
7072
// },
7173
{
7274
default: undefined,
73-
desc: 'An array of objects that each describe a footer column. The formatting of the objects are the same as the <a href="#props-all-headers"><code class="inline-code">headers</code></a> prop and should be the same (mostly) to create the same columns. See <a href="#cell-rendering">Cell Rendering</a> for more information about rendering.',
75+
desc: 'An array of objects that each describe a footer column. The formatting of the objects are the same as the <a href="#props-all-headers"><code class="inline-code">headers</code></a> prop and should be the same (mostly) to create the same columns. To enabled the <code class="inline-code">footers</code> row you will need to set the <a href="#props-all-showfooterrow"><code class="inline-code">showFooterRow</code></a> prop to true. See <a href="#cell-rendering">Cell Rendering</a> for more information about rendering.',
7476
name: 'footers',
7577
type: 'Column[]',
7678
},
@@ -188,12 +190,12 @@ export const usePropsStore = defineStore('props', () => {
188190
name: 'showDrilldownWhenLoading',
189191
type: 'boolean',
190192
},
191-
// {
192-
// default: true,
193-
// desc: 'tbd',
194-
// name: 'showFooterRow',
195-
// type: 'boolean',
196-
// },
193+
{
194+
default: false,
195+
desc: 'Determines if the table should show the footer row, which by default shows the same values as the header row. To customize the footer row, use the <a href="#props-all-footers"><code class="inline-code">footers</code></a> prop.',
196+
name: 'showFooterRow',
197+
type: 'boolean',
198+
},
197199
{
198200
default: false,
199201
desc: 'Determines if the table should show the <code class="inline-code">VTextField</code> in the <code class="inline-code">top</code> slot',

0 commit comments

Comments
 (0)