Skip to content

Commit 01ca4ff

Browse files
committed
chore(ui): add json api
1 parent 1debbb9 commit 01ca4ff

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed

ui/src/component/QIconPicker.json

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
{
2+
"type": "component",
3+
"props": {
4+
"value": {
5+
"type": "String",
6+
"desc": "`v-model`; The selected icon",
7+
"default": "",
8+
"examples": [
9+
"v-model=\"calendar-today\"",
10+
"v-model=\"bolt\""
11+
]
12+
},
13+
"icon-set": {
14+
"type": "String",
15+
"desc": "The name of a Quasar icon set",
16+
"values": [
17+
"material-icons",
18+
"material-icons-outlined",
19+
"material-icons-round",
20+
"material-icons-sharp",
21+
"ionicons-v4",
22+
"mdi-v4",
23+
"fontawesome-v5",
24+
"eva-icons",
25+
"themify"
26+
],
27+
"examples": [
28+
"icon-set=\"material-icons\"",
29+
"icon-set=\"fontawesome-v5\""
30+
]
31+
},
32+
"icons": {
33+
"type": "Array",
34+
"desc": "An array of objects containing icon information. The object must contain the key `name` with the value being the icon name (ie: `{ name: 'bolt' }`). _**Note:** the icons used must already be loaded by Quasar._",
35+
"examples": [
36+
":icons=\"[{ name: 'calendar-today'}, { name: 'bolt'}]\""
37+
],
38+
"definition": {
39+
"name": {
40+
"type": "String",
41+
"desc": "The icon name"
42+
}
43+
}
44+
},
45+
"filter": {
46+
"type": "String",
47+
"desc": "Icons will be filtered by the passed string",
48+
"examples": [
49+
":filter=\"myFilter\""
50+
]
51+
},
52+
"dense": {
53+
"type": "Boolean",
54+
"desc": "Use less of a foot print for the component"
55+
},
56+
"tooltips": {
57+
"type": "Boolean",
58+
"desc": "Turns tooltips on for each displayed icon (shows the icon name)"
59+
},
60+
"no-footer": {
61+
"type": "Boolean",
62+
"desc": "hides the footer area when `pagination` is enabled"
63+
},
64+
"color": {
65+
"type": "String",
66+
"desc": "Any color from the [Quasar Color Pallete](https://quasar.dev/style/color-palette) or a CSS color (#, rgb, rgba, hls, etc)",
67+
"examples": [
68+
"color=\"orange-8\"",
69+
"color=\"#c8c8c8\""
70+
]
71+
},
72+
"background-color": {
73+
"type": "String",
74+
"desc": "Any color from the [Quasar Color Pallete](https://quasar.dev/style/color-palette) or a CSS color (#, rgb, rgba, hls, etc)",
75+
"examples": [
76+
"background-color=\"orange-8\"",
77+
"background-color=\"#c8c8c8\""
78+
]
79+
},
80+
"selected-color": {
81+
"type": "String",
82+
"desc": "Any color from the [Quasar Color Pallete](https://quasar.dev/style/color-palette) or a CSS color (#, rgb, rgba, hls, etc)",
83+
"examples": [
84+
"selected-color=\"orange-8\"",
85+
"selected-color=\"#c8c8c8\""
86+
]
87+
},
88+
"selected-background-color": {
89+
"type": "String",
90+
"desc": "Any color from the [Quasar Color Pallete](https://quasar.dev/style/color-palette) or a CSS color (#, rgb, rgba, hls, etc)",
91+
"examples": [
92+
"selected-background-color=\"orange-8\"",
93+
"selected-background-color=\"#c8c8c8\""
94+
]
95+
},
96+
"font-size": {
97+
"type": "String",
98+
"desc": "The font-size to use for the icons. Any acceptable CSS size can be used",
99+
"examples": [
100+
"font-size=\"3rem\"",
101+
"font-size=\"24px\""
102+
]
103+
},
104+
"pagination": {
105+
"type": "Object",
106+
"sync": true,
107+
"desc": "For pagination purposes uses Quasar's pagination component. Use `pagination.sync` to synchronize the data. You can use `page` and `itemsPerPage` to control the pagination. QIconPicker will set `totalPages` depending on `icon-set` or `icons` properties. If using a `filter` the page will automatically be reset to 1",
108+
"examples": [
109+
":pagination.sync=\"myPagination\""
110+
]
111+
}
112+
},
113+
"events": {
114+
"input": {
115+
"type": "String",
116+
"desc": "`v-model`; Value from when the selection changes"
117+
}
118+
},
119+
"scopedSlots": {
120+
"icon": {
121+
"type": "String",
122+
"desc": "Slot for changing the display of the icon",
123+
"examples":[
124+
"<template #icon=\"name\"><q-btn :name=\"name\" :label=\"name\" no-caps /></template>"
125+
]
126+
}
127+
}
128+
}

0 commit comments

Comments
 (0)