Skip to content

Commit 392a03d

Browse files
Update docs
1 parent 0bf1dc4 commit 392a03d

File tree

3 files changed

+64
-1
lines changed

3 files changed

+64
-1
lines changed

src/documentation/components/FeaturesTable.vue

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@
1515
cols="12"
1616
>
1717
<div v-html="subtitle"></div>
18+
19+
<div v-if="propsTable">Props with the <v-icon
20+
color="primary"
21+
icon="mdi:mdi-earth"
22+
size="x-small"
23+
/> icon next to it can be used with <code class="inline-code">createVDrilldownTable</code> as a global property.
24+
</div>
1825
</v-col>
1926
</v-row>
2027

@@ -53,7 +60,13 @@
5360
class="text-primary"
5461
:class="classes.appLink"
5562
:href="`#${slugifyString(sectionId, item.name)}`"
56-
>{{ item.name }}</a>
63+
>{{ item.name }} <v-icon
64+
v-if="item.global"
65+
class=""
66+
color="primary"
67+
icon="mdi:mdi-earth"
68+
size="x-small"
69+
/></a>
5770
</div>
5871
</template>
5972

@@ -95,6 +108,11 @@ defineProps({
95108
default: () => [],
96109
type: Array,
97110
},
111+
propsTable: {
112+
default: false,
113+
required: false,
114+
type: Boolean,
115+
},
98116
sectionId: {
99117
default: '',
100118
type: String,

src/documentation/sections/PropsSection.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<FeaturesTable
2727
:headers="store.tableHeaders"
2828
:items="propsStore.allProps"
29+
props-table
2930
section-id="props-all"
3031
section-title="All Props"
3132
subtitle="These all of the available props"

src/stores/props.ts

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ export const usePropsStore = defineStore('props', () => {
99
{
1010
default: 15,
1111
desc: 'Sets the percentage change for the header row background color within the drilldown tables.',
12+
global: true,
1213
name: 'color-percentage-change',
1314
type: 'number',
1415
},
1516
{
1617
default: 'desc',
1718
desc: 'Sets the direction of the percentage change for the header row background color within the drilldown tables.',
19+
global: true,
1820
name: 'color-percentage-direction',
1921
type: "'asc' | 'desc'",
2022
},
@@ -37,24 +39,28 @@ export const usePropsStore = defineStore('props', () => {
3739
{
3840
default: '--v-theme-surface',
3941
desc: 'Sets the background color of the footer row.',
42+
global: true,
4043
name: 'footer-background-color',
4144
type: 'string',
4245
},
4346
{
4447
default: '--v-theme-on-surface',
4548
desc: 'Sets the text color of the footer row.',
49+
global: true,
4650
name: 'footer-color',
4751
type: 'string',
4852
},
4953
{
5054
default: '--v-theme-surface',
5155
desc: 'Sets the background color of the header row.',
56+
global: true,
5257
name: 'header-background-color',
5358
type: 'string',
5459
},
5560
{
5661
default: '--v-theme-on-surface',
5762
desc: 'Sets the text color of the header row.',
63+
global: true,
5864
name: 'header-color',
5965
type: 'string',
6066
},
@@ -70,12 +76,14 @@ export const usePropsStore = defineStore('props', () => {
7076
{
7177
default: '',
7278
desc: 'Used to bind the props of the <code class="inline-code">VProgressLinear</code>, <code class="inline-code">VProgressCircular</code>, and <code class="inline-code">VSkeletonLoader</code> loaders. See the <a href="#props-table-loader">Table Loader Props</a> for more information.',
79+
global: true,
7380
name: 'loader-props',
7481
type: 'object',
7582
},
7683
{
7784
default: 'linear',
7885
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>.',
86+
global: true,
7987
name: 'loader-type',
8088
type: 'string | string[] | false | null',
8189
},
@@ -91,6 +99,13 @@ export const usePropsStore = defineStore('props', () => {
9199
name: 'column-widths',
92100
type: 'object',
93101
},
102+
{
103+
default: 'default',
104+
desc: 'Adjusts the vertical height of the table rows.',
105+
global: true,
106+
name: 'density',
107+
type: 'object',
108+
},
94109
{
95110
default: '',
96111
desc: 'Internal use only. This holds the drilldown tables data and settings.',
@@ -106,6 +121,7 @@ export const usePropsStore = defineStore('props', () => {
106121
{
107122
default: 0,
108123
desc: 'Elevation of the table',
124+
global: true,
109125
name: 'elevation',
110126
type: 'string | number | undefined',
111127
},
@@ -127,6 +143,13 @@ export const usePropsStore = defineStore('props', () => {
127143
name: 'is-drilldown',
128144
type: 'boolean',
129145
},
146+
{
147+
default: false,
148+
desc: 'Adds a hover effects to a table rows.',
149+
global: true,
150+
name: 'hover',
151+
type: 'boolean',
152+
},
130153
{
131154
default: undefined,
132155
desc: 'Internal use only',
@@ -145,6 +168,19 @@ export const usePropsStore = defineStore('props', () => {
145168
name: 'items-length',
146169
type: 'number',
147170
},
171+
{
172+
default: `<pre class="inline-code"><code>[
173+
{value: 10, title: '10'},
174+
{value: 25, title: '25'},
175+
{value: 50, title: '50'},
176+
{value: 100, title: '100'},
177+
{value: -1, title: '$vuetify.dataFooter.itemsPerPageAll'}
178+
]</code></pre>`,
179+
desc: 'Array of options to show in the items-per-page dropdown.',
180+
global: true,
181+
name: 'items-per-page-options',
182+
type: 'number',
183+
},
148184
{
149185
default: 1,
150186
desc: 'The level of the drilldown (1 = top level)',
@@ -215,6 +251,7 @@ export const usePropsStore = defineStore('props', () => {
215251
{
216252
default: 'default',
217253
desc: 'Enhance the appearance of the table by modifying the borders of the cells',
254+
global: true,
218255
name: 'separator',
219256
type: '\'default\' | \'horizontal\' | \'vertical\' | \'cell\' | undefined',
220257
},
@@ -242,6 +279,13 @@ export const usePropsStore = defineStore('props', () => {
242279
name: 'show-search',
243280
type: 'boolean',
244281
},
282+
{
283+
default: '$sortAsc',
284+
desc: 'Icon used for ascending sort button.',
285+
global: true,
286+
name: 'sort-asc-icon',
287+
type: 'any',
288+
},
245289
{
246290
default: 'VDataTable',
247291
desc: 'Internal use only',

0 commit comments

Comments
 (0)