Skip to content

Commit a3bf552

Browse files
committed
chore(QIconPicker): json api done
you can now `quasar describe QIconPicker` from command-line
1 parent 5cabc32 commit a3bf552

File tree

2 files changed

+116
-1
lines changed

2 files changed

+116
-1
lines changed

src/component/QIconPicker.json

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
{
2+
"type": "component",
3+
"props": {
4+
"value": {
5+
"type": "String",
6+
"desc": "Vue v-model value",
7+
"default": "",
8+
"examples": [
9+
"calendar-today",
10+
"bolt"
11+
]
12+
},
13+
"icon-set": {
14+
"type": "String",
15+
"desc": "The name of a Quasar icon set",
16+
"values": [
17+
"material-icons",
18+
"ionicons-v4",
19+
"mdi-v3",
20+
"fontawesome-v5",
21+
"eva-icons",
22+
"themify"
23+
]
24+
},
25+
"icons": {
26+
"type": "Array",
27+
"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.",
28+
"definition": {
29+
"name": {
30+
"type": "String",
31+
"desc": "The icon name",
32+
"examples": [
33+
"calendar-today",
34+
"bolt"
35+
]
36+
}
37+
}
38+
},
39+
"filter": {
40+
"type": "String",
41+
"desc": "Icons will be filtered by the passed string"
42+
},
43+
"dense": {
44+
"type": "Boolean",
45+
"desc": "Use less of a foot print for the component"
46+
},
47+
"tooltips": {
48+
"type": "Boolean",
49+
"desc": "Turns tooltips on for each displayed icon (shows the icon name)"
50+
},
51+
"no-footer": {
52+
"type": "Boolean",
53+
"desc": "hides the footer area that contains the pagination"
54+
},
55+
"color": {
56+
"type": "String",
57+
"desc": "This can be any CSS color value or Quasar color",
58+
"examples": [
59+
"orange-8",
60+
"#c8c8c8"
61+
]
62+
},
63+
"background-color": {
64+
"type": "String",
65+
"desc": "This can be any CSS color value or Quasar color",
66+
"examples": [
67+
"orange-8",
68+
"#c8c8c8"
69+
]
70+
},
71+
"selected-color": {
72+
"type": "String",
73+
"desc": "This can be any CSS color value or Quasar color",
74+
"examples": [
75+
"orange-8",
76+
"#c8c8c8"
77+
]
78+
},
79+
"selected-background-color": {
80+
"type": "String",
81+
"desc": "This can be any CSS color value or Quasar color",
82+
"examples": [
83+
"orange-8",
84+
"#c8c8c8"
85+
]
86+
},
87+
"font-size": {
88+
"type": "String",
89+
"desc": "The font-size to use for the icons. Any acceptable CSS size can be used",
90+
"examples": [
91+
"3rem",
92+
"24px"
93+
]
94+
},
95+
"pagination": {
96+
"type": "Object",
97+
"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",
98+
"examples": [
99+
":pagination.sync=\"pagination\""
100+
]
101+
}
102+
},
103+
"events": {
104+
"input": {
105+
"type": "String",
106+
"desc": "Value from when the selection changes"
107+
}
108+
},
109+
"scopedSlots": {
110+
"icon": {
111+
"type": "String",
112+
"desc": "Slot for re-displaying icon"
113+
}
114+
}
115+
}

src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module.exports = function (api) {
2323
api.compatibleWith('@quasar/app', '^1.0.0')
2424

2525
// register JSON api
26-
// api.registerDescribeApi('QIconPicker', './component/QIconPicker.json')
26+
api.registerDescribeApi('QIconPicker', './component/QIconPicker.json')
2727

2828
// extend quasar.conf
2929
api.extendQuasarConf(extendQuasarConf)

0 commit comments

Comments
 (0)