Skip to content

Commit 0fa5e24

Browse files
committed
feat: update icon names to PascalCase for consistency
1 parent 9a93028 commit 0fa5e24

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -76,22 +76,22 @@ export default buildConfig({
7676
enabled: true, // Default
7777
shortcut: 'shift+enter', // 'shift+enter' | 'enter'
7878
icons: {
79-
posts: 'file-text',
80-
users: 'user',
79+
posts: 'FileText',
80+
users: 'User',
8181
},
8282
},
8383

8484
// Custom icons for collections and globals
8585
icons: {
8686
collections: {
87-
posts: 'file-text',
88-
pages: 'file',
89-
media: 'image',
90-
users: 'users',
87+
posts: 'FileText',
88+
pages: 'File',
89+
media: 'Image',
90+
users: 'Users',
9191
},
9292
globals: {
93-
settings: 'settings',
94-
navigation: 'menu',
93+
settings: 'Settings',
94+
navigation: 'Menu',
9595
},
9696
},
9797

@@ -108,7 +108,7 @@ export default buildConfig({
108108
type: 'item',
109109
slug: 'view-site',
110110
label: 'View Site',
111-
icon: 'external-link',
111+
icon: 'ExternalLink',
112112
action: {
113113
type: 'link',
114114
href: 'https://your-site.com',
@@ -118,7 +118,7 @@ export default buildConfig({
118118
type: 'item',
119119
slug: 'clear-cache',
120120
label: 'Clear Cache',
121-
icon: 'trash-2',
121+
icon: 'Trash2',
122122
action: {
123123
type: 'api',
124124
method: 'POST',
@@ -235,8 +235,8 @@ submenu: {
235235
enabled: true,
236236
shortcut: 'enter',
237237
icons: {
238-
posts: 'file-text',
239-
products: 'shopping-cart',
238+
posts: 'FileText',
239+
products: 'ShoppingCart',
240240
}
241241
}
242242
```
@@ -268,16 +268,16 @@ Customize icons for collections and globals using [Lucide icon names](https://lu
268268
```typescript
269269
icons: {
270270
collections: {
271-
posts: 'file-text',
272-
pages: 'file',
273-
media: 'image',
274-
users: 'users',
275-
categories: 'folder',
271+
posts: 'FileText',
272+
pages: 'File',
273+
media: 'Image',
274+
users: 'Users',
275+
categories: 'Folder',
276276
},
277277
globals: {
278-
settings: 'settings',
279-
navigation: 'menu',
280-
footer: 'layout',
278+
settings: 'Settings',
279+
navigation: 'Menu',
280+
footer: 'Layout',
281281
}
282282
}
283283
```
@@ -300,7 +300,7 @@ Add custom menu items and groups to the command menu.
300300
type: 'item',
301301
slug: 'unique-slug',
302302
label: 'Item Label', // Can be localized
303-
icon: 'lucide-icon-name', // Optional, from lucide.dev/icons
303+
icon: 'LucideIconName', // Optional, from lucide.dev/icons
304304
action: {
305305
type: 'link' | 'api',
306306
href: '/path/or/url',
@@ -340,7 +340,7 @@ customItems: [
340340
en: 'View Site',
341341
uk: 'Переглянути сайт',
342342
},
343-
icon: 'external-link',
343+
icon: 'ExternalLink',
344344
action: {
345345
type: 'link',
346346
href: 'https://your-site.com',
@@ -350,7 +350,7 @@ customItems: [
350350
type: 'item',
351351
slug: 'regenerate',
352352
label: 'Regenerate Cache',
353-
icon: 'refresh-cw',
353+
icon: 'RefreshCw',
354354
action: {
355355
type: 'api',
356356
method: 'POST',
@@ -517,7 +517,7 @@ export default buildConfig({
517517
type: 'item',
518518
slug: 'documentation',
519519
label: 'View Documentation',
520-
icon: 'book-open',
520+
icon: 'BookOpen',
521521
action: {
522522
type: 'link',
523523
href: 'https://docs.your-site.com',
@@ -537,28 +537,28 @@ export default buildConfig({
537537
payloadCmdk({
538538
icons: {
539539
collections: {
540-
posts: 'newspaper',
541-
pages: 'file-text',
542-
media: 'image',
543-
categories: 'folder-tree',
544-
tags: 'tag',
545-
users: 'user-circle',
546-
comments: 'message-circle',
540+
posts: 'Newspaper',
541+
pages: 'FileText',
542+
media: 'Image',
543+
categories: 'FolderTree',
544+
tags: 'Tag',
545+
users: 'UserCircle',
546+
comments: 'MessageCircle',
547547
},
548548
globals: {
549-
header: 'layout-template',
550-
footer: 'layout',
551-
settings: 'settings-2',
552-
navigation: 'navigation',
553-
seo: 'search',
549+
header: 'LayoutTemplate',
550+
footer: 'Layout',
551+
settings: 'Settings',
552+
navigation: 'Menu',
553+
seo: 'Search',
554554
},
555555
},
556556
submenu: {
557557
enabled: true,
558558
icons: {
559-
posts: 'file-text',
560-
pages: 'file',
561-
media: 'image',
559+
posts: 'FileText',
560+
pages: 'File',
561+
media: 'Image',
562562
},
563563
},
564564
}),

0 commit comments

Comments
 (0)