Skip to content

Commit 3c35940

Browse files
Updating docs
1 parent 83d2a42 commit 3c35940

File tree

1 file changed

+27
-68
lines changed

1 file changed

+27
-68
lines changed

src/stores/props.ts

Lines changed: 27 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ const sharedProps = [
5353
default: 'default',
5454
desc: `${colorDesc} cancel button`,
5555
name: 'cancel-button-color',
56-
type: "VBtn['$props']['color']",
56+
type: "string | undefined",
5757
},
5858
{
5959
default: 'x-small',
6060
desc: 'Sets the height and width of the cancel button',
6161
name: 'cancel-button-size',
62-
type: "VBtn['$props']['size']",
62+
type: "string | number | undefined",
6363
},
6464
{
6565
default: 'Cancel',
@@ -87,7 +87,7 @@ const sharedProps = [
8787
},
8888
{
8989
default: false,
90-
desc: 'If <code>true</code>, the field will close when the user opens another inline form element',
90+
desc: 'If <code class="ic">true</code>, the field will close when the user opens another inline form element',
9191
name: 'close-siblings',
9292
type: 'boolean',
9393
},
@@ -117,7 +117,7 @@ const sharedProps = [
117117
},
118118
{
119119
default: false,
120-
desc: 'If set to <code>true</code> will only show the field',
120+
desc: 'If set to <code class="ic">true</code> will only show the field',
121121
name: 'field-only',
122122
type: 'boolean',
123123
},
@@ -135,13 +135,13 @@ const sharedProps = [
135135
},
136136
{
137137
default: undefined,
138-
desc: 'Sets the text of the <code>v-label</code> or <code>v-field-label</code> component',
138+
desc: 'Sets the text of the <code class="ic">v-label</code> or <code class="ic">v-field-label</code> component',
139139
name: 'label',
140140
type: 'string',
141141
},
142142
{
143143
default: 'true',
144-
desc: 'Sets the text of the field cursor to <code>wait</code> and prevents the field from opening until <code>loading</code> has returned to false',
144+
desc: 'The cursor for unopened fields, with the same loading prop value, is set to "wait" and their selection is disabled until the loading process is completed. Additionally, the saving field will remain visible but disabled until the loading is finished',
145145
name: 'loading-wait',
146146
type: 'boolean',
147147
},
@@ -192,7 +192,7 @@ const sharedProps = [
192192
const autofocusProp = [
193193
{
194194
default: false,
195-
desc: 'If <code>true</code>, the field will autofocus',
195+
desc: 'If <code class="ic">true</code>, the field will autofocus',
196196
name: 'auto-focus',
197197
type: 'boolean',
198198
},
@@ -221,13 +221,13 @@ const saveAndLoadingIconProps = [
221221
default: 'primary',
222222
desc: `${colorDesc} save button`,
223223
name: 'save-button-color',
224-
type: "VBtn['$props']['color']",
224+
type: "string | undefined",
225225
},
226226
{
227227
default: 'x-small',
228-
desc: 'Sets the height and width of the save button',
228+
desc: 'Sets the height and width of the save/loading button',
229229
name: 'save-button-size',
230-
type: "VBtn['$props']['size']",
230+
type: "string | number | undefined",
231231
},
232232
{
233233
default: 'Save',
@@ -237,7 +237,7 @@ const saveAndLoadingIconProps = [
237237
},
238238
{
239239
default: 'text',
240-
desc: `${variantDesc} save button`,
240+
desc: `${variantDesc} save/loading button`,
241241
name: 'save-button-variant',
242242
type: "VBtn['$props']['variant']",
243243
},
@@ -264,37 +264,37 @@ const trueFalseIconProps = [
264264
},
265265
{
266266
default: undefined,
267-
desc: 'The <code>false</code> icon',
267+
desc: 'The displayed <code class="ic">false</code> icon when the field is not editable',
268268
name: 'icon-false',
269269
type: 'string | undefined',
270270
},
271271
{
272272
default: 'danger',
273-
desc: `${colorDesc} icon when <code>false</code>`,
273+
desc: `${colorDesc} icon when <code class="ic">false</code>`,
274274
name: 'icon-false-color',
275275
type: 'string',
276276
},
277277
{
278278
default: 'No',
279-
desc: 'The title of the <code>false</code> icon',
279+
desc: 'The title of the <code class="ic">false</code> icon',
280280
name: 'icon-false-title',
281281
type: 'string | undefined',
282282
},
283283
{
284284
default: undefined,
285-
desc: 'The <code>true</code> icon',
285+
desc: 'The displayed <code class="ic">true</code> icon when the field is not editable',
286286
name: 'icon-true',
287287
type: 'string | undefined',
288288
},
289289
{
290290
default: 'success',
291-
desc: `${colorDesc} icon when <code>true</code>`,
291+
desc: `${colorDesc} icon when <code class="ic">true</code>`,
292292
name: 'icon-true-color',
293293
type: 'string',
294294
},
295295
{
296296
default: 'Yes',
297-
desc: 'The title of the <code>true</code> icon',
297+
desc: 'The title of the <code class="ic">true</code> icon',
298298
name: 'icon-true-title',
299299
type: 'string | undefined',
300300
},
@@ -329,31 +329,20 @@ const truncateProps = [
329329

330330
const vInlineCheckboxProps = [
331331
...sharedProps,
332+
...saveAndLoadingIconProps,
332333
...trueFalseIconProps,
333334
...[
334-
{
335-
default: 'compact',
336-
desc: densityDesc,
337-
name: 'density',
338-
type: "VCheckbox['$props']['density']",
339-
},
340335
{
341336
default: undefined,
342-
desc: 'The icon of the field when <code>false</code>',
337+
desc: 'The icon of the checkbox when <code class="ic">false</code>',
343338
name: 'false-icon',
344-
type: "VCheckbox['$props']['falseIcon']",
339+
type: "string | undefined",
345340
},
346341
{
347342
default: undefined,
348-
desc: 'The icon of the field when <code>true</code>',
343+
desc: 'The icon of the checkbox when <code class="ic">true</code>',
349344
name: 'true-icon',
350-
type: "VCheckbox['$props']['trueIcon']",
351-
},
352-
{
353-
default: true,
354-
desc: 'Displays/Hides the icons',
355-
name: 'icons',
356-
type: 'boolean',
345+
type: "string | undefined",
357346
},
358347
]
359348
];
@@ -373,19 +362,13 @@ const vInlineSelectProps = [
373362
default: false,
374363
desc: 'Allows for the component to be cleared',
375364
name: 'clearable',
376-
type: "VSelect['$props']['clearable']",
377-
},
378-
{
379-
default: 'compact',
380-
desc: densityDesc,
381-
name: 'density',
382-
type: "VSelect['$props']['density']",
365+
type: "boolean | undefined",
383366
},
384367
{
385368
default: true,
386369
desc: 'Hides the selected items',
387370
name: 'hide-selected',
388-
type: "VSelect['$props']['hideSelected']",
371+
type: "boolean | undefined",
389372
},
390373
{
391374
default: 'title',
@@ -418,24 +401,12 @@ const vInlineSwitchProps = [
418401
...sharedProps,
419402
...trueFalseIconProps,
420403
...[
421-
{
422-
default: 'compact',
423-
desc: densityDesc,
424-
name: 'density',
425-
type: "VSwitch['$props']['density']",
426-
},
427404
{
428405
default: undefined,
429-
desc: 'The icon of the field when <code>false</code>',
406+
desc: 'The icon of the field when <code class="ic">false</code>',
430407
name: 'false-icon',
431408
type: "VSwitch['$props']['falseIcon']",
432409
},
433-
{
434-
default: true,
435-
desc: 'Displays/Hides the icons',
436-
name: 'icons',
437-
type: 'boolean',
438-
},
439410
]
440411
];
441412

@@ -449,19 +420,13 @@ const vInlineTextareaProps = [
449420
default: true,
450421
desc: 'Automatically grow the textarea depending on amount of text',
451422
name: 'auto-grow',
452-
type: "VTextarea['$props']['autoGrow']",
453-
},
454-
{
455-
default: 'compact',
456-
desc: densityDesc,
457-
name: 'density',
458-
type: "VTextarea['$props']['density']",
423+
type: "boolean | undefined",
459424
},
460425
{
461426
default: 1,
462427
desc: 'Default row count',
463428
name: 'rows',
464-
type: "VTextarea['$props']['rows']",
429+
type: "string | number | undefined",
465430
},
466431
{
467432
default: 'underlined',
@@ -478,12 +443,6 @@ const vInlineTextFieldProps = [
478443
...saveAndLoadingIconProps,
479444
...truncateProps,
480445
...[
481-
{
482-
default: 'compact',
483-
desc: densityDesc,
484-
name: 'density',
485-
type: "VTextField['$props']['density']",
486-
},
487446
{
488447
default: 'underlined',
489448
desc: `${variantDesc} component`,

0 commit comments

Comments
 (0)