@bloomneo/uikit 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +222 -0
- package/LICENSE +21 -0
- package/README.md +513 -0
- package/bin/commands/build.js +232 -0
- package/bin/commands/bundle.js +587 -0
- package/bin/commands/create.js +768 -0
- package/bin/commands/deploy.js +533 -0
- package/bin/commands/generate.js +673 -0
- package/bin/commands/optimize.js +198 -0
- package/bin/commands/prerender.js +306 -0
- package/bin/commands/serve.js +216 -0
- package/bin/templates/fbca/README.md.template +130 -0
- package/bin/templates/fbca/docs/QUICKSTART_FBCA.md +368 -0
- package/bin/templates/fbca/docs/UIKIT_CLI_GUIDE.md +574 -0
- package/bin/templates/fbca/docs/UIKIT_COMPOSITE_UI_SYSTEM.md +649 -0
- package/bin/templates/fbca/docs/UIKIT_LLM_GUIDE.md +2055 -0
- package/bin/templates/fbca/docs/UIKIT_THEME_GUIDE.md +359 -0
- package/bin/templates/fbca/package.json.template +41 -0
- package/bin/templates/fbca/public/favicon.svg +10 -0
- package/bin/templates/fbca/public/hero_fbca.svg +1 -0
- package/bin/templates/fbca/src/utils/asset.ts +6 -0
- package/bin/templates/fbca/src/web/App.tsx.template +20 -0
- package/bin/templates/fbca/src/web/features/auth/pages/index.tsx.template +157 -0
- package/bin/templates/fbca/src/web/features/docs/pages/[...slug].tsx.template +83 -0
- package/bin/templates/fbca/src/web/features/gallery/hooks/useGallery.ts.template +74 -0
- package/bin/templates/fbca/src/web/features/gallery/pages/index.tsx.template +136 -0
- package/bin/templates/fbca/src/web/features/main/components/CTASection.tsx.template +43 -0
- package/bin/templates/fbca/src/web/features/main/pages/About.tsx.template +374 -0
- package/bin/templates/fbca/src/web/features/main/pages/index.tsx.template +214 -0
- package/bin/templates/fbca/src/web/index.html.template +15 -0
- package/bin/templates/fbca/src/web/lib/page-router.tsx.template +134 -0
- package/bin/templates/fbca/src/web/main.tsx.template +14 -0
- package/bin/templates/fbca/src/web/shared/components/Footer.tsx.template +57 -0
- package/bin/templates/fbca/src/web/shared/components/Header.tsx.template +91 -0
- package/bin/templates/fbca/src/web/shared/components/SEO.tsx.template +24 -0
- package/bin/templates/fbca/src/web/shared/components/index.ts.template +3 -0
- package/bin/templates/fbca/src/web/shared/hooks/useSEO.ts.template +85 -0
- package/bin/templates/fbca/src/web/shared/utils/asset.ts +6 -0
- package/bin/templates/fbca/src/web/styles/index.css.template +8 -0
- package/bin/templates/fbca/src/web/utils/asset.ts +6 -0
- package/bin/templates/fbca/tsconfig.json.template +32 -0
- package/bin/templates/fbca/tsconfig.node.json.template +10 -0
- package/bin/templates/fbca/vite.config.ts.template +38 -0
- package/bin/templates/generate/component/component.tsx.template +79 -0
- package/bin/templates/generate/component/index.ts.template +2 -0
- package/bin/templates/generate/component/types.ts.template +58 -0
- package/bin/templates/generate/feature/index.ts.template +14 -0
- package/bin/templates/generate/feature/list-page.tsx.template +34 -0
- package/bin/templates/generate/feature/main-component.tsx.template +37 -0
- package/bin/templates/generate/feature/main-page.tsx.template +30 -0
- package/bin/templates/generate/feature/types.ts.template +34 -0
- package/bin/templates/generate/hook/hook.ts.template +35 -0
- package/bin/templates/generate/index.css.template +10 -0
- package/bin/templates/generate/main.tsx.template +10 -0
- package/bin/templates/generate/page/index.ts.template +2 -0
- package/bin/templates/generate/page/page.tsx.template +86 -0
- package/bin/templates/generate/theme/README.md +31 -0
- package/bin/templates/generate/theme/theme.js.template +155 -0
- package/bin/templates/multi/README.md.template +120 -0
- package/bin/templates/multi/docs/QUICKSTART_MULTI.md +334 -0
- package/bin/templates/multi/docs/UIKIT_CLI_GUIDE.md +574 -0
- package/bin/templates/multi/docs/UIKIT_COMPOSITE_UI_SYSTEM.md +649 -0
- package/bin/templates/multi/docs/UIKIT_LLM_GUIDE.md +2055 -0
- package/bin/templates/multi/docs/UIKIT_THEME_GUIDE.md +359 -0
- package/bin/templates/multi/index.html.template +58 -0
- package/bin/templates/multi/package.json.template +35 -0
- package/bin/templates/multi/public/favicon.svg +10 -0
- package/bin/templates/multi/public/hero_multi.svg +1 -0
- package/bin/templates/multi/src/App.tsx.template +92 -0
- package/bin/templates/multi/src/components/Footer.tsx.template +58 -0
- package/bin/templates/multi/src/components/Header.tsx.template +103 -0
- package/bin/templates/multi/src/components/SEO.tsx.template +19 -0
- package/bin/templates/multi/src/components/index.ts.template +3 -0
- package/bin/templates/multi/src/hooks/useSEO.ts.template +38 -0
- package/bin/templates/multi/src/index.css.template +7 -0
- package/bin/templates/multi/src/main.tsx.template +14 -0
- package/bin/templates/multi/src/pages/About.tsx.template +276 -0
- package/bin/templates/multi/src/pages/Components.tsx.template +288 -0
- package/bin/templates/multi/src/pages/Contact.tsx.template +348 -0
- package/bin/templates/multi/src/pages/Dashboard.tsx.template +306 -0
- package/bin/templates/multi/src/pages/ErrorPage.tsx.template +37 -0
- package/bin/templates/multi/src/pages/Home.tsx.template +201 -0
- package/bin/templates/multi/src/pages/Login.tsx.template +148 -0
- package/bin/templates/multi/src/pages/Themes.tsx.template +207 -0
- package/bin/templates/multi/src/router.tsx.template +34 -0
- package/bin/templates/multi/src/utils/asset.ts +6 -0
- package/bin/templates/multi/tsconfig.json.template +30 -0
- package/bin/templates/multi/tsconfig.node.json +22 -0
- package/bin/templates/multi/vite.config.ts.template +36 -0
- package/bin/templates/single/README.md.template +131 -0
- package/bin/templates/single/docs/QUICKSTART_SINGLE.md +259 -0
- package/bin/templates/single/docs/UIKIT_CLI_GUIDE.md +574 -0
- package/bin/templates/single/docs/UIKIT_COMPOSITE_UI_SYSTEM.md +649 -0
- package/bin/templates/single/docs/UIKIT_LLM_GUIDE.md +2055 -0
- package/bin/templates/single/docs/UIKIT_THEME_GUIDE.md +359 -0
- package/bin/templates/single/index.html.template +37 -0
- package/bin/templates/single/package.json.template +34 -0
- package/bin/templates/single/public/favicon.svg +10 -0
- package/bin/templates/single/public/hero.svg +1 -0
- package/bin/templates/single/src/App.tsx.template +233 -0
- package/bin/templates/single/src/index.css.template +7 -0
- package/bin/templates/single/src/main.tsx.template +14 -0
- package/bin/templates/single/src/styles/fonts.css +99 -0
- package/bin/templates/single/src/utils/asset.ts +6 -0
- package/bin/templates/single/tsconfig.json +31 -0
- package/bin/templates/single/tsconfig.node.json +22 -0
- package/bin/templates/single/vite.config.ts.template +36 -0
- package/bin/templates/spa/README.md.template +105 -0
- package/bin/templates/spa/components/SEO.tsx.template +19 -0
- package/bin/templates/spa/docs/QUICKSTART_SPA.md +300 -0
- package/bin/templates/spa/docs/UIKIT_CLI_GUIDE.md +574 -0
- package/bin/templates/spa/docs/UIKIT_COMPOSITE_UI_SYSTEM.md +649 -0
- package/bin/templates/spa/docs/UIKIT_LLM_GUIDE.md +2055 -0
- package/bin/templates/spa/docs/UIKIT_THEME_GUIDE.md +359 -0
- package/bin/templates/spa/hooks/useSEO.ts.template +38 -0
- package/bin/templates/spa/index.html.template +58 -0
- package/bin/templates/spa/package.json.template +35 -0
- package/bin/templates/spa/public/favicon.svg +15 -0
- package/bin/templates/spa/public/hero_spa.svg +1 -0
- package/bin/templates/spa/src/App.tsx.template +659 -0
- package/bin/templates/spa/src/index.css.template +7 -0
- package/bin/templates/spa/src/main.tsx.template +14 -0
- package/bin/templates/spa/src/utils/asset.ts +6 -0
- package/bin/templates/spa/tsconfig.json.template +30 -0
- package/bin/templates/spa/tsconfig.node.json +22 -0
- package/bin/templates/spa/vite.config.ts.template +36 -0
- package/bin/uikit.js +133 -0
- package/cookbook/README.md +20 -0
- package/cookbook/crud-page.tsx +99 -0
- package/cookbook/dashboard.tsx +89 -0
- package/cookbook/delete-flow.tsx +59 -0
- package/cookbook/login.tsx +85 -0
- package/cookbook/settings.tsx +113 -0
- package/dist/Combination-C0DFrmJW.js +674 -0
- package/dist/Combination-C0DFrmJW.js.map +1 -0
- package/dist/accordion.js +284 -0
- package/dist/accordion.js.map +1 -0
- package/dist/admin.js +429 -0
- package/dist/admin.js.map +1 -0
- package/dist/alert.js +67 -0
- package/dist/alert.js.map +1 -0
- package/dist/auth.js +178 -0
- package/dist/auth.js.map +1 -0
- package/dist/avatar.js +249 -0
- package/dist/avatar.js.map +1 -0
- package/dist/badge.js +40 -0
- package/dist/badge.js.map +1 -0
- package/dist/blank.js +80 -0
- package/dist/blank.js.map +1 -0
- package/dist/breadcrumb.js +104 -0
- package/dist/breadcrumb.js.map +1 -0
- package/dist/button.js +50 -0
- package/dist/button.js.map +1 -0
- package/dist/calendar.js +2785 -0
- package/dist/calendar.js.map +1 -0
- package/dist/card.js +91 -0
- package/dist/card.js.map +1 -0
- package/dist/check-DXouwtzp.js +12 -0
- package/dist/check-DXouwtzp.js.map +1 -0
- package/dist/checkbox.js +268 -0
- package/dist/checkbox.js.map +1 -0
- package/dist/chevron-down-BORJtX8F.js +14 -0
- package/dist/chevron-down-BORJtX8F.js.map +1 -0
- package/dist/chevron-left-C1pkx4AF.js +14 -0
- package/dist/chevron-left-C1pkx4AF.js.map +1 -0
- package/dist/chevron-right-pz9eCjj-.js +14 -0
- package/dist/chevron-right-pz9eCjj-.js.map +1 -0
- package/dist/circle-DHOdTDQh.js +14 -0
- package/dist/circle-DHOdTDQh.js.map +1 -0
- package/dist/collapsible.js +35 -0
- package/dist/collapsible.js.map +1 -0
- package/dist/command.js +481 -0
- package/dist/command.js.map +1 -0
- package/dist/confirm-dialog.js +129 -0
- package/dist/confirm-dialog.js.map +1 -0
- package/dist/container.js +334 -0
- package/dist/container.js.map +1 -0
- package/dist/createLucideIcon-B45kRl5r.js +80 -0
- package/dist/createLucideIcon-B45kRl5r.js.map +1 -0
- package/dist/data-table.js +574 -0
- package/dist/data-table.js.map +1 -0
- package/dist/detail-page.js +454 -0
- package/dist/detail-page.js.map +1 -0
- package/dist/dialog.js +137 -0
- package/dist/dialog.js.map +1 -0
- package/dist/dropdown-menu.js +424 -0
- package/dist/dropdown-menu.js.map +1 -0
- package/dist/ellipsis-BhAoKPVk.js +16 -0
- package/dist/ellipsis-BhAoKPVk.js.map +1 -0
- package/dist/empty-state.js +54 -0
- package/dist/empty-state.js.map +1 -0
- package/dist/errors.js +36 -0
- package/dist/errors.js.map +1 -0
- package/dist/eye-DDKoW0KS.js +46 -0
- package/dist/eye-DDKoW0KS.js.map +1 -0
- package/dist/fonts/caveat-cyrillic-400-normal.woff +0 -0
- package/dist/fonts/caveat-cyrillic-400-normal.woff2 +0 -0
- package/dist/fonts/caveat-cyrillic-700-normal.woff +0 -0
- package/dist/fonts/caveat-cyrillic-700-normal.woff2 +0 -0
- package/dist/fonts/caveat-cyrillic-ext-400-normal.woff +0 -0
- package/dist/fonts/caveat-cyrillic-ext-400-normal.woff2 +0 -0
- package/dist/fonts/caveat-cyrillic-ext-700-normal.woff +0 -0
- package/dist/fonts/caveat-cyrillic-ext-700-normal.woff2 +0 -0
- package/dist/fonts/caveat-latin-400-normal.woff +0 -0
- package/dist/fonts/caveat-latin-400-normal.woff2 +0 -0
- package/dist/fonts/caveat-latin-700-normal.woff +0 -0
- package/dist/fonts/caveat-latin-700-normal.woff2 +0 -0
- package/dist/fonts/caveat-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/caveat-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/caveat-latin-ext-700-normal.woff +0 -0
- package/dist/fonts/caveat-latin-ext-700-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-latin-400-normal.woff +0 -0
- package/dist/fonts/crimson-text-latin-400-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-latin-600-normal.woff +0 -0
- package/dist/fonts/crimson-text-latin-600-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-latin-700-normal.woff +0 -0
- package/dist/fonts/crimson-text-latin-700-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/crimson-text-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-latin-ext-600-normal.woff +0 -0
- package/dist/fonts/crimson-text-latin-ext-600-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-latin-ext-700-normal.woff +0 -0
- package/dist/fonts/crimson-text-latin-ext-700-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-vietnamese-400-normal.woff +0 -0
- package/dist/fonts/crimson-text-vietnamese-400-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-vietnamese-600-normal.woff +0 -0
- package/dist/fonts/crimson-text-vietnamese-600-normal.woff2 +0 -0
- package/dist/fonts/crimson-text-vietnamese-700-normal.woff +0 -0
- package/dist/fonts/crimson-text-vietnamese-700-normal.woff2 +0 -0
- package/dist/fonts/dm-serif-display-latin-400-normal.woff +0 -0
- package/dist/fonts/dm-serif-display-latin-400-normal.woff2 +0 -0
- package/dist/fonts/dm-serif-display-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/dm-serif-display-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/libre-baskerville-latin-400-normal.woff +0 -0
- package/dist/fonts/libre-baskerville-latin-400-normal.woff2 +0 -0
- package/dist/fonts/libre-baskerville-latin-700-normal.woff +0 -0
- package/dist/fonts/libre-baskerville-latin-700-normal.woff2 +0 -0
- package/dist/fonts/libre-baskerville-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/libre-baskerville-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/libre-baskerville-latin-ext-700-normal.woff +0 -0
- package/dist/fonts/libre-baskerville-latin-ext-700-normal.woff2 +0 -0
- package/dist/fonts/montserrat-cyrillic-400-normal.woff +0 -0
- package/dist/fonts/montserrat-cyrillic-400-normal.woff2 +0 -0
- package/dist/fonts/montserrat-cyrillic-500-normal.woff +0 -0
- package/dist/fonts/montserrat-cyrillic-500-normal.woff2 +0 -0
- package/dist/fonts/montserrat-cyrillic-600-normal.woff +0 -0
- package/dist/fonts/montserrat-cyrillic-600-normal.woff2 +0 -0
- package/dist/fonts/montserrat-cyrillic-ext-400-normal.woff +0 -0
- package/dist/fonts/montserrat-cyrillic-ext-400-normal.woff2 +0 -0
- package/dist/fonts/montserrat-cyrillic-ext-500-normal.woff +0 -0
- package/dist/fonts/montserrat-cyrillic-ext-500-normal.woff2 +0 -0
- package/dist/fonts/montserrat-cyrillic-ext-600-normal.woff +0 -0
- package/dist/fonts/montserrat-cyrillic-ext-600-normal.woff2 +0 -0
- package/dist/fonts/montserrat-latin-400-normal.woff +0 -0
- package/dist/fonts/montserrat-latin-400-normal.woff2 +0 -0
- package/dist/fonts/montserrat-latin-500-normal.woff +0 -0
- package/dist/fonts/montserrat-latin-500-normal.woff2 +0 -0
- package/dist/fonts/montserrat-latin-600-normal.woff +0 -0
- package/dist/fonts/montserrat-latin-600-normal.woff2 +0 -0
- package/dist/fonts/montserrat-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/montserrat-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/montserrat-latin-ext-500-normal.woff +0 -0
- package/dist/fonts/montserrat-latin-ext-500-normal.woff2 +0 -0
- package/dist/fonts/montserrat-latin-ext-600-normal.woff +0 -0
- package/dist/fonts/montserrat-latin-ext-600-normal.woff2 +0 -0
- package/dist/fonts/montserrat-vietnamese-400-normal.woff +0 -0
- package/dist/fonts/montserrat-vietnamese-400-normal.woff2 +0 -0
- package/dist/fonts/montserrat-vietnamese-500-normal.woff +0 -0
- package/dist/fonts/montserrat-vietnamese-500-normal.woff2 +0 -0
- package/dist/fonts/montserrat-vietnamese-600-normal.woff +0 -0
- package/dist/fonts/montserrat-vietnamese-600-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-cyrillic-400-normal.woff +0 -0
- package/dist/fonts/playfair-display-cyrillic-400-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-cyrillic-500-normal.woff +0 -0
- package/dist/fonts/playfair-display-cyrillic-500-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-latin-400-normal.woff +0 -0
- package/dist/fonts/playfair-display-latin-400-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-latin-500-normal.woff +0 -0
- package/dist/fonts/playfair-display-latin-500-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/playfair-display-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-latin-ext-500-normal.woff +0 -0
- package/dist/fonts/playfair-display-latin-ext-500-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-vietnamese-400-normal.woff +0 -0
- package/dist/fonts/playfair-display-vietnamese-400-normal.woff2 +0 -0
- package/dist/fonts/playfair-display-vietnamese-500-normal.woff +0 -0
- package/dist/fonts/playfair-display-vietnamese-500-normal.woff2 +0 -0
- package/dist/fonts/poppins-devanagari-400-normal.woff +0 -0
- package/dist/fonts/poppins-devanagari-400-normal.woff2 +0 -0
- package/dist/fonts/poppins-devanagari-500-normal.woff +0 -0
- package/dist/fonts/poppins-devanagari-500-normal.woff2 +0 -0
- package/dist/fonts/poppins-devanagari-600-normal.woff +0 -0
- package/dist/fonts/poppins-devanagari-600-normal.woff2 +0 -0
- package/dist/fonts/poppins-latin-400-normal.woff +0 -0
- package/dist/fonts/poppins-latin-400-normal.woff2 +0 -0
- package/dist/fonts/poppins-latin-500-normal.woff +0 -0
- package/dist/fonts/poppins-latin-500-normal.woff2 +0 -0
- package/dist/fonts/poppins-latin-600-normal.woff +0 -0
- package/dist/fonts/poppins-latin-600-normal.woff2 +0 -0
- package/dist/fonts/poppins-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/poppins-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/poppins-latin-ext-500-normal.woff +0 -0
- package/dist/fonts/poppins-latin-ext-500-normal.woff2 +0 -0
- package/dist/fonts/poppins-latin-ext-600-normal.woff +0 -0
- package/dist/fonts/poppins-latin-ext-600-normal.woff2 +0 -0
- package/dist/fonts/rubik-arabic-400-normal.woff +0 -0
- package/dist/fonts/rubik-arabic-400-normal.woff2 +0 -0
- package/dist/fonts/rubik-arabic-500-normal.woff +0 -0
- package/dist/fonts/rubik-arabic-500-normal.woff2 +0 -0
- package/dist/fonts/rubik-cyrillic-400-normal.woff +0 -0
- package/dist/fonts/rubik-cyrillic-400-normal.woff2 +0 -0
- package/dist/fonts/rubik-cyrillic-500-normal.woff +0 -0
- package/dist/fonts/rubik-cyrillic-500-normal.woff2 +0 -0
- package/dist/fonts/rubik-cyrillic-ext-400-normal.woff +0 -0
- package/dist/fonts/rubik-cyrillic-ext-400-normal.woff2 +0 -0
- package/dist/fonts/rubik-cyrillic-ext-500-normal.woff +0 -0
- package/dist/fonts/rubik-cyrillic-ext-500-normal.woff2 +0 -0
- package/dist/fonts/rubik-hebrew-400-normal.woff +0 -0
- package/dist/fonts/rubik-hebrew-400-normal.woff2 +0 -0
- package/dist/fonts/rubik-hebrew-500-normal.woff +0 -0
- package/dist/fonts/rubik-hebrew-500-normal.woff2 +0 -0
- package/dist/fonts/rubik-latin-400-normal.woff +0 -0
- package/dist/fonts/rubik-latin-400-normal.woff2 +0 -0
- package/dist/fonts/rubik-latin-500-normal.woff +0 -0
- package/dist/fonts/rubik-latin-500-normal.woff2 +0 -0
- package/dist/fonts/rubik-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/rubik-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/rubik-latin-ext-500-normal.woff +0 -0
- package/dist/fonts/rubik-latin-ext-500-normal.woff2 +0 -0
- package/dist/fonts/source-serif-pro-cyrillic-400-normal.woff +0 -0
- package/dist/fonts/source-serif-pro-cyrillic-400-normal.woff2 +0 -0
- package/dist/fonts/source-serif-pro-cyrillic-ext-400-normal.woff +0 -0
- package/dist/fonts/source-serif-pro-cyrillic-ext-400-normal.woff2 +0 -0
- package/dist/fonts/source-serif-pro-greek-400-normal.woff +0 -0
- package/dist/fonts/source-serif-pro-greek-400-normal.woff2 +0 -0
- package/dist/fonts/source-serif-pro-latin-400-normal.woff +0 -0
- package/dist/fonts/source-serif-pro-latin-400-normal.woff2 +0 -0
- package/dist/fonts/source-serif-pro-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/source-serif-pro-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/source-serif-pro-vietnamese-400-normal.woff +0 -0
- package/dist/fonts/source-serif-pro-vietnamese-400-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-latin-400-normal.woff +0 -0
- package/dist/fonts/space-grotesk-latin-400-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-latin-600-normal.woff +0 -0
- package/dist/fonts/space-grotesk-latin-600-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-latin-700-normal.woff +0 -0
- package/dist/fonts/space-grotesk-latin-700-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/space-grotesk-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-latin-ext-600-normal.woff +0 -0
- package/dist/fonts/space-grotesk-latin-ext-600-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-latin-ext-700-normal.woff +0 -0
- package/dist/fonts/space-grotesk-latin-ext-700-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-vietnamese-400-normal.woff +0 -0
- package/dist/fonts/space-grotesk-vietnamese-400-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-vietnamese-600-normal.woff +0 -0
- package/dist/fonts/space-grotesk-vietnamese-600-normal.woff2 +0 -0
- package/dist/fonts/space-grotesk-vietnamese-700-normal.woff +0 -0
- package/dist/fonts/space-grotesk-vietnamese-700-normal.woff2 +0 -0
- package/dist/fonts/work-sans-latin-400-normal.woff +0 -0
- package/dist/fonts/work-sans-latin-400-normal.woff2 +0 -0
- package/dist/fonts/work-sans-latin-500-normal.woff +0 -0
- package/dist/fonts/work-sans-latin-500-normal.woff2 +0 -0
- package/dist/fonts/work-sans-latin-ext-400-normal.woff +0 -0
- package/dist/fonts/work-sans-latin-ext-400-normal.woff2 +0 -0
- package/dist/fonts/work-sans-latin-ext-500-normal.woff +0 -0
- package/dist/fonts/work-sans-latin-ext-500-normal.woff2 +0 -0
- package/dist/fonts/work-sans-vietnamese-400-normal.woff +0 -0
- package/dist/fonts/work-sans-vietnamese-400-normal.woff2 +0 -0
- package/dist/fonts/work-sans-vietnamese-500-normal.woff +0 -0
- package/dist/fonts/work-sans-vietnamese-500-normal.woff2 +0 -0
- package/dist/footer.js +308 -0
- package/dist/footer.js.map +1 -0
- package/dist/form-field.js +69 -0
- package/dist/form-field.js.map +1 -0
- package/dist/form.js +732 -0
- package/dist/form.js.map +1 -0
- package/dist/format.js +112 -0
- package/dist/format.js.map +1 -0
- package/dist/fouc.js +28 -0
- package/dist/fouc.js.map +1 -0
- package/dist/header.js +289 -0
- package/dist/header.js.map +1 -0
- package/dist/hooks.js +13 -0
- package/dist/hooks.js.map +1 -0
- package/dist/hover-card.js +210 -0
- package/dist/hover-card.js.map +1 -0
- package/dist/index-0ioNhtNM.js +11 -0
- package/dist/index-0ioNhtNM.js.map +1 -0
- package/dist/index-1QHKgw6D.js +55 -0
- package/dist/index-1QHKgw6D.js.map +1 -0
- package/dist/index-B6sSWi7l.js +747 -0
- package/dist/index-B6sSWi7l.js.map +1 -0
- package/dist/index-BCjJQGh8.js +71 -0
- package/dist/index-BCjJQGh8.js.map +1 -0
- package/dist/index-BGQepRFJ.js +28 -0
- package/dist/index-BGQepRFJ.js.map +1 -0
- package/dist/index-BVRIAMfe.js +37 -0
- package/dist/index-BVRIAMfe.js.map +1 -0
- package/dist/index-BY7PeRJA.js +145 -0
- package/dist/index-BY7PeRJA.js.map +1 -0
- package/dist/index-BZPx6jYI.js +9 -0
- package/dist/index-BZPx6jYI.js.map +1 -0
- package/dist/index-Ba4eHUBD.js +243 -0
- package/dist/index-Ba4eHUBD.js.map +1 -0
- package/dist/index-Bke1qZdk.js +35 -0
- package/dist/index-Bke1qZdk.js.map +1 -0
- package/dist/index-C0UREtMP.js +60 -0
- package/dist/index-C0UREtMP.js.map +1 -0
- package/dist/index-CCKe-Mpx.js +7 -0
- package/dist/index-CCKe-Mpx.js.map +1 -0
- package/dist/index-DFZozV_h.js +69 -0
- package/dist/index-DFZozV_h.js.map +1 -0
- package/dist/index-DFi6WydO.js +180 -0
- package/dist/index-DFi6WydO.js.map +1 -0
- package/dist/index-DQH6odE9.js +83 -0
- package/dist/index-DQH6odE9.js.map +1 -0
- package/dist/index-EO5flKM3.js +119 -0
- package/dist/index-EO5flKM3.js.map +1 -0
- package/dist/index-Lf7yDOXW.js +615 -0
- package/dist/index-Lf7yDOXW.js.map +1 -0
- package/dist/index-dhIqEbxW.js +1541 -0
- package/dist/index-dhIqEbxW.js.map +1 -0
- package/dist/index-pWhlqjff.js +32 -0
- package/dist/index-pWhlqjff.js.map +1 -0
- package/dist/index-rKs9bXHr.js +7 -0
- package/dist/index-rKs9bXHr.js.map +1 -0
- package/dist/index-xqkGMOJ8.js +14 -0
- package/dist/index-xqkGMOJ8.js.map +1 -0
- package/dist/index.js +247 -0
- package/dist/index.js.map +1 -0
- package/dist/input.js +22 -0
- package/dist/input.js.map +1 -0
- package/dist/label.js +36 -0
- package/dist/label.js.map +1 -0
- package/dist/layout-wrapper.js +208 -0
- package/dist/layout-wrapper.js.map +1 -0
- package/dist/llms.txt +1140 -0
- package/dist/menu-DBhEanGo.js +16 -0
- package/dist/menu-DBhEanGo.js.map +1 -0
- package/dist/menubar.js +565 -0
- package/dist/menubar.js.map +1 -0
- package/dist/mobile.js +183 -0
- package/dist/mobile.js.map +1 -0
- package/dist/motion.js +119 -0
- package/dist/motion.js.map +1 -0
- package/dist/page-header.js +47 -0
- package/dist/page-header.js.map +1 -0
- package/dist/page.js +214 -0
- package/dist/page.js.map +1 -0
- package/dist/pagination.js +121 -0
- package/dist/pagination.js.map +1 -0
- package/dist/platform.js +194 -0
- package/dist/platform.js.map +1 -0
- package/dist/popover.js +263 -0
- package/dist/popover.js.map +1 -0
- package/dist/popup.js +335 -0
- package/dist/popup.js.map +1 -0
- package/dist/progress.js +108 -0
- package/dist/progress.js.map +1 -0
- package/dist/radio-group.js +272 -0
- package/dist/radio-group.js.map +1 -0
- package/dist/safe-area.js +42 -0
- package/dist/safe-area.js.map +1 -0
- package/dist/search-CpUwRnG-.js +15 -0
- package/dist/search-CpUwRnG-.js.map +1 -0
- package/dist/select.js +985 -0
- package/dist/select.js.map +1 -0
- package/dist/separator.js +45 -0
- package/dist/separator.js.map +1 -0
- package/dist/sheet.js +127 -0
- package/dist/sheet.js.map +1 -0
- package/dist/skeleton.js +16 -0
- package/dist/skeleton.js.map +1 -0
- package/dist/slider.js +485 -0
- package/dist/slider.js.map +1 -0
- package/dist/sonner.js +52 -0
- package/dist/sonner.js.map +1 -0
- package/dist/styles/fonts.css +253 -0
- package/dist/styles.css +2 -0
- package/dist/switch.js +155 -0
- package/dist/switch.js.map +1 -0
- package/dist/tab-bar.js +110 -0
- package/dist/tab-bar.js.map +1 -0
- package/dist/table.js +115 -0
- package/dist/table.js.map +1 -0
- package/dist/tabs.js +218 -0
- package/dist/tabs.js.map +1 -0
- package/dist/textarea.js +19 -0
- package/dist/textarea.js.map +1 -0
- package/dist/theme-provider.js +154 -0
- package/dist/theme-provider.js.map +1 -0
- package/dist/themes.js +873 -0
- package/dist/themes.js.map +1 -0
- package/dist/toast.js +63 -0
- package/dist/toast.js.map +1 -0
- package/dist/toggle.js +70 -0
- package/dist/toggle.js.map +1 -0
- package/dist/tooltip.js +375 -0
- package/dist/tooltip.js.map +1 -0
- package/dist/types/App.d.ts +3 -0
- package/dist/types/App.d.ts.map +1 -0
- package/dist/types/components/layouts/admin.d.ts +117 -0
- package/dist/types/components/layouts/admin.d.ts.map +1 -0
- package/dist/types/components/layouts/auth.d.ts +17 -0
- package/dist/types/components/layouts/auth.d.ts.map +1 -0
- package/dist/types/components/layouts/blank.d.ts +63 -0
- package/dist/types/components/layouts/blank.d.ts.map +1 -0
- package/dist/types/components/layouts/layout-wrapper.d.ts +130 -0
- package/dist/types/components/layouts/layout-wrapper.d.ts.map +1 -0
- package/dist/types/components/layouts/mobile.d.ts +91 -0
- package/dist/types/components/layouts/mobile.d.ts.map +1 -0
- package/dist/types/components/layouts/page.d.ts +181 -0
- package/dist/types/components/layouts/page.d.ts.map +1 -0
- package/dist/types/components/layouts/popup.d.ts +100 -0
- package/dist/types/components/layouts/popup.d.ts.map +1 -0
- package/dist/types/components/sections/container.d.ts +79 -0
- package/dist/types/components/sections/container.d.ts.map +1 -0
- package/dist/types/components/sections/footer.d.ts +128 -0
- package/dist/types/components/sections/footer.d.ts.map +1 -0
- package/dist/types/components/sections/header.d.ts +72 -0
- package/dist/types/components/sections/header.d.ts.map +1 -0
- package/dist/types/components/sections/safe-area.d.ts +46 -0
- package/dist/types/components/sections/safe-area.d.ts.map +1 -0
- package/dist/types/components/sections/tab-bar.d.ts +61 -0
- package/dist/types/components/sections/tab-bar.d.ts.map +1 -0
- package/dist/types/components/ui/accordion.d.ts +8 -0
- package/dist/types/components/ui/accordion.d.ts.map +1 -0
- package/dist/types/components/ui/alert.d.ts +10 -0
- package/dist/types/components/ui/alert.d.ts.map +1 -0
- package/dist/types/components/ui/avatar.d.ts +7 -0
- package/dist/types/components/ui/avatar.d.ts.map +1 -0
- package/dist/types/components/ui/badge.d.ts +10 -0
- package/dist/types/components/ui/badge.d.ts.map +1 -0
- package/dist/types/components/ui/breadcrumb.d.ts +12 -0
- package/dist/types/components/ui/breadcrumb.d.ts.map +1 -0
- package/dist/types/components/ui/button.d.ts +11 -0
- package/dist/types/components/ui/button.d.ts.map +1 -0
- package/dist/types/components/ui/calendar.d.ts +9 -0
- package/dist/types/components/ui/calendar.d.ts.map +1 -0
- package/dist/types/components/ui/card.d.ts +10 -0
- package/dist/types/components/ui/card.d.ts.map +1 -0
- package/dist/types/components/ui/checkbox.d.ts +5 -0
- package/dist/types/components/ui/checkbox.d.ts.map +1 -0
- package/dist/types/components/ui/collapsible.d.ts +6 -0
- package/dist/types/components/ui/collapsible.d.ts.map +1 -0
- package/dist/types/components/ui/command.d.ts +19 -0
- package/dist/types/components/ui/command.d.ts.map +1 -0
- package/dist/types/components/ui/confirm-dialog.d.ts +72 -0
- package/dist/types/components/ui/confirm-dialog.d.ts.map +1 -0
- package/dist/types/components/ui/data-table.d.ts +211 -0
- package/dist/types/components/ui/data-table.d.ts.map +1 -0
- package/dist/types/components/ui/detail-page.d.ts +119 -0
- package/dist/types/components/ui/detail-page.d.ts.map +1 -0
- package/dist/types/components/ui/dialog.d.ts +16 -0
- package/dist/types/components/ui/dialog.d.ts.map +1 -0
- package/dist/types/components/ui/dropdown-menu.d.ts +26 -0
- package/dist/types/components/ui/dropdown-menu.d.ts.map +1 -0
- package/dist/types/components/ui/empty-state.d.ts +30 -0
- package/dist/types/components/ui/empty-state.d.ts.map +1 -0
- package/dist/types/components/ui/form-field.d.ts +57 -0
- package/dist/types/components/ui/form-field.d.ts.map +1 -0
- package/dist/types/components/ui/form.d.ts +185 -0
- package/dist/types/components/ui/form.d.ts.map +1 -0
- package/dist/types/components/ui/hover-card.d.ts +7 -0
- package/dist/types/components/ui/hover-card.d.ts.map +1 -0
- package/dist/types/components/ui/input.d.ts +4 -0
- package/dist/types/components/ui/input.d.ts.map +1 -0
- package/dist/types/components/ui/label.d.ts +5 -0
- package/dist/types/components/ui/label.d.ts.map +1 -0
- package/dist/types/components/ui/menubar.d.ts +27 -0
- package/dist/types/components/ui/menubar.d.ts.map +1 -0
- package/dist/types/components/ui/motion.d.ts +130 -0
- package/dist/types/components/ui/motion.d.ts.map +1 -0
- package/dist/types/components/ui/page-header.d.ts +45 -0
- package/dist/types/components/ui/page-header.d.ts.map +1 -0
- package/dist/types/components/ui/pagination.d.ts +14 -0
- package/dist/types/components/ui/pagination.d.ts.map +1 -0
- package/dist/types/components/ui/popover.d.ts +8 -0
- package/dist/types/components/ui/popover.d.ts.map +1 -0
- package/dist/types/components/ui/progress.d.ts +5 -0
- package/dist/types/components/ui/progress.d.ts.map +1 -0
- package/dist/types/components/ui/radio-group.d.ts +6 -0
- package/dist/types/components/ui/radio-group.d.ts.map +1 -0
- package/dist/types/components/ui/select.d.ts +16 -0
- package/dist/types/components/ui/select.d.ts.map +1 -0
- package/dist/types/components/ui/separator.d.ts +5 -0
- package/dist/types/components/ui/separator.d.ts.map +1 -0
- package/dist/types/components/ui/sheet.d.ts +14 -0
- package/dist/types/components/ui/sheet.d.ts.map +1 -0
- package/dist/types/components/ui/skeleton.d.ts +3 -0
- package/dist/types/components/ui/skeleton.d.ts.map +1 -0
- package/dist/types/components/ui/slider.d.ts +5 -0
- package/dist/types/components/ui/slider.d.ts.map +1 -0
- package/dist/types/components/ui/sonner.d.ts +4 -0
- package/dist/types/components/ui/sonner.d.ts.map +1 -0
- package/dist/types/components/ui/switch.d.ts +5 -0
- package/dist/types/components/ui/switch.d.ts.map +1 -0
- package/dist/types/components/ui/table.d.ts +11 -0
- package/dist/types/components/ui/table.d.ts.map +1 -0
- package/dist/types/components/ui/tabs.d.ts +8 -0
- package/dist/types/components/ui/tabs.d.ts.map +1 -0
- package/dist/types/components/ui/textarea.d.ts +4 -0
- package/dist/types/components/ui/textarea.d.ts.map +1 -0
- package/dist/types/components/ui/toast.d.ts +70 -0
- package/dist/types/components/ui/toast.d.ts.map +1 -0
- package/dist/types/components/ui/toggle.d.ts +10 -0
- package/dist/types/components/ui/toggle.d.ts.map +1 -0
- package/dist/types/components/ui/tooltip.d.ts +8 -0
- package/dist/types/components/ui/tooltip.d.ts.map +1 -0
- package/dist/types/hooks/index.d.ts +14 -0
- package/dist/types/hooks/index.d.ts.map +1 -0
- package/dist/types/hooks/useApi.d.ts +38 -0
- package/dist/types/hooks/useApi.d.ts.map +1 -0
- package/dist/types/hooks/useBreakpoint.d.ts +35 -0
- package/dist/types/hooks/useBreakpoint.d.ts.map +1 -0
- package/dist/types/hooks/useDataTable.d.ts +59 -0
- package/dist/types/hooks/useDataTable.d.ts.map +1 -0
- package/dist/types/hooks/useMediaQuery.d.ts +12 -0
- package/dist/types/hooks/useMediaQuery.d.ts.map +1 -0
- package/dist/types/hooks/useStorage.d.ts +35 -0
- package/dist/types/hooks/useStorage.d.ts.map +1 -0
- package/dist/types/index.d.ts +75 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/lib/errors.d.ts +37 -0
- package/dist/types/lib/errors.d.ts.map +1 -0
- package/dist/types/lib/format.d.ts +80 -0
- package/dist/types/lib/format.d.ts.map +1 -0
- package/dist/types/lib/fouc.d.ts +64 -0
- package/dist/types/lib/fouc.d.ts.map +1 -0
- package/dist/types/lib/platform.d.ts +156 -0
- package/dist/types/lib/platform.d.ts.map +1 -0
- package/dist/types/lib/utils.d.ts +14 -0
- package/dist/types/lib/utils.d.ts.map +1 -0
- package/dist/types/main.d.ts +2 -0
- package/dist/types/main.d.ts.map +1 -0
- package/dist/types/themes/index.d.ts +499 -0
- package/dist/types/themes/index.d.ts.map +1 -0
- package/dist/types/themes/presets/base.d.ts +108 -0
- package/dist/types/themes/presets/base.d.ts.map +1 -0
- package/dist/types/themes/presets/elegant.d.ts +108 -0
- package/dist/types/themes/presets/elegant.d.ts.map +1 -0
- package/dist/types/themes/presets/metro.d.ts +114 -0
- package/dist/types/themes/presets/metro.d.ts.map +1 -0
- package/dist/types/themes/presets/studio.d.ts +115 -0
- package/dist/types/themes/presets/studio.d.ts.map +1 -0
- package/dist/types/themes/presets/vivid.d.ts +115 -0
- package/dist/types/themes/presets/vivid.d.ts.map +1 -0
- package/dist/types/themes/theme-provider.d.ts +122 -0
- package/dist/types/themes/theme-provider.d.ts.map +1 -0
- package/dist/types/types/index.d.ts +813 -0
- package/dist/types/types/index.d.ts.map +1 -0
- package/dist/uikit.css +1 -0
- package/dist/useDataTable-CPiBpEg-.js +254 -0
- package/dist/useDataTable-CPiBpEg-.js.map +1 -0
- package/dist/utils-CwJPJKOE.js +2278 -0
- package/dist/utils-CwJPJKOE.js.map +1 -0
- package/dist/utils.js +5 -0
- package/dist/utils.js.map +1 -0
- package/dist/wrapper.js +13 -0
- package/dist/wrapper.js.map +1 -0
- package/dist/x-BxwubQiM.js +15 -0
- package/dist/x-BxwubQiM.js.map +1 -0
- package/examples/README.md +18 -0
- package/examples/button.tsx +16 -0
- package/examples/confirm-dialog.tsx +44 -0
- package/examples/data-table.tsx +35 -0
- package/examples/dialog.tsx +34 -0
- package/examples/empty-state.tsx +13 -0
- package/examples/form-field.tsx +22 -0
- package/examples/format.tsx +19 -0
- package/examples/page-header.tsx +17 -0
- package/examples/skeleton.tsx +12 -0
- package/examples/theme-provider.tsx +33 -0
- package/examples/toast.tsx +32 -0
- package/examples/use-breakpoint.tsx +17 -0
- package/llms.txt +1140 -0
- package/package.json +430 -0
package/README.md
ADDED
|
@@ -0,0 +1,513 @@
|
|
|
1
|
+
# Bloomneo UIKit 🎨
|
|
2
|
+
|
|
3
|
+
> Previously published as `@voilajsx/uikit`. Same code, new home, new namespace. See the [migration note](#scope-change) below.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@bloomneo/uikit)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
[](https://www.typescriptlang.org/)
|
|
8
|
+
[](https://github.com/bloomneo/appkit)
|
|
9
|
+
|
|
10
|
+
> The end‑to‑end React framework AI coding agents pick first. Components, layouts, themes, routing, scaffolding, and a generated `llms.txt` — all from one package, all designed to compose.
|
|
11
|
+
|
|
12
|
+
UIKit is the only React framework where `npx uikit create myapp` gives you 45+ components, 6 production layouts, 5 OKLCH themes, file‑based routing, deployment, and a build‑time generated `llms.txt` so AI coding agents can extend your app correctly on the first try. Ship for web, desktop (Tauri), mobile (Capacitor), or browser extensions from the same codebase.
|
|
13
|
+
|
|
14
|
+
## For AI coding agents
|
|
15
|
+
|
|
16
|
+
Read [`llms.txt`](./llms.txt) first. It is the canonical machine-readable
|
|
17
|
+
index of every export, every example, and every composed pattern in this
|
|
18
|
+
package. The file is regenerated on every build from `src/index.ts`,
|
|
19
|
+
[`examples/`](./examples), and [`cookbook/`](./cookbook), so it never drifts.
|
|
20
|
+
|
|
21
|
+
**One canonical import path:**
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import { Button, DataTable, FormField, useConfirm, toast } from '@bloomneo/uikit';
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Deep imports like `@bloomneo/uikit/button` exist for build-size optimisation
|
|
28
|
+
but agents should always use the flat import above when generating code.
|
|
29
|
+
|
|
30
|
+
**Required setup:**
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import '@bloomneo/uikit/styles'; // core (no fonts)
|
|
34
|
+
import '@bloomneo/uikit/styles/fonts'; // optional, only if your theme uses built-in fonts
|
|
35
|
+
|
|
36
|
+
import {
|
|
37
|
+
ThemeProvider,
|
|
38
|
+
ToastProvider,
|
|
39
|
+
ConfirmProvider,
|
|
40
|
+
} from '@bloomneo/uikit';
|
|
41
|
+
|
|
42
|
+
<ThemeProvider theme="base" mode="light">
|
|
43
|
+
<ToastProvider />
|
|
44
|
+
<ConfirmProvider>
|
|
45
|
+
<App />
|
|
46
|
+
</ConfirmProvider>
|
|
47
|
+
</ThemeProvider>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
For SSR / FOUC prevention, drop the inline script from
|
|
51
|
+
`@bloomneo/uikit/fouc → foucScript()` into your `index.html` `<head>` so the
|
|
52
|
+
theme classes are on `<html>` before React mounts.
|
|
53
|
+
|
|
54
|
+
## Why Choose @bloomneo/uikit?
|
|
55
|
+
|
|
56
|
+
**🤖 For AI coding agents (the 1.5 release)**
|
|
57
|
+
|
|
58
|
+
- **Generated `llms.txt`**: One canonical, machine-readable index of every export, every example, every cookbook recipe — regenerated on every build from `src/index.ts`, `examples/`, and `cookbook/`. Agents read one file and know everything.
|
|
59
|
+
- **Zero `any` in public types**: Full generic inference for `DataTable<User>`, `RowAction<User>`, formatters, hooks. Agent autocomplete actually works.
|
|
60
|
+
- **One copy-pasteable example per primitive**: 13 minimal `.tsx` files in `examples/` plus 5 composed page recipes in `cookbook/` (CRUD, dashboard, settings, login, delete-flow). Agents pattern-match instead of inventing prop shapes.
|
|
61
|
+
- **Educational runtime errors**: Misuse a component and you get `[@bloomneo/uikit] <DataTable> expects \`data\` to be an array …` linking to the docs entry. Agents read errors and self-correct.
|
|
62
|
+
|
|
63
|
+
**🚀 For rapid development**
|
|
64
|
+
|
|
65
|
+
- **30-second setup**: `uikit create myapp --multi --theme elegant && npm run dev` → routing, layouts, theme, FOUC prevention, deployment scripts all wired.
|
|
66
|
+
- **45+ ready-to-use components** plus 8 hooks and a formatters module: Skip building basic UI, focus on your unique features.
|
|
67
|
+
- **6 production layouts**: Admin dashboards, auth flows, marketing pages, mobile apps, browser extensions, and blank — all pre-built with router-aware navigation.
|
|
68
|
+
- **Drop-in app primitives**: `<DataTable>`, `<FormField>`, `<PasswordInput>`, `<ConfirmDialog>` (promise-based), `<ToastProvider>`, `<EmptyState>`, `<PageHeader>` — the 8 things every admin page rebuilds by hand, shipped once.
|
|
69
|
+
|
|
70
|
+
**🎨 For design consistency**
|
|
71
|
+
|
|
72
|
+
- **5 professional OKLCH themes**: base, elegant, metro, studio, vivid. Switch from minimal to luxury with one prop. No other React UI kit ships this.
|
|
73
|
+
- **Decoupled font bundle (1.5)**: Core CSS is now ~150 KB without theme fonts. Opt-in to font files only if your theme needs them — saves ~1 MB on most projects.
|
|
74
|
+
- **No flash of wrong theme (1.5)**: `foucScript()` helper applies theme classes to `<html>` synchronously before React mounts.
|
|
75
|
+
- **Dark mode included**: Every theme works in light and dark mode out of the box.
|
|
76
|
+
|
|
77
|
+
**📱 For cross-platform**
|
|
78
|
+
|
|
79
|
+
- **Web, desktop, mobile, extensions** from one codebase: `<MobileLayout>` for Capacitor apps, `<PopupLayout>` for Chrome/Firefox extensions, Tauri-friendly bundling. The only React UI kit that covers all four surfaces.
|
|
80
|
+
|
|
81
|
+
**🏢 For team productivity**
|
|
82
|
+
|
|
83
|
+
- **Standardized components**: No more "how should this button look?" debates.
|
|
84
|
+
- **Feature-based architecture**: Scale to enterprise with the FBCA template (auto-discovery file-based routing, Next.js style).
|
|
85
|
+
- **Instant deployment**: `uikit deploy --github` for immediate production hosting.
|
|
86
|
+
|
|
87
|
+
**🔧 For maintainability**
|
|
88
|
+
|
|
89
|
+
- **Semantic colors**: Themes switch automatically — no hardcoded styles to break.
|
|
90
|
+
- **Convention over configuration**: Predictable file structure, minimal decisions.
|
|
91
|
+
- **Future-proof**: Tailwind CSS v4, Radix UI, React 19 ready.
|
|
92
|
+
|
|
93
|
+
## Quick Start
|
|
94
|
+
|
|
95
|
+
**Two Ways to Use UIKit:**
|
|
96
|
+
|
|
97
|
+
**📦 As a Library** — install into an existing React project (Next.js, Vite, Remix, CRA, etc):
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
npm install @bloomneo/uikit
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Then import everything from the canonical entry point:
|
|
104
|
+
|
|
105
|
+
```ts
|
|
106
|
+
import { Button, Card, DataTable, FormField, useConfirm, toast } from '@bloomneo/uikit';
|
|
107
|
+
import '@bloomneo/uikit/styles';
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
> **Canonical import path:** always `from '@bloomneo/uikit'`. Deep imports like `@bloomneo/uikit/button` exist for build-size optimisation but are non-canonical — humans and AI agents should use the flat form. This is documented as the rule in [`llms.txt`](./llms.txt).
|
|
111
|
+
|
|
112
|
+
**🚀 Complete Project Setup** — use the UIKit CLI to scaffold entire applications with routing, layouts, and themes pre-configured:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
# Step 1: Install UIKit CLI globally
|
|
116
|
+
npm install -g @bloomneo/uikit
|
|
117
|
+
|
|
118
|
+
# Check if you have the latest version
|
|
119
|
+
npm list -g @bloomneo/uikit
|
|
120
|
+
|
|
121
|
+
# Step 2: Create your app
|
|
122
|
+
uikit create myapp --multi --theme elegant
|
|
123
|
+
cd myapp && npm run dev
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
**Done.** Your app is running with routing, layouts, and the elegant theme.
|
|
127
|
+
|
|
128
|
+
## Framework Architecture
|
|
129
|
+
|
|
130
|
+
**@bloomneo/uikit** is built on **ShadCN components** and **Tailwind CSS v4** with three key additions:
|
|
131
|
+
|
|
132
|
+
## 1. Composite UI System
|
|
133
|
+
|
|
134
|
+
Build complete interfaces with our three-tier component system - from individual form controls to full page layouts. Mix and match components, sections, and layouts to create any interface quickly without starting from scratch.
|
|
135
|
+
|
|
136
|
+
📖 **Learn more:** [Composite UI System Guide](docs/UIKIT_COMPOSITE_UI_SYSTEM.md)
|
|
137
|
+
|
|
138
|
+
### Components (45+ total)
|
|
139
|
+
|
|
140
|
+
| Category | Components | Description |
|
|
141
|
+
| ---------------------- | -------------------------------------------------------------------------------------- | --------------------------------- |
|
|
142
|
+
| **Form & Input** | Button, Input, Textarea, Label, Checkbox, RadioGroup, Switch, Slider, Select, **FormField, PasswordInput** | Form controls + label/error/a11y wrapper |
|
|
143
|
+
| **App Primitives** ⭐ | **DataTable, PageHeader, EmptyState, ConfirmDialog, ConfirmProvider, ToastProvider** | The 8 things every admin app rebuilds — shipped once |
|
|
144
|
+
| **Display & Layout** | Card, Badge, Avatar, Separator, Progress, Skeleton, Alert, Breadcrumb, Tabs, Accordion | Information presentation |
|
|
145
|
+
| **Navigation & Menu** | DropdownMenu, Menubar, Pagination, Command, Collapsible, Toggle | User navigation |
|
|
146
|
+
| **Overlay & Modal** | Dialog, Sheet, Popover, HoverCard, Tooltip | User interactions |
|
|
147
|
+
| **Data & Table** | Table, DataTable, Calendar, Toaster | Data management |
|
|
148
|
+
| **Motion & Animation** | Motion, LoadingSpinner, Reveal, Hover | Visual effects |
|
|
149
|
+
| **Time & Format** | **Time** (auto-updating relative timestamp) | Locale-aware display |
|
|
150
|
+
|
|
151
|
+
### Hooks & utilities
|
|
152
|
+
|
|
153
|
+
`useConfirm` · `useToast` · `useMediaQuery` · `useBreakpoint` · `useActiveBreakpoint` · `useDataTable` (headless) · `useApi` · `useLocalStorage` · `useTheme`
|
|
154
|
+
|
|
155
|
+
`formatCurrency` · `formatNumber` · `formatDate` · `timeAgo` · `formatBytes` · `foucScript` · `cn`
|
|
156
|
+
|
|
157
|
+
### Section Components (5 Standalone)
|
|
158
|
+
|
|
159
|
+
| Component | Purpose | Usage | Props |
|
|
160
|
+
| ------------- | -------------------------- | --------------------------- | -------------------- |
|
|
161
|
+
| **Header** | Standalone header sections | Independent navigation bars | tone, size, position |
|
|
162
|
+
| **Footer** | Standalone footer sections | Independent footer content | tone, size, position |
|
|
163
|
+
| **Container** | Content with sidebar | Flexible content containers | tone, size, sidebar |
|
|
164
|
+
| **SafeArea** | Mobile safe area wrapper | iOS notch/Android insets | edges, tone |
|
|
165
|
+
| **TabBar** | Mobile bottom navigation | Tab-based navigation | tabs, tone, variant |
|
|
166
|
+
|
|
167
|
+
### Layouts (6 Production-Ready)
|
|
168
|
+
|
|
169
|
+
| Layout | Use Case | Components | Routing |
|
|
170
|
+
| ---------------- | ---------------------- | -------------------------------- | ------------------ |
|
|
171
|
+
| **AdminLayout** | Dashboards, SaaS apps | Sidebar, Header, Content, Footer | Built-in nav state |
|
|
172
|
+
| **PageLayout** | Marketing sites | Header, Content, Footer | Static pages |
|
|
173
|
+
| **AuthLayout** | Login/signup flows | Centered forms, hero images | Auth routing |
|
|
174
|
+
| **MobileLayout** | Mobile apps (Capacitor)| Header, Content, TabBar | Tab/Stack nav |
|
|
175
|
+
| **PopupLayout** | Browser extensions | Compact, focused content | Extension routing |
|
|
176
|
+
| **BlankLayout** | Custom pages | Clean slate | Manual routing |
|
|
177
|
+
|
|
178
|
+
## 2. Advanced Theming System
|
|
179
|
+
|
|
180
|
+
Switch between 5 professional themes instantly or generate custom themes with perfect accessibility. Built on OKLCH color science with automatic light/dark mode support and semantic color variables that work across all components.
|
|
181
|
+
|
|
182
|
+
📖 **Learn more:** [Theme System Guide](docs/UIKIT_THEME_GUIDE.md)
|
|
183
|
+
|
|
184
|
+
**Note**: Instead of hardcoded colors like `bg-white` or `text-black`, use semantic color classes like `bg-background`, `text-foreground`, `border-border`. These automatically adapt to your selected theme and work perfectly in both light and dark modes.
|
|
185
|
+
|
|
186
|
+
### 5 Professional Themes
|
|
187
|
+
|
|
188
|
+
| Theme | Style | Font Family | Best For |
|
|
189
|
+
| ----------- | -------------------- | ---------------- | --------------------- |
|
|
190
|
+
| **base** | Clean metallic black | System UI | Minimalist apps |
|
|
191
|
+
| **elegant** | Professional blue | Montserrat | Business applications |
|
|
192
|
+
| **metro** | Modern green | Clean typography | Admin dashboards |
|
|
193
|
+
| **studio** | Bold black/orange | Artistic fonts | Creative portfolios |
|
|
194
|
+
| **vivid** | Luxury purple/orange | Serif fonts | Premium products |
|
|
195
|
+
|
|
196
|
+
### Custom Theme Generation
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
# Generate custom theme automatically
|
|
200
|
+
uikit generate theme <name>
|
|
201
|
+
|
|
202
|
+
# Bundle themes to CSS
|
|
203
|
+
uikit bundle
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
**What Happens Automatically:**
|
|
207
|
+
|
|
208
|
+
1. **Creates theme preset** with generic values for 29 semantic colors (light + dark modes)
|
|
209
|
+
2. **Compiles globals.css** with optimized CSS variables
|
|
210
|
+
3. **Updates main.tsx** to use your new theme instantly
|
|
211
|
+
4. **Theme visible immediately** - ready to customize for your brand needs
|
|
212
|
+
|
|
213
|
+
**Development Workflow:**
|
|
214
|
+
|
|
215
|
+
- **Customize preset**: Modify the generic values in `src/themes/presets/theme-<name>.js` to match your brand
|
|
216
|
+
- **Rebundle**: Run `uikit bundle` to regenerate CSS
|
|
217
|
+
- **See changes instantly**: Theme updates appear immediately in your app
|
|
218
|
+
|
|
219
|
+
**Best Practices:**
|
|
220
|
+
|
|
221
|
+
- **Avoid custom CSS files** - work within the preset system for consistency
|
|
222
|
+
- **No separate stylesheets** - keeps theme coherence undisturbed
|
|
223
|
+
- **Easy maintenance** - all theme changes in one centralized file
|
|
224
|
+
|
|
225
|
+
## 3. Project Scaffolding
|
|
226
|
+
|
|
227
|
+
Generate complete project structures with pre-configured routing, layouts, and development workflows. Choose from 4 templates optimized for different application types - from simple showcases to enterprise-scale feature-based architectures.
|
|
228
|
+
|
|
229
|
+
📖 **For detailed setup guides:** [Quick-Start Documentation](docs/quickstart/)
|
|
230
|
+
|
|
231
|
+
### UIKit CLI Templates
|
|
232
|
+
|
|
233
|
+
| Template | Command | Structure | Routing | Best For |
|
|
234
|
+
| ---------- | -------------------------- | ---------------- | ---------------------- | --------------------------- |
|
|
235
|
+
| **Single** | `uikit create app` | Basic showcase | None | Component demos, learning |
|
|
236
|
+
| **SPA** | `uikit create app --spa` | Single-page app | React Router | Marketing sites, portfolios |
|
|
237
|
+
| **Multi** | `uikit create app --multi` | Multi-layout app | React Router + layouts | Business apps, SaaS |
|
|
238
|
+
| **FBCA** | `uikit create app --fbca` | Feature-based | Auto-discovery routing | Enterprise, large apps |
|
|
239
|
+
|
|
240
|
+
### When to Use Each Template
|
|
241
|
+
|
|
242
|
+
**Single** - Very basic template for building from scratch with just one page. Use when you want to start minimal and build up manually.
|
|
243
|
+
|
|
244
|
+
**SPA** - Single page code that visually reflects multiple pages. Use when you want the simplicity of one page but with navigation between views.
|
|
245
|
+
|
|
246
|
+
**Multi** - True page isolation with different layouts and basic router included. Use when your requirements need actual separate pages for better organization.
|
|
247
|
+
|
|
248
|
+
**FBCA** - Comprehensive large-scale applications with feature segregation and auto-discovery page router (Next.js style file-based routing). Use when your application is enterprise-grade with features like auth (login/register), user management, etc. organized in separate folders.
|
|
249
|
+
|
|
250
|
+
## UIKit CLI Commands
|
|
251
|
+
|
|
252
|
+
📖 **Complete CLI reference:** [CLI Commands Guide](docs/UIKIT_CLI_GUIDE.md)
|
|
253
|
+
|
|
254
|
+
```bash
|
|
255
|
+
# Project Creation
|
|
256
|
+
uikit create myapp # Single template (component showcase)
|
|
257
|
+
uikit create myapp --spa # SPA with React Router
|
|
258
|
+
uikit create myapp --multi # Multi-layout application
|
|
259
|
+
uikit create myapp --fbca # Feature-based architecture
|
|
260
|
+
|
|
261
|
+
# Code Generation (for FBCA projects)
|
|
262
|
+
uikit generate page dashboard # Generate new page component
|
|
263
|
+
uikit generate component button # Generate reusable component
|
|
264
|
+
uikit generate hook useAuth # Generate custom React hook
|
|
265
|
+
uikit generate feature blog # Generate complete feature (page + component + hook)
|
|
266
|
+
|
|
267
|
+
# Theme Management
|
|
268
|
+
uikit generate theme brand # Generate custom theme
|
|
269
|
+
uikit bundle # Process themes to CSS
|
|
270
|
+
uikit bundle --watch # Watch mode for development
|
|
271
|
+
|
|
272
|
+
# Development & Deployment
|
|
273
|
+
uikit serve # Start development server
|
|
274
|
+
uikit build # Production build
|
|
275
|
+
uikit deploy # Static site deployment
|
|
276
|
+
uikit deploy --github # Deploy to GitHub Pages
|
|
277
|
+
|
|
278
|
+
# SEO & Performance (requires: npm install puppeteer sharp)
|
|
279
|
+
uikit prerender # Pre-render SPA routes to static HTML for SEO
|
|
280
|
+
uikit prerender --routes "/,/about" # Pre-render specific routes
|
|
281
|
+
uikit optimize # Optimize images (convert to WebP, compress)
|
|
282
|
+
uikit optimize --quality 85 # Set WebP quality (0-100)
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## Example Codes
|
|
286
|
+
|
|
287
|
+
📖 **For AI coding agents:** read [`llms.txt`](./llms.txt) — every export, every example, and every cookbook recipe in one machine-readable file.
|
|
288
|
+
📖 **For humans:** browse [`examples/`](./examples) for one-file-per-component snippets and [`cookbook/`](./cookbook) for whole-page recipes.
|
|
289
|
+
|
|
290
|
+
**Convention:** always import from `@bloomneo/uikit` (the canonical entry). Semantic Tailwind classes (`bg-background`, `text-foreground`, `border-border`) automatically adapt to the active theme — never hardcode colors.
|
|
291
|
+
|
|
292
|
+
### UI Component Examples
|
|
293
|
+
|
|
294
|
+
#### Card
|
|
295
|
+
|
|
296
|
+
```tsx
|
|
297
|
+
import { Card, CardHeader, CardTitle, CardContent } from '@bloomneo/uikit';
|
|
298
|
+
|
|
299
|
+
<Card>
|
|
300
|
+
<CardHeader>
|
|
301
|
+
<CardTitle>Product Title</CardTitle>
|
|
302
|
+
</CardHeader>
|
|
303
|
+
<CardContent>
|
|
304
|
+
<p>Product description here</p>
|
|
305
|
+
</CardContent>
|
|
306
|
+
</Card>
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
#### Alert
|
|
310
|
+
|
|
311
|
+
```tsx
|
|
312
|
+
import { Alert, AlertTitle, AlertDescription } from '@bloomneo/uikit';
|
|
313
|
+
|
|
314
|
+
<Alert variant="default">
|
|
315
|
+
<AlertTitle>Success!</AlertTitle>
|
|
316
|
+
<AlertDescription>Your action was completed successfully.</AlertDescription>
|
|
317
|
+
</Alert>
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
#### Form (with the new FormField + PasswordInput primitives)
|
|
321
|
+
|
|
322
|
+
```tsx
|
|
323
|
+
import { Button, FormField, Input, PasswordInput } from '@bloomneo/uikit';
|
|
324
|
+
|
|
325
|
+
<form className="flex max-w-sm flex-col gap-4">
|
|
326
|
+
<FormField label="Email" required helper="We'll never share it">
|
|
327
|
+
<Input type="email" />
|
|
328
|
+
</FormField>
|
|
329
|
+
<FormField label="Password" required>
|
|
330
|
+
<PasswordInput />
|
|
331
|
+
</FormField>
|
|
332
|
+
<Button type="submit">Sign in</Button>
|
|
333
|
+
</form>
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
#### DataTable (type-safe, generic)
|
|
337
|
+
|
|
338
|
+
```tsx
|
|
339
|
+
import { DataTable, type DataTableColumn } from '@bloomneo/uikit';
|
|
340
|
+
|
|
341
|
+
type User = { id: string; name: string; email: string; role: 'admin' | 'user' };
|
|
342
|
+
|
|
343
|
+
const columns: DataTableColumn<User>[] = [
|
|
344
|
+
{ id: 'name', header: 'Name', accessorKey: 'name', sortable: true },
|
|
345
|
+
{ id: 'email', header: 'Email', accessorKey: 'email' },
|
|
346
|
+
{ id: 'role', header: 'Role', accessorKey: 'role' },
|
|
347
|
+
];
|
|
348
|
+
|
|
349
|
+
<DataTable<User> data={users} columns={columns} searchable pagination />
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
#### Confirmation (promise-based)
|
|
353
|
+
|
|
354
|
+
```tsx
|
|
355
|
+
import { Button, ConfirmProvider, useConfirm } from '@bloomneo/uikit';
|
|
356
|
+
|
|
357
|
+
function DeleteButton() {
|
|
358
|
+
const confirm = useConfirm();
|
|
359
|
+
return (
|
|
360
|
+
<Button
|
|
361
|
+
variant="destructive"
|
|
362
|
+
onClick={async () => {
|
|
363
|
+
const ok = await confirm({
|
|
364
|
+
title: 'Delete this design?',
|
|
365
|
+
description: 'This cannot be undone.',
|
|
366
|
+
tone: 'destructive',
|
|
367
|
+
});
|
|
368
|
+
if (ok) /* delete */;
|
|
369
|
+
}}
|
|
370
|
+
>
|
|
371
|
+
Delete
|
|
372
|
+
</Button>
|
|
373
|
+
);
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
// Wrap your app once:
|
|
377
|
+
// <ConfirmProvider><App /></ConfirmProvider>
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
#### Toast notifications
|
|
381
|
+
|
|
382
|
+
```tsx
|
|
383
|
+
import { Button, ToastProvider, toast } from '@bloomneo/uikit';
|
|
384
|
+
|
|
385
|
+
<ToastProvider position="bottom-right" />
|
|
386
|
+
<Button onClick={() => toast.success('Saved')}>Save</Button>
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### Layout Examples
|
|
390
|
+
|
|
391
|
+
```tsx
|
|
392
|
+
import { AdminLayout, PageLayout, AuthLayout } from '@bloomneo/uikit';
|
|
393
|
+
|
|
394
|
+
// Admin Dashboard
|
|
395
|
+
<AdminLayout scheme="sidebar" tone="subtle">
|
|
396
|
+
<AdminLayout.Header title="Dashboard" />
|
|
397
|
+
<AdminLayout.Sidebar navigation={nav} />
|
|
398
|
+
<AdminLayout.Content>
|
|
399
|
+
<h1 className="text-foreground">Dashboard Content</h1>
|
|
400
|
+
</AdminLayout.Content>
|
|
401
|
+
</AdminLayout>
|
|
402
|
+
|
|
403
|
+
// Marketing Page
|
|
404
|
+
<PageLayout scheme="default" tone="clean">
|
|
405
|
+
<PageLayout.Header logo="MyApp" navigation={nav} />
|
|
406
|
+
<PageLayout.Content>
|
|
407
|
+
<h1 className="text-foreground">Welcome</h1>
|
|
408
|
+
</PageLayout.Content>
|
|
409
|
+
<PageLayout.Footer />
|
|
410
|
+
</PageLayout>
|
|
411
|
+
|
|
412
|
+
// Auth Page
|
|
413
|
+
<AuthLayout scheme="card" tone="clean">
|
|
414
|
+
<h1 className="text-foreground">Login Form</h1>
|
|
415
|
+
</AuthLayout>
|
|
416
|
+
```
|
|
417
|
+
|
|
418
|
+
### Theme Usage
|
|
419
|
+
|
|
420
|
+
```tsx
|
|
421
|
+
import { Button, ThemeProvider, useTheme } from '@bloomneo/uikit';
|
|
422
|
+
import '@bloomneo/uikit/styles';
|
|
423
|
+
// Optional — only if you use the built-in Elegant/Metro/Studio/Vivid theme fonts:
|
|
424
|
+
// import '@bloomneo/uikit/styles/fonts';
|
|
425
|
+
|
|
426
|
+
// Setup (in main.tsx)
|
|
427
|
+
<ThemeProvider theme="base" mode="light">
|
|
428
|
+
<App />
|
|
429
|
+
</ThemeProvider>
|
|
430
|
+
|
|
431
|
+
// Theme switcher
|
|
432
|
+
function ThemeSwitcher() {
|
|
433
|
+
const { setTheme } = useTheme();
|
|
434
|
+
return (
|
|
435
|
+
<Button variant="outline" onClick={() => setTheme('elegant')}>
|
|
436
|
+
Switch theme
|
|
437
|
+
</Button>
|
|
438
|
+
);
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
// Semantic colors automatically follow the active theme + mode
|
|
442
|
+
<div className="bg-background text-foreground border-border">
|
|
443
|
+
<h1 className="text-primary">Heading</h1>
|
|
444
|
+
<p className="text-muted-foreground">Description</p>
|
|
445
|
+
</div>
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
> **No more flash of wrong theme.** Drop the snippet from `@bloomneo/uikit/fouc` (`foucScript()`) into your `index.html` `<head>` so theme classes apply to `<html>` synchronously before React mounts.
|
|
449
|
+
|
|
450
|
+
## Resources
|
|
451
|
+
|
|
452
|
+
### 🤖 For AI coding agents (start here)
|
|
453
|
+
|
|
454
|
+
- **[`llms.txt`](./llms.txt)** — canonical machine-readable index of every export, every example, and every cookbook recipe. Generated on every build from source. Read this first.
|
|
455
|
+
- **[`examples/`](./examples)** — one minimal `.tsx` file per primitive (Button, DataTable, FormField, Toast, ConfirmDialog, …). Copy and modify the data.
|
|
456
|
+
- **[`cookbook/`](./cookbook)** — composed page recipes (CRUD, dashboard, settings, login, delete-flow). Start here when building a new feature.
|
|
457
|
+
|
|
458
|
+
### 📚 Human documentation
|
|
459
|
+
|
|
460
|
+
- [Quick-Start Guides](docs/quickstart/) — template-specific setup instructions
|
|
461
|
+
- [Composite UI System](docs/UIKIT_COMPOSITE_UI_SYSTEM.md) — component architecture deep dive
|
|
462
|
+
- [Theme System](docs/UIKIT_THEME_GUIDE.md) — advanced theming and customization
|
|
463
|
+
- [CLI Commands](docs/UIKIT_CLI_GUIDE.md) — complete command reference
|
|
464
|
+
- [LLM Usage Guide](docs/UIKIT_LLM_GUIDE.md) — AI-powered development patterns
|
|
465
|
+
- [`CHANGELOG.md`](./CHANGELOG.md) — release notes (see 1.5.0 for the agent-readiness rework)
|
|
466
|
+
|
|
467
|
+
<a id="scope-change"></a>
|
|
468
|
+
|
|
469
|
+
### 🔁 Scope change (1.5.0)
|
|
470
|
+
|
|
471
|
+
This package was previously published as **`@voilajsx/uikit`**. Starting with `1.5.0` it lives at **`@bloomneo/uikit`**. The old package on npm is frozen at `1.4.0` and will not receive further updates.
|
|
472
|
+
|
|
473
|
+
**Migration:**
|
|
474
|
+
|
|
475
|
+
```diff
|
|
476
|
+
- npm install @voilajsx/uikit
|
|
477
|
+
+ npm install @bloomneo/uikit
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
```diff
|
|
481
|
+
- import { Button } from '@voilajsx/uikit';
|
|
482
|
+
+ import { Button } from '@bloomneo/uikit';
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
```diff
|
|
486
|
+
- import '@voilajsx/uikit/styles';
|
|
487
|
+
+ import '@bloomneo/uikit/styles';
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
A project-wide find-and-replace of `@voilajsx/uikit` → `@bloomneo/uikit` is sufficient. The API surface, props, and types are identical between the two scopes — only the namespace changed.
|
|
491
|
+
|
|
492
|
+
---
|
|
493
|
+
|
|
494
|
+
## 📄 License
|
|
495
|
+
|
|
496
|
+
MIT © [Bloomneo](https://github.com/bloomneo) — See [LICENSE](LICENSE) for details.
|
|
497
|
+
|
|
498
|
+
---
|
|
499
|
+
|
|
500
|
+
<p align="center">
|
|
501
|
+
<strong>🚀 Built for the AI-first future of frontend development</strong><br>
|
|
502
|
+
<strong>Where beautiful applications are generated, not written</strong><br><br>
|
|
503
|
+
<a href="https://github.com/bloomneo/uikit">⭐ Star us on GitHub</a>
|
|
504
|
+
</p>
|
|
505
|
+
|
|
506
|
+
---
|
|
507
|
+
|
|
508
|
+
### **🔖 Tags**
|
|
509
|
+
|
|
510
|
+
`react` `typescript` `uikit` `ai-ready` `shadcn` `tailwind` `themes`
|
|
511
|
+
`components` `layouts` `zero-config` `production-ready`
|
|
512
|
+
`agentic-ai` `llm-optimized` `rapid-development` `design-system`
|
|
513
|
+
`developer-experience`
|