Skip to content

Commit c73ee86

Browse files
Copilothotlong
andcommitted
Convert PascalCase icon names to kebab-case in documentation MDX files
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent ade388b commit c73ee86

6 files changed

Lines changed: 47 additions & 47 deletions

File tree

content/docs/blocks/block-schema.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ BlockSchema enables:
3838
{
3939
type: "div",
4040
className: "w-12 h-12 rounded-lg bg-primary/10 flex items-center justify-center",
41-
children: [{ type: "icon", name: "Zap", className: "h-6 w-6 text-primary" }]
41+
children: [{ type: "icon", name: "zap", className: "h-6 w-6 text-primary" }]
4242
},
4343
{ type: "text", content: "Fast Performance", className: "text-lg font-semibold" },
4444
{ type: "text", content: "Lightning-fast response times with optimized bundle sizes and edge caching support.", className: "text-sm text-muted-foreground" },
@@ -66,7 +66,7 @@ BlockSchema enables:
6666
spacing: 3,
6767
className: "items-center text-center p-4",
6868
children: [
69-
{ type: "div", className: "w-12 h-12 rounded-lg bg-green-500/10 flex items-center justify-center", children: [{ type: "icon", name: "Shield", className: "h-6 w-6 text-green-600" }] },
69+
{ type: "div", className: "w-12 h-12 rounded-lg bg-green-500/10 flex items-center justify-center", children: [{ type: "icon", name: "shield", className: "h-6 w-6 text-green-600" }] },
7070
{ type: "text", content: "Enterprise Security", className: "text-lg font-semibold" },
7171
{ type: "text", content: "Bank-grade encryption and SOC 2 compliance built in.", className: "text-sm text-muted-foreground" },
7272
{ type: "button", label: "See Certifications", variant: "outline", size: "sm" }
@@ -110,7 +110,7 @@ BlockSchema enables:
110110
{
111111
type: "div",
112112
className: "h-32 bg-gradient-to-br from-blue-500/20 to-purple-500/20 rounded-t-lg flex items-center justify-center",
113-
children: [{ type: "icon", name: "LayoutTemplate", className: "h-12 w-12 text-primary/60" }]
113+
children: [{ type: "icon", name: "layout-template", className: "h-12 w-12 text-primary/60" }]
114114
},
115115
{
116116
type: "stack",
@@ -266,7 +266,7 @@ const cardBlock: BlockSchema = {
266266
label: 'Feature Card',
267267
description: 'A card component for highlighting product features',
268268
category: 'Marketing',
269-
icon: 'Box',
269+
icon: 'box',
270270
tags: ['card', 'feature', 'marketing', 'product'],
271271
author: 'ObjectUI Team',
272272
version: '1.0.0',
@@ -296,9 +296,9 @@ const cardBlock: BlockSchema = {
296296
name: 'icon',
297297
label: 'Icon',
298298
type: 'string',
299-
defaultValue: 'Star',
299+
defaultValue: 'star',
300300
description: 'Lucide icon name',
301-
enum: ['Star', 'Heart', 'Check', 'Zap', 'Shield']
301+
enum: ['star', 'heart', 'check', 'zap', 'shield']
302302
},
303303
{
304304
name: 'variant',
@@ -408,7 +408,7 @@ const instance: BlockInstanceSchema = {
408408
values: {
409409
title: 'Fast Performance',
410410
description: 'Lightning-fast response times',
411-
icon: 'Zap',
411+
icon: 'zap',
412412
variant: 'filled',
413413
showButton: true,
414414
buttonText: 'See Benchmarks'
@@ -503,7 +503,7 @@ const marketplace: BlockLibrarySchema = {
503503
label: 'Pricing Table Pro',
504504
description: 'Professional pricing comparison table',
505505
category: 'Marketing',
506-
icon: 'DollarSign',
506+
icon: 'dollar-sign',
507507
tags: ['pricing', 'saas', 'comparison'],
508508
author: 'ObjectUI Team',
509509
version: '2.1.0',

content/docs/blocks/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Blocks are complete, ready-to-use UI patterns built with ObjectUI components. Un
3535
className: "items-center justify-between",
3636
children: [
3737
{ type: "text", content: "Total Revenue", className: "text-sm font-medium text-muted-foreground" },
38-
{ type: "icon", name: "DollarSign", className: "h-4 w-4 text-muted-foreground" }
38+
{ type: "icon", name: "dollar-sign", className: "h-4 w-4 text-muted-foreground" }
3939
]
4040
},
4141
{ type: "text", content: "$45,231.89", className: "text-2xl font-bold" },

content/docs/core/app-schema.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ AppSchema provides a declarative way to configure:
3636
type: "flex",
3737
className: "items-center gap-2 px-3 py-2 rounded-md bg-accent text-accent-foreground",
3838
children: [
39-
{ type: "icon", name: "LayoutDashboard", className: "h-4 w-4" },
39+
{ type: "icon", name: "layout-dashboard", className: "h-4 w-4" },
4040
{ type: "text", content: "Dashboard", className: "text-sm font-medium" }
4141
]
4242
},
4343
{
4444
type: "flex",
4545
className: "items-center gap-2 px-3 py-2 rounded-md hover:bg-accent/50",
4646
children: [
47-
{ type: "icon", name: "Users", className: "h-4 w-4 text-muted-foreground" },
47+
{ type: "icon", name: "users", className: "h-4 w-4 text-muted-foreground" },
4848
{ type: "text", content: "Contacts", className: "text-sm" },
4949
{ type: "badge", label: "128", variant: "secondary", className: "ml-auto text-xs" }
5050
]
@@ -53,7 +53,7 @@ AppSchema provides a declarative way to configure:
5353
type: "flex",
5454
className: "items-center gap-2 px-3 py-2 rounded-md hover:bg-accent/50",
5555
children: [
56-
{ type: "icon", name: "Target", className: "h-4 w-4 text-muted-foreground" },
56+
{ type: "icon", name: "target", className: "h-4 w-4 text-muted-foreground" },
5757
{ type: "text", content: "Opportunities", className: "text-sm" }
5858
]
5959
},
@@ -63,15 +63,15 @@ AppSchema provides a declarative way to configure:
6363
type: "flex",
6464
className: "items-center gap-2 px-3 py-2 rounded-md hover:bg-accent/50",
6565
children: [
66-
{ type: "icon", name: "Megaphone", className: "h-4 w-4 text-muted-foreground" },
66+
{ type: "icon", name: "megaphone", className: "h-4 w-4 text-muted-foreground" },
6767
{ type: "text", content: "Campaigns", className: "text-sm" }
6868
]
6969
},
7070
{
7171
type: "flex",
7272
className: "items-center gap-2 px-3 py-2 rounded-md hover:bg-accent/50",
7373
children: [
74-
{ type: "icon", name: "Mail", className: "h-4 w-4 text-muted-foreground" },
74+
{ type: "icon", name: "mail", className: "h-4 w-4 text-muted-foreground" },
7575
{ type: "text", content: "Email Templates", className: "text-sm" }
7676
]
7777
},
@@ -80,7 +80,7 @@ AppSchema provides a declarative way to configure:
8080
type: "flex",
8181
className: "items-center gap-2 px-3 py-2 rounded-md hover:bg-accent/50",
8282
children: [
83-
{ type: "icon", name: "Settings", className: "h-4 w-4 text-muted-foreground" },
83+
{ type: "icon", name: "settings", className: "h-4 w-4 text-muted-foreground" },
8484
{ type: "text", content: "Settings", className: "text-sm" }
8585
]
8686
}
@@ -103,16 +103,16 @@ AppSchema provides a declarative way to configure:
103103
type: "flex",
104104
className: "items-center gap-3",
105105
children: [
106-
{ type: "icon", name: "Box", className: "h-6 w-6 text-primary" },
106+
{ type: "icon", name: "box", className: "h-6 w-6 text-primary" },
107107
{ type: "text", content: "Acme CRM", className: "font-semibold text-lg" }
108108
]
109109
},
110110
{
111111
type: "flex",
112112
className: "items-center gap-2",
113113
children: [
114-
{ type: "button", label: "Quick Actions", variant: "outline", size: "sm", icon: "Zap" },
115-
{ type: "button", label: "Notifications", variant: "ghost", size: "sm", icon: "Bell" },
114+
{ type: "button", label: "Quick Actions", variant: "outline", size: "sm", icon: "zap" },
115+
{ type: "button", label: "Notifications", variant: "ghost", size: "sm", icon: "bell" },
116116
{
117117
type: "flex",
118118
className: "items-center gap-2 ml-2 pl-2 border-l",
@@ -151,7 +151,7 @@ const app: AppSchema = {
151151
{
152152
type: 'item',
153153
label: 'Dashboard',
154-
icon: 'LayoutDashboard',
154+
icon: 'layout-dashboard',
155155
path: '/dashboard'
156156
}
157157
],
@@ -214,7 +214,7 @@ interface MenuItem {
214214
{
215215
"type": "item",
216216
"label": "Dashboard",
217-
"icon": "LayoutDashboard",
217+
"icon": "layout-dashboard",
218218
"path": "/dashboard",
219219
"badge": "New"
220220
}
@@ -225,7 +225,7 @@ interface MenuItem {
225225
{
226226
"type": "group",
227227
"label": "Sales",
228-
"icon": "DollarSign",
228+
"icon": "dollar-sign",
229229
"children": [
230230
{ "type": "item", "label": "Leads", "path": "/leads" },
231231
{ "type": "item", "label": "Deals", "path": "/deals" }
@@ -275,7 +275,7 @@ const crm: AppSchema = {
275275
{
276276
type: 'item',
277277
label: 'Dashboard',
278-
icon: 'LayoutDashboard',
278+
icon: 'layout-dashboard',
279279
path: '/dashboard'
280280
},
281281
{
@@ -284,33 +284,33 @@ const crm: AppSchema = {
284284
{
285285
type: 'group',
286286
label: 'Sales',
287-
icon: 'DollarSign',
287+
icon: 'dollar-sign',
288288
children: [
289289
{
290290
type: 'item',
291291
label: 'Leads',
292-
icon: 'Users',
292+
icon: 'users',
293293
path: '/leads',
294294
badge: 12
295295
},
296296
{
297297
type: 'item',
298298
label: 'Opportunities',
299-
icon: 'Target',
299+
icon: 'target',
300300
path: '/opportunities'
301301
},
302302
{
303303
type: 'item',
304304
label: 'Quotes',
305-
icon: 'FileText',
305+
icon: 'file-text',
306306
path: '/quotes'
307307
}
308308
]
309309
},
310310
{
311311
type: 'group',
312312
label: 'Marketing',
313-
icon: 'Megaphone',
313+
icon: 'megaphone',
314314
children: [
315315
{
316316
type: 'item',
@@ -330,7 +330,7 @@ const crm: AppSchema = {
330330
{
331331
type: 'item',
332332
label: 'Settings',
333-
icon: 'Settings',
333+
icon: 'settings',
334334
path: '/settings',
335335
hidden: '${user.role !== "admin"}'
336336
}
@@ -340,7 +340,7 @@ const crm: AppSchema = {
340340
{
341341
type: 'button',
342342
label: 'Quick Actions',
343-
icon: 'Zap',
343+
icon: 'zap',
344344
variant: 'outline',
345345
onClick: 'openQuickActions'
346346
},
@@ -353,13 +353,13 @@ const crm: AppSchema = {
353353
{
354354
type: 'item',
355355
label: 'Profile',
356-
icon: 'User',
356+
icon: 'user',
357357
path: '/profile'
358358
},
359359
{
360360
type: 'item',
361361
label: 'Settings',
362-
icon: 'Settings',
362+
icon: 'settings',
363363
path: '/settings'
364364
},
365365
{
@@ -368,7 +368,7 @@ const crm: AppSchema = {
368368
{
369369
type: 'item',
370370
label: 'Logout',
371-
icon: 'LogOut',
371+
icon: 'log-out',
372372
path: '/logout'
373373
}
374374
]

content/docs/core/enhanced-actions.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ The enhanced `ActionSchema` provides:
3434
type: "flex",
3535
className: "gap-2 flex-wrap",
3636
children: [
37-
{ type: "button", label: "Submit", variant: "default", icon: "Send" },
38-
{ type: "button", label: "Save Draft", variant: "outline", icon: "Save" },
39-
{ type: "button", label: "Delete", variant: "destructive", icon: "Trash2" },
37+
{ type: "button", label: "Submit", variant: "default", icon: "send" },
38+
{ type: "button", label: "Save Draft", variant: "outline", icon: "save" },
39+
{ type: "button", label: "Delete", variant: "destructive", icon: "trash-2" },
4040
{ type: "button", label: "Cancel", variant: "ghost" }
4141
]
4242
}
@@ -68,7 +68,7 @@ The enhanced `ActionSchema` provides:
6868
className: "justify-end gap-2 pt-4",
6969
children: [
7070
{ type: "button", label: "Cancel", variant: "outline" },
71-
{ type: "button", label: "Yes, Delete", variant: "destructive", icon: "Trash2" }
71+
{ type: "button", label: "Yes, Delete", variant: "destructive", icon: "trash-2" }
7272
]
7373
}
7474
]
@@ -118,8 +118,8 @@ The enhanced `ActionSchema` provides:
118118
className: "justify-end gap-2 pt-4 border-t mt-4",
119119
children: [
120120
{ type: "button", label: "Reject", variant: "outline", size: "sm" },
121-
{ type: "button", label: "Request Review", variant: "secondary", size: "sm", icon: "Eye" },
122-
{ type: "button", label: "Approve", variant: "default", size: "sm", icon: "Check" }
121+
{ type: "button", label: "Request Review", variant: "secondary", size: "sm", icon: "eye" },
122+
{ type: "button", label: "Approve", variant: "default", size: "sm", icon: "check" }
123123
]
124124
}
125125
]
@@ -396,7 +396,7 @@ A comprehensive action combining multiple features:
396396
const complexAction: ActionSchema = {
397397
type: 'action',
398398
label: 'Process Order',
399-
icon: 'ShoppingCart',
399+
icon: 'shopping-cart',
400400
variant: 'default',
401401
402402
// Confirm before processing

content/docs/core/report-schema.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ ReportSchema provides:
4646
type: "flex",
4747
className: "gap-2",
4848
children: [
49-
{ type: "button", label: "PDF", variant: "outline", size: "sm", icon: "FileText" },
50-
{ type: "button", label: "Excel", variant: "outline", size: "sm", icon: "Table" },
51-
{ type: "button", label: "Print", variant: "outline", size: "sm", icon: "Printer" }
49+
{ type: "button", label: "PDF", variant: "outline", size: "sm", icon: "file-text" },
50+
{ type: "button", label: "Excel", variant: "outline", size: "sm", icon: "table" },
51+
{ type: "button", label: "Print", variant: "outline", size: "sm", icon: "printer" }
5252
]
5353
}
5454
]
@@ -199,7 +199,7 @@ ReportSchema provides:
199199
type: "flex",
200200
className: "items-center gap-2",
201201
children: [
202-
{ type: "icon", name: "Clock", className: "h-5 w-5 text-primary" },
202+
{ type: "icon", name: "clock", className: "h-5 w-5 text-primary" },
203203
{ type: "text", content: "Schedule Settings", className: "font-semibold" }
204204
]
205205
}
@@ -250,7 +250,7 @@ ReportSchema provides:
250250
className: "justify-end gap-2 pt-2",
251251
children: [
252252
{ type: "button", label: "Cancel", variant: "outline" },
253-
{ type: "button", label: "Save Schedule", variant: "default", icon: "Save" }
253+
{ type: "button", label: "Save Schedule", variant: "default", icon: "save" }
254254
]
255255
}
256256
]

content/docs/plugins/plugin-view.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ npm install @object-ui/plugin-view
131131
type: "flex",
132132
className: "justify-end gap-2 pt-4 border-t mt-4",
133133
children: [
134-
{ type: "button", label: "Edit", variant: "outline", size: "sm", icon: "Pencil" },
135-
{ type: "button", label: "Delete", variant: "destructive", size: "sm", icon: "Trash2" }
134+
{ type: "button", label: "Edit", variant: "outline", size: "sm", icon: "pencil" },
135+
{ type: "button", label: "Delete", variant: "destructive", size: "sm", icon: "trash-2" }
136136
]
137137
}
138138
]
@@ -171,7 +171,7 @@ npm install @object-ui/plugin-view
171171
className: "justify-end gap-2 pt-2",
172172
children: [
173173
{ type: "button", label: "Cancel", variant: "outline" },
174-
{ type: "button", label: "Create User", variant: "default", icon: "Plus" }
174+
{ type: "button", label: "Create User", variant: "default", icon: "plus" }
175175
]
176176
}
177177
]

0 commit comments

Comments
 (0)