nuxt.schema.json
9.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
{
"id": "#",
"properties": {
"appConfig": {
"id": "#appConfig",
"properties": {
"icon": {
"title": "Nuxt Icon",
"description": "Configure Nuxt Icon module preferences.",
"tags": [
"@studioIcon material-symbols:star"
],
"id": "#appConfig/icon",
"properties": {
"size": {
"title": "Icon Size",
"description": "Set the default icon size.",
"tags": [
"@studioIcon material-symbols:format-size-rounded"
],
"tsType": "string | undefined",
"id": "#appConfig/icon/size",
"default": {},
"type": "any"
},
"class": {
"title": "CSS Class",
"description": "Set the default CSS class.",
"tags": [
"@studioIcon material-symbols:css"
],
"id": "#appConfig/icon/class",
"default": "",
"type": "string"
},
"attrs": {
"title": "Default Attributes",
"description": "Attributes applied to every icon component.\n\n@default { \"aria-hidden\": true }",
"tags": [
"@studioIcon material-symbols:settings"
],
"tsType": "Record<string, string | number | boolean>",
"id": "#appConfig/icon/attrs",
"default": {
"aria-hidden": true
},
"type": "object"
},
"mode": {
"title": "Default Rendering Mode",
"description": "Set the default rendering mode for the icon component",
"enum": [
"css",
"svg"
],
"tags": [
"@studioIcon material-symbols:move-down-rounded"
],
"id": "#appConfig/icon/mode",
"default": "css",
"type": "string"
},
"aliases": {
"title": "Icon aliases",
"description": "Define Icon aliases to update them easily without code changes.",
"tags": [
"@studioIcon material-symbols:star-rounded"
],
"tsType": "{ [alias: string]: string }",
"id": "#appConfig/icon/aliases",
"default": {},
"type": "object"
},
"cssSelectorPrefix": {
"title": "CSS Selector Prefix",
"description": "Set the default CSS selector prefix.",
"tags": [
"@studioIcon material-symbols:format-textdirection-l-to-r"
],
"id": "#appConfig/icon/cssSelectorPrefix",
"default": "i-",
"type": "string"
},
"cssLayer": {
"title": "CSS Layer Name",
"description": "Set the default CSS `@layer` name.",
"tags": [
"@studioIcon material-symbols:layers"
],
"tsType": "string | undefined",
"id": "#appConfig/icon/cssLayer",
"default": {},
"type": "any"
},
"cssWherePseudo": {
"title": "Use CSS `:where()` Pseudo Selector",
"description": "Use CSS `:where()` pseudo selector to reduce specificity.",
"tags": [
"@studioIcon material-symbols:low-priority"
],
"id": "#appConfig/icon/cssWherePseudo",
"default": true,
"type": "boolean"
},
"collections": {
"title": "Icon Collections",
"description": "List of known icon collections name. Used to resolve collection name ambiguity.\ne.g. `simple-icons-github` -> `simple-icons:github` instead of `simple:icons-github`\n\nWhen not provided, will use the full Iconify collection list.",
"tags": [
"@studioIcon material-symbols:format-list-bulleted"
],
"tsType": "string[] | null",
"id": "#appConfig/icon/collections",
"default": null,
"type": "any"
},
"customCollections": {
"title": "Custom Icon Collections",
"tags": [
"@studioIcon material-symbols:format-list-bulleted"
],
"tsType": "string[] | null",
"id": "#appConfig/icon/customCollections",
"default": null,
"type": "any"
},
"provider": {
"title": "Icon Provider",
"description": "Provider to use for fetching icons\n\n- `server` - Fetch icons with a server handler\n- `iconify` - Fetch icons with Iconify API, purely client-side\n- `none` - Do not fetch icons (use client bundle only)\n\n`server` by default; `iconify` when `ssr: false`",
"enum": [
"server",
"iconify",
"none"
],
"tags": [
"@studioIcon material-symbols:cloud"
],
"type": "\"server\" | \"iconify\" | \"none\" | undefined",
"id": "#appConfig/icon/provider"
},
"iconifyApiEndpoint": {
"title": "Iconify API Endpoint URL",
"description": "Define a custom Iconify API endpoint URL. Useful if you want to use a self-hosted Iconify API. Learn more: https://iconify.design/docs/api.",
"tags": [
"@studioIcon material-symbols:api"
],
"id": "#appConfig/icon/iconifyApiEndpoint",
"default": "https://api.iconify.design",
"type": "string"
},
"fallbackToApi": {
"title": "Fallback to Iconify API",
"description": "Fallback to Iconify API if server provider fails to found the collection.",
"tags": [
"@studioIcon material-symbols:public"
],
"enum": [
true,
false,
"server-only",
"client-only"
],
"type": "boolean | \"server-only\" | \"client-only\"",
"id": "#appConfig/icon/fallbackToApi",
"default": true
},
"localApiEndpoint": {
"title": "Local API Endpoint Path",
"description": "Define a custom path for the local API endpoint.",
"tags": [
"@studioIcon material-symbols:api"
],
"id": "#appConfig/icon/localApiEndpoint",
"default": "/api/_nuxt_icon",
"type": "string"
},
"fetchTimeout": {
"title": "Fetch Timeout",
"description": "Set the timeout for fetching icons.",
"tags": [
"@studioIcon material-symbols:timer"
],
"id": "#appConfig/icon/fetchTimeout",
"default": 1500,
"type": "number"
},
"customize": {
"title": "Customize callback",
"description": "Customize icon content (replace stroke-width, colors, etc...).",
"tags": [
"@studioIcon material-symbols:edit"
],
"type": "IconifyIconCustomizeCallback",
"id": "#appConfig/icon/customize"
}
},
"type": "object",
"default": {
"size": {},
"class": "",
"attrs": {
"aria-hidden": true
},
"mode": "css",
"aliases": {},
"cssSelectorPrefix": "i-",
"cssLayer": {},
"cssWherePseudo": true,
"collections": null,
"customCollections": null,
"iconifyApiEndpoint": "https://api.iconify.design",
"fallbackToApi": true,
"localApiEndpoint": "/api/_nuxt_icon",
"fetchTimeout": 1500
}
}
},
"type": "object",
"default": {
"icon": {
"size": {},
"class": "",
"attrs": {
"aria-hidden": true
},
"mode": "css",
"aliases": {},
"cssSelectorPrefix": "i-",
"cssLayer": {},
"cssWherePseudo": true,
"collections": null,
"customCollections": null,
"iconifyApiEndpoint": "https://api.iconify.design",
"fallbackToApi": true,
"localApiEndpoint": "/api/_nuxt_icon",
"fetchTimeout": 1500
}
}
}
},
"type": "object",
"default": {
"appConfig": {
"icon": {
"size": {},
"class": "",
"attrs": {
"aria-hidden": true
},
"mode": "css",
"aliases": {},
"cssSelectorPrefix": "i-",
"cssLayer": {},
"cssWherePseudo": true,
"collections": null,
"customCollections": null,
"iconifyApiEndpoint": "https://api.iconify.design",
"fallbackToApi": true,
"localApiEndpoint": "/api/_nuxt_icon",
"fetchTimeout": 1500
}
}
}
}