shared-lib-web 0.0.0-stage → 0.0.3
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/CODING_RULES.md +118 -0
- package/LICENSE +21 -0
- package/README.md +884 -2
- package/dist/components/app-brand.d.ts +9 -0
- package/dist/components/app-brand.d.ts.map +1 -0
- package/dist/components/app-brand.js +27 -0
- package/dist/components/app-brand.js.map +1 -0
- package/dist/components/branch-switcher.d.ts +7 -0
- package/dist/components/branch-switcher.d.ts.map +1 -0
- package/dist/components/branch-switcher.js +37 -0
- package/dist/components/branch-switcher.js.map +1 -0
- package/dist/components/coming-soon.d.ts +6 -0
- package/dist/components/coming-soon.d.ts.map +1 -0
- package/dist/components/coming-soon.js +20 -0
- package/dist/components/coming-soon.js.map +1 -0
- package/dist/components/empty-state.d.ts +15 -0
- package/dist/components/empty-state.d.ts.map +1 -0
- package/dist/components/empty-state.js +14 -0
- package/dist/components/empty-state.js.map +1 -0
- package/dist/components/language-switcher.d.ts +12 -0
- package/dist/components/language-switcher.d.ts.map +1 -0
- package/dist/components/language-switcher.js +61 -0
- package/dist/components/language-switcher.js.map +1 -0
- package/dist/components/page-loader.d.ts +2 -0
- package/dist/components/page-loader.d.ts.map +1 -0
- package/dist/components/page-loader.js +8 -0
- package/dist/components/page-loader.js.map +1 -0
- package/dist/components/page-not-found.d.ts +2 -0
- package/dist/components/page-not-found.d.ts.map +1 -0
- package/dist/components/page-not-found.js +18 -0
- package/dist/components/page-not-found.js.map +1 -0
- package/dist/components/permission-denied.d.ts +2 -0
- package/dist/components/permission-denied.d.ts.map +1 -0
- package/dist/components/permission-denied.js +12 -0
- package/dist/components/permission-denied.js.map +1 -0
- package/dist/components/require-access.d.ts +11 -0
- package/dist/components/require-access.d.ts.map +1 -0
- package/dist/components/require-access.js +15 -0
- package/dist/components/require-access.js.map +1 -0
- package/dist/components/scroll-to-top.d.ts +12 -0
- package/dist/components/scroll-to-top.d.ts.map +1 -0
- package/dist/components/scroll-to-top.js +42 -0
- package/dist/components/scroll-to-top.js.map +1 -0
- package/dist/components/settings-menu.d.ts +21 -0
- package/dist/components/settings-menu.d.ts.map +1 -0
- package/dist/components/settings-menu.js +115 -0
- package/dist/components/settings-menu.js.map +1 -0
- package/dist/components/theme-switcher.d.ts +5 -0
- package/dist/components/theme-switcher.d.ts.map +1 -0
- package/dist/components/theme-switcher.js +33 -0
- package/dist/components/theme-switcher.js.map +1 -0
- package/dist/components/toast-container.d.ts +5 -0
- package/dist/components/toast-container.d.ts.map +1 -0
- package/dist/components/toast-container.js +51 -0
- package/dist/components/toast-container.js.map +1 -0
- package/dist/components/top-progress.d.ts +2 -0
- package/dist/components/top-progress.d.ts.map +1 -0
- package/dist/components/top-progress.js +14 -0
- package/dist/components/top-progress.js.map +1 -0
- package/dist/components/user-menu.d.ts +26 -0
- package/dist/components/user-menu.d.ts.map +1 -0
- package/dist/components/user-menu.js +85 -0
- package/dist/components/user-menu.js.map +1 -0
- package/dist/context/ui-context.d.ts +5 -0
- package/dist/context/ui-context.d.ts.map +1 -0
- package/dist/context/ui-context.js +16 -0
- package/dist/context/ui-context.js.map +1 -0
- package/dist/context/use-ui.d.ts +3 -0
- package/dist/context/use-ui.d.ts.map +1 -0
- package/dist/context/use-ui.js +40 -0
- package/dist/context/use-ui.js.map +1 -0
- package/dist/i18n/browser-language.d.ts +9 -0
- package/dist/i18n/browser-language.d.ts.map +1 -0
- package/dist/i18n/browser-language.js +89 -0
- package/dist/i18n/browser-language.js.map +1 -0
- package/dist/i18n/default-messages.d.ts +5 -0
- package/dist/i18n/default-messages.d.ts.map +1 -0
- package/dist/i18n/default-messages.js +67 -0
- package/dist/i18n/default-messages.js.map +1 -0
- package/dist/i18n/direction.d.ts +10 -0
- package/dist/i18n/direction.d.ts.map +1 -0
- package/dist/i18n/direction.js +35 -0
- package/dist/i18n/direction.js.map +1 -0
- package/dist/i18n/locale-groups.d.ts +18 -0
- package/dist/i18n/locale-groups.d.ts.map +1 -0
- package/dist/i18n/locale-groups.js +74 -0
- package/dist/i18n/locale-groups.js.map +1 -0
- package/dist/i18n/locale-service.d.ts +54 -0
- package/dist/i18n/locale-service.d.ts.map +1 -0
- package/dist/i18n/locale-service.js +231 -0
- package/dist/i18n/locale-service.js.map +1 -0
- package/dist/i18n/locale-signal.d.ts +18 -0
- package/dist/i18n/locale-signal.d.ts.map +1 -0
- package/dist/i18n/locale-signal.js +142 -0
- package/dist/i18n/locale-signal.js.map +1 -0
- package/dist/i18n/translator.d.ts +21 -0
- package/dist/i18n/translator.d.ts.map +1 -0
- package/dist/i18n/translator.js +105 -0
- package/dist/i18n/translator.js.map +1 -0
- package/dist/index.d.ts +117 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +130 -0
- package/dist/index.js.map +1 -0
- package/dist/interfaces/app-types.d.ts +143 -0
- package/dist/interfaces/app-types.d.ts.map +1 -0
- package/dist/interfaces/app-types.js +5 -0
- package/dist/interfaces/app-types.js.map +1 -0
- package/dist/interfaces/toast.d.ts +9 -0
- package/dist/interfaces/toast.d.ts.map +1 -0
- package/dist/interfaces/toast.js +4 -0
- package/dist/interfaces/toast.js.map +1 -0
- package/dist/interfaces/ui-config.d.ts +319 -0
- package/dist/interfaces/ui-config.d.ts.map +1 -0
- package/dist/interfaces/ui-config.js +6 -0
- package/dist/interfaces/ui-config.js.map +1 -0
- package/dist/interfaces/ui-context.d.ts +37 -0
- package/dist/interfaces/ui-context.d.ts.map +1 -0
- package/dist/interfaces/ui-context.js +4 -0
- package/dist/interfaces/ui-context.js.map +1 -0
- package/dist/layout.d.ts +10 -0
- package/dist/layout.d.ts.map +1 -0
- package/dist/layout.js +22 -0
- package/dist/layout.js.map +1 -0
- package/dist/layouts/app-layout.d.ts +23 -0
- package/dist/layouts/app-layout.d.ts.map +1 -0
- package/dist/layouts/app-layout.js +52 -0
- package/dist/layouts/app-layout.js.map +1 -0
- package/dist/layouts/article-layout.d.ts +7 -0
- package/dist/layouts/article-layout.d.ts.map +1 -0
- package/dist/layouts/article-layout.js +8 -0
- package/dist/layouts/article-layout.js.map +1 -0
- package/dist/layouts/aside-layout.d.ts +27 -0
- package/dist/layouts/aside-layout.d.ts.map +1 -0
- package/dist/layouts/aside-layout.js +70 -0
- package/dist/layouts/aside-layout.js.map +1 -0
- package/dist/layouts/auth-layout.d.ts +7 -0
- package/dist/layouts/auth-layout.d.ts.map +1 -0
- package/dist/layouts/auth-layout.js +20 -0
- package/dist/layouts/auth-layout.js.map +1 -0
- package/dist/layouts/content-layout.d.ts +3 -0
- package/dist/layouts/content-layout.d.ts.map +1 -0
- package/dist/layouts/content-layout.js +10 -0
- package/dist/layouts/content-layout.js.map +1 -0
- package/dist/layouts/float-layout.d.ts +3 -0
- package/dist/layouts/float-layout.d.ts.map +1 -0
- package/dist/layouts/float-layout.js +10 -0
- package/dist/layouts/float-layout.js.map +1 -0
- package/dist/layouts/grid-layout.d.ts +3 -0
- package/dist/layouts/grid-layout.d.ts.map +1 -0
- package/dist/layouts/grid-layout.js +10 -0
- package/dist/layouts/grid-layout.js.map +1 -0
- package/dist/layouts/head-layout.d.ts +16 -0
- package/dist/layouts/head-layout.d.ts.map +1 -0
- package/dist/layouts/head-layout.js +36 -0
- package/dist/layouts/head-layout.js.map +1 -0
- package/dist/layouts/header.d.ts +18 -0
- package/dist/layouts/header.d.ts.map +1 -0
- package/dist/layouts/header.js +26 -0
- package/dist/layouts/header.js.map +1 -0
- package/dist/layouts/layout-constants.d.ts +3 -0
- package/dist/layouts/layout-constants.d.ts.map +1 -0
- package/dist/layouts/layout-constants.js +5 -0
- package/dist/layouts/layout-constants.js.map +1 -0
- package/dist/layouts/mega-menu.d.ts +3 -0
- package/dist/layouts/mega-menu.d.ts.map +1 -0
- package/dist/layouts/mega-menu.js +104 -0
- package/dist/layouts/mega-menu.js.map +1 -0
- package/dist/layouts/navigation.d.ts +11 -0
- package/dist/layouts/navigation.d.ts.map +1 -0
- package/dist/layouts/navigation.js +41 -0
- package/dist/layouts/navigation.js.map +1 -0
- package/dist/layouts/rail-flyout.d.ts +5 -0
- package/dist/layouts/rail-flyout.d.ts.map +1 -0
- package/dist/layouts/rail-flyout.js +49 -0
- package/dist/layouts/rail-flyout.js.map +1 -0
- package/dist/layouts/rail-tooltip.d.ts +8 -0
- package/dist/layouts/rail-tooltip.d.ts.map +1 -0
- package/dist/layouts/rail-tooltip.js +60 -0
- package/dist/layouts/rail-tooltip.js.map +1 -0
- package/dist/layouts/sidebar.d.ts +38 -0
- package/dist/layouts/sidebar.d.ts.map +1 -0
- package/dist/layouts/sidebar.js +137 -0
- package/dist/layouts/sidebar.js.map +1 -0
- package/dist/markdown.d.ts +4 -0
- package/dist/markdown.d.ts.map +1 -0
- package/dist/markdown.js +12 -0
- package/dist/markdown.js.map +1 -0
- package/dist/providers/provider-effects.d.ts +9 -0
- package/dist/providers/provider-effects.d.ts.map +1 -0
- package/dist/providers/provider-effects.js +29 -0
- package/dist/providers/provider-effects.js.map +1 -0
- package/dist/providers/register-config.d.ts +4 -0
- package/dist/providers/register-config.d.ts.map +1 -0
- package/dist/providers/register-config.js +30 -0
- package/dist/providers/register-config.js.map +1 -0
- package/dist/providers/shared-web-ui-provider.d.ts +19 -0
- package/dist/providers/shared-web-ui-provider.d.ts.map +1 -0
- package/dist/providers/shared-web-ui-provider.js +53 -0
- package/dist/providers/shared-web-ui-provider.js.map +1 -0
- package/dist/providers/theme-provider.d.ts +6 -0
- package/dist/providers/theme-provider.d.ts.map +1 -0
- package/dist/providers/theme-provider.js +11 -0
- package/dist/providers/theme-provider.js.map +1 -0
- package/dist/providers/translation-provider.d.ts +8 -0
- package/dist/providers/translation-provider.d.ts.map +1 -0
- package/dist/providers/translation-provider.js +21 -0
- package/dist/providers/translation-provider.js.map +1 -0
- package/dist/query/page-link.d.ts +20 -0
- package/dist/query/page-link.d.ts.map +1 -0
- package/dist/query/page-link.js +53 -0
- package/dist/query/page-link.js.map +1 -0
- package/dist/query/page-path.d.ts +5 -0
- package/dist/query/page-path.d.ts.map +1 -0
- package/dist/query/page-path.js +24 -0
- package/dist/query/page-path.js.map +1 -0
- package/dist/query/query-param.d.ts +66 -0
- package/dist/query/query-param.d.ts.map +1 -0
- package/dist/query/query-param.js +218 -0
- package/dist/query/query-param.js.map +1 -0
- package/dist/query/use-query-param.d.ts +5 -0
- package/dist/query/use-query-param.d.ts.map +1 -0
- package/dist/query/use-query-param.js +21 -0
- package/dist/query/use-query-param.js.map +1 -0
- package/dist/skeleton/skeleton-article.d.ts +2 -0
- package/dist/skeleton/skeleton-article.d.ts.map +1 -0
- package/dist/skeleton/skeleton-article.js +7 -0
- package/dist/skeleton/skeleton-article.js.map +1 -0
- package/dist/skeleton/skeleton-auth-form.d.ts +6 -0
- package/dist/skeleton/skeleton-auth-form.d.ts.map +1 -0
- package/dist/skeleton/skeleton-auth-form.js +9 -0
- package/dist/skeleton/skeleton-auth-form.js.map +1 -0
- package/dist/skeleton/skeleton-cards.d.ts +6 -0
- package/dist/skeleton/skeleton-cards.d.ts.map +1 -0
- package/dist/skeleton/skeleton-cards.js +16 -0
- package/dist/skeleton/skeleton-cards.js.map +1 -0
- package/dist/skeleton/skeleton-chat.d.ts +2 -0
- package/dist/skeleton/skeleton-chat.d.ts.map +1 -0
- package/dist/skeleton/skeleton-chat.js +17 -0
- package/dist/skeleton/skeleton-chat.js.map +1 -0
- package/dist/skeleton/skeleton-dashboard.d.ts +2 -0
- package/dist/skeleton/skeleton-dashboard.d.ts.map +1 -0
- package/dist/skeleton/skeleton-dashboard.js +16 -0
- package/dist/skeleton/skeleton-dashboard.js.map +1 -0
- package/dist/skeleton/skeleton-float.d.ts +2 -0
- package/dist/skeleton/skeleton-float.d.ts.map +1 -0
- package/dist/skeleton/skeleton-float.js +7 -0
- package/dist/skeleton/skeleton-float.js.map +1 -0
- package/dist/skeleton/skeleton-form.d.ts +10 -0
- package/dist/skeleton/skeleton-form.d.ts.map +1 -0
- package/dist/skeleton/skeleton-form.js +16 -0
- package/dist/skeleton/skeleton-form.js.map +1 -0
- package/dist/skeleton/skeleton-menu.d.ts +2 -0
- package/dist/skeleton/skeleton-menu.d.ts.map +1 -0
- package/dist/skeleton/skeleton-menu.js +16 -0
- package/dist/skeleton/skeleton-menu.js.map +1 -0
- package/dist/skeleton/skeleton-page.d.ts +2 -0
- package/dist/skeleton/skeleton-page.d.ts.map +1 -0
- package/dist/skeleton/skeleton-page.js +9 -0
- package/dist/skeleton/skeleton-page.js.map +1 -0
- package/dist/skeleton/skeleton-table.d.ts +2 -0
- package/dist/skeleton/skeleton-table.d.ts.map +1 -0
- package/dist/skeleton/skeleton-table.js +16 -0
- package/dist/skeleton/skeleton-table.js.map +1 -0
- package/dist/state/api-loader.d.ts +19 -0
- package/dist/state/api-loader.d.ts.map +1 -0
- package/dist/state/api-loader.js +187 -0
- package/dist/state/api-loader.js.map +1 -0
- package/dist/state/auth-service.d.ts +32 -0
- package/dist/state/auth-service.d.ts.map +1 -0
- package/dist/state/auth-service.js +136 -0
- package/dist/state/auth-service.js.map +1 -0
- package/dist/state/branch-service.d.ts +42 -0
- package/dist/state/branch-service.d.ts.map +1 -0
- package/dist/state/branch-service.js +193 -0
- package/dist/state/branch-service.js.map +1 -0
- package/dist/state/company-service.d.ts +16 -0
- package/dist/state/company-service.d.ts.map +1 -0
- package/dist/state/company-service.js +97 -0
- package/dist/state/company-service.js.map +1 -0
- package/dist/state/document-sync.d.ts +7 -0
- package/dist/state/document-sync.d.ts.map +1 -0
- package/dist/state/document-sync.js +39 -0
- package/dist/state/document-sync.js.map +1 -0
- package/dist/state/language-service.d.ts +19 -0
- package/dist/state/language-service.d.ts.map +1 -0
- package/dist/state/language-service.js +78 -0
- package/dist/state/language-service.js.map +1 -0
- package/dist/state/layout-choice-service.d.ts +10 -0
- package/dist/state/layout-choice-service.d.ts.map +1 -0
- package/dist/state/layout-choice-service.js +34 -0
- package/dist/state/layout-choice-service.js.map +1 -0
- package/dist/state/menu-service.d.ts +20 -0
- package/dist/state/menu-service.d.ts.map +1 -0
- package/dist/state/menu-service.js +59 -0
- package/dist/state/menu-service.js.map +1 -0
- package/dist/state/navigation-service.d.ts +37 -0
- package/dist/state/navigation-service.d.ts.map +1 -0
- package/dist/state/navigation-service.js +131 -0
- package/dist/state/navigation-service.js.map +1 -0
- package/dist/state/preference-sync.d.ts +15 -0
- package/dist/state/preference-sync.d.ts.map +1 -0
- package/dist/state/preference-sync.js +93 -0
- package/dist/state/preference-sync.js.map +1 -0
- package/dist/state/progress-service.d.ts +3 -0
- package/dist/state/progress-service.d.ts.map +1 -0
- package/dist/state/progress-service.js +17 -0
- package/dist/state/progress-service.js.map +1 -0
- package/dist/state/screen-access.d.ts +15 -0
- package/dist/state/screen-access.d.ts.map +1 -0
- package/dist/state/screen-access.js +60 -0
- package/dist/state/screen-access.js.map +1 -0
- package/dist/state/sidebar-service.d.ts +8 -0
- package/dist/state/sidebar-service.d.ts.map +1 -0
- package/dist/state/sidebar-service.js +18 -0
- package/dist/state/sidebar-service.js.map +1 -0
- package/dist/state/signals.d.ts +92 -0
- package/dist/state/signals.d.ts.map +1 -0
- package/dist/state/signals.js +161 -0
- package/dist/state/signals.js.map +1 -0
- package/dist/state/toast-service.d.ts +9 -0
- package/dist/state/toast-service.d.ts.map +1 -0
- package/dist/state/toast-service.js +36 -0
- package/dist/state/toast-service.js.map +1 -0
- package/dist/styles.css +15 -0
- package/dist/theme/custom-themes.d.ts +28 -0
- package/dist/theme/custom-themes.d.ts.map +1 -0
- package/dist/theme/custom-themes.js +218 -0
- package/dist/theme/custom-themes.js.map +1 -0
- package/dist/theme/dark-themes.d.ts +10 -0
- package/dist/theme/dark-themes.d.ts.map +1 -0
- package/dist/theme/dark-themes.js +92 -0
- package/dist/theme/dark-themes.js.map +1 -0
- package/dist/theme/logo.d.ts +7 -0
- package/dist/theme/logo.d.ts.map +1 -0
- package/dist/theme/logo.js +24 -0
- package/dist/theme/logo.js.map +1 -0
- package/dist/theme/theme-service.d.ts +32 -0
- package/dist/theme/theme-service.d.ts.map +1 -0
- package/dist/theme/theme-service.js +123 -0
- package/dist/theme/theme-service.js.map +1 -0
- package/dist/types/class-names.d.ts +9 -0
- package/dist/types/class-names.d.ts.map +1 -0
- package/dist/types/class-names.js +45 -0
- package/dist/types/class-names.js.map +1 -0
- package/dist/types/field-error.d.ts +5 -0
- package/dist/types/field-error.d.ts.map +1 -0
- package/dist/types/field-error.js +16 -0
- package/dist/types/field-error.js.map +1 -0
- package/dist/types/field-props.d.ts +20 -0
- package/dist/types/field-props.d.ts.map +1 -0
- package/dist/types/field-props.js +4 -0
- package/dist/types/field-props.js.map +1 -0
- package/dist/types/field-registry.d.ts +11 -0
- package/dist/types/field-registry.d.ts.map +1 -0
- package/dist/types/field-registry.js +18 -0
- package/dist/types/field-registry.js.map +1 -0
- package/dist/types/field-wrapper.d.ts +13 -0
- package/dist/types/field-wrapper.d.ts.map +1 -0
- package/dist/types/field-wrapper.js +16 -0
- package/dist/types/field-wrapper.js.map +1 -0
- package/dist/types/lang-field.d.ts +15 -0
- package/dist/types/lang-field.d.ts.map +1 -0
- package/dist/types/lang-field.js +68 -0
- package/dist/types/lang-field.js.map +1 -0
- package/dist/types/markdown-color-mode.d.ts +7 -0
- package/dist/types/markdown-color-mode.d.ts.map +1 -0
- package/dist/types/markdown-color-mode.js +11 -0
- package/dist/types/markdown-color-mode.js.map +1 -0
- package/dist/types/media-service.d.ts +24 -0
- package/dist/types/media-service.d.ts.map +1 -0
- package/dist/types/media-service.js +41 -0
- package/dist/types/media-service.js.map +1 -0
- package/dist/types/media-viewer.d.ts +2 -0
- package/dist/types/media-viewer.d.ts.map +1 -0
- package/dist/types/media-viewer.js +23 -0
- package/dist/types/media-viewer.js.map +1 -0
- package/dist/types/type.button.d.ts +36 -0
- package/dist/types/type.button.d.ts.map +1 -0
- package/dist/types/type.button.js +27 -0
- package/dist/types/type.button.js.map +1 -0
- package/dist/types/type.checkbox.d.ts +5 -0
- package/dist/types/type.checkbox.d.ts.map +1 -0
- package/dist/types/type.checkbox.js +26 -0
- package/dist/types/type.checkbox.js.map +1 -0
- package/dist/types/type.confirm.d.ts +19 -0
- package/dist/types/type.confirm.d.ts.map +1 -0
- package/dist/types/type.confirm.js +15 -0
- package/dist/types/type.confirm.js.map +1 -0
- package/dist/types/type.date.d.ts +16 -0
- package/dist/types/type.date.d.ts.map +1 -0
- package/dist/types/type.date.js +65 -0
- package/dist/types/type.date.js.map +1 -0
- package/dist/types/type.drawer.d.ts +20 -0
- package/dist/types/type.drawer.d.ts.map +1 -0
- package/dist/types/type.drawer.js +31 -0
- package/dist/types/type.drawer.js.map +1 -0
- package/dist/types/type.dropdown.d.ts +23 -0
- package/dist/types/type.dropdown.d.ts.map +1 -0
- package/dist/types/type.dropdown.js +34 -0
- package/dist/types/type.dropdown.js.map +1 -0
- package/dist/types/type.filter.d.ts +17 -0
- package/dist/types/type.filter.d.ts.map +1 -0
- package/dist/types/type.filter.js +28 -0
- package/dist/types/type.filter.js.map +1 -0
- package/dist/types/type.icon.d.ts +21 -0
- package/dist/types/type.icon.d.ts.map +1 -0
- package/dist/types/type.icon.js +24 -0
- package/dist/types/type.icon.js.map +1 -0
- package/dist/types/type.image.d.ts +34 -0
- package/dist/types/type.image.d.ts.map +1 -0
- package/dist/types/type.image.js +46 -0
- package/dist/types/type.image.js.map +1 -0
- package/dist/types/type.input.d.ts +13 -0
- package/dist/types/type.input.d.ts.map +1 -0
- package/dist/types/type.input.js +29 -0
- package/dist/types/type.input.js.map +1 -0
- package/dist/types/type.lang-md.d.ts +10 -0
- package/dist/types/type.lang-md.d.ts.map +1 -0
- package/dist/types/type.lang-md.js +56 -0
- package/dist/types/type.lang-md.js.map +1 -0
- package/dist/types/type.lang.d.ts +11 -0
- package/dist/types/type.lang.d.ts.map +1 -0
- package/dist/types/type.lang.js +56 -0
- package/dist/types/type.lang.js.map +1 -0
- package/dist/types/type.list.d.ts +13 -0
- package/dist/types/type.list.d.ts.map +1 -0
- package/dist/types/type.list.js +42 -0
- package/dist/types/type.list.js.map +1 -0
- package/dist/types/type.mdv.d.ts +10 -0
- package/dist/types/type.mdv.d.ts.map +1 -0
- package/dist/types/type.mdv.js +22 -0
- package/dist/types/type.mdv.js.map +1 -0
- package/dist/types/type.mdx.d.ts +10 -0
- package/dist/types/type.mdx.d.ts.map +1 -0
- package/dist/types/type.mdx.js +30 -0
- package/dist/types/type.mdx.js.map +1 -0
- package/dist/types/type.modal.d.ts +18 -0
- package/dist/types/type.modal.d.ts.map +1 -0
- package/dist/types/type.modal.js +30 -0
- package/dist/types/type.modal.js.map +1 -0
- package/dist/types/type.otp.d.ts +8 -0
- package/dist/types/type.otp.d.ts.map +1 -0
- package/dist/types/type.otp.js +48 -0
- package/dist/types/type.otp.js.map +1 -0
- package/dist/types/type.search.d.ts +16 -0
- package/dist/types/type.search.d.ts.map +1 -0
- package/dist/types/type.search.js +48 -0
- package/dist/types/type.search.js.map +1 -0
- package/dist/types/type.select.d.ts +14 -0
- package/dist/types/type.select.d.ts.map +1 -0
- package/dist/types/type.select.js +53 -0
- package/dist/types/type.select.js.map +1 -0
- package/dist/types/type.switch.d.ts +8 -0
- package/dist/types/type.switch.d.ts.map +1 -0
- package/dist/types/type.switch.js +26 -0
- package/dist/types/type.switch.js.map +1 -0
- package/dist/types/type.table.d.ts +28 -0
- package/dist/types/type.table.d.ts.map +1 -0
- package/dist/types/type.table.js +72 -0
- package/dist/types/type.table.js.map +1 -0
- package/dist/types/type.text-area.d.ts +9 -0
- package/dist/types/type.text-area.d.ts.map +1 -0
- package/dist/types/type.text-area.js +26 -0
- package/dist/types/type.text-area.js.map +1 -0
- package/dist/types/type.time.d.ts +9 -0
- package/dist/types/type.time.d.ts.map +1 -0
- package/dist/types/type.time.js +34 -0
- package/dist/types/type.time.js.map +1 -0
- package/dist/types/type.upload.d.ts +45 -0
- package/dist/types/type.upload.d.ts.map +1 -0
- package/dist/types/type.upload.js +90 -0
- package/dist/types/type.upload.js.map +1 -0
- package/dist/types/type.video.d.ts +19 -0
- package/dist/types/type.video.d.ts.map +1 -0
- package/dist/types/type.video.js +33 -0
- package/dist/types/type.video.js.map +1 -0
- package/dist/types/upload-service.d.ts +47 -0
- package/dist/types/upload-service.d.ts.map +1 -0
- package/dist/types/upload-service.js +191 -0
- package/dist/types/upload-service.js.map +1 -0
- package/dist/utils/app-config.d.ts +6 -0
- package/dist/utils/app-config.d.ts.map +1 -0
- package/dist/utils/app-config.js +17 -0
- package/dist/utils/app-config.js.map +1 -0
- package/dist/utils/app-http.d.ts +77 -0
- package/dist/utils/app-http.d.ts.map +1 -0
- package/dist/utils/app-http.js +331 -0
- package/dist/utils/app-http.js.map +1 -0
- package/dist/utils/app-storage.d.ts +56 -0
- package/dist/utils/app-storage.d.ts.map +1 -0
- package/dist/utils/app-storage.js +236 -0
- package/dist/utils/app-storage.js.map +1 -0
- package/dist/utils/content-util.d.ts +6 -0
- package/dist/utils/content-util.d.ts.map +1 -0
- package/dist/utils/content-util.js +45 -0
- package/dist/utils/content-util.js.map +1 -0
- package/dist/utils/crypto-util.d.ts +15 -0
- package/dist/utils/crypto-util.d.ts.map +1 -0
- package/dist/utils/crypto-util.js +76 -0
- package/dist/utils/crypto-util.js.map +1 -0
- package/dist/utils/error-util.d.ts +3 -0
- package/dist/utils/error-util.d.ts.map +1 -0
- package/dist/utils/error-util.js +58 -0
- package/dist/utils/error-util.js.map +1 -0
- package/dist/utils/event-util.d.ts +16 -0
- package/dist/utils/event-util.d.ts.map +1 -0
- package/dist/utils/event-util.js +51 -0
- package/dist/utils/event-util.js.map +1 -0
- package/dist/utils/file-util.d.ts +30 -0
- package/dist/utils/file-util.d.ts.map +1 -0
- package/dist/utils/file-util.js +165 -0
- package/dist/utils/file-util.js.map +1 -0
- package/dist/utils/lang-util.d.ts +12 -0
- package/dist/utils/lang-util.d.ts.map +1 -0
- package/dist/utils/lang-util.js +53 -0
- package/dist/utils/lang-util.js.map +1 -0
- package/dist/utils/language-util.d.ts +21 -0
- package/dist/utils/language-util.d.ts.map +1 -0
- package/dist/utils/language-util.js +96 -0
- package/dist/utils/language-util.js.map +1 -0
- package/dist/utils/leave-guard.d.ts +5 -0
- package/dist/utils/leave-guard.d.ts.map +1 -0
- package/dist/utils/leave-guard.js +24 -0
- package/dist/utils/leave-guard.js.map +1 -0
- package/dist/utils/lucide-icon.d.ts +10 -0
- package/dist/utils/lucide-icon.d.ts.map +1 -0
- package/dist/utils/lucide-icon.js +48 -0
- package/dist/utils/lucide-icon.js.map +1 -0
- package/dist/utils/menu-util.d.ts +33 -0
- package/dist/utils/menu-util.d.ts.map +1 -0
- package/dist/utils/menu-util.js +151 -0
- package/dist/utils/menu-util.js.map +1 -0
- package/dist/utils/option-util.d.ts +21 -0
- package/dist/utils/option-util.d.ts.map +1 -0
- package/dist/utils/option-util.js +101 -0
- package/dist/utils/option-util.js.map +1 -0
- package/dist/utils/session-id.d.ts +5 -0
- package/dist/utils/session-id.d.ts.map +1 -0
- package/dist/utils/session-id.js +44 -0
- package/dist/utils/session-id.js.map +1 -0
- package/dist/utils/shared-regexp.d.ts +31 -0
- package/dist/utils/shared-regexp.d.ts.map +1 -0
- package/dist/utils/shared-regexp.js +17 -0
- package/dist/utils/shared-regexp.js.map +1 -0
- package/dist/utils/signal-source.d.ts +4 -0
- package/dist/utils/signal-source.d.ts.map +1 -0
- package/dist/utils/signal-source.js +13 -0
- package/dist/utils/signal-source.js.map +1 -0
- package/dist/utils/storage-keys.d.ts +73 -0
- package/dist/utils/storage-keys.d.ts.map +1 -0
- package/dist/utils/storage-keys.js +80 -0
- package/dist/utils/storage-keys.js.map +1 -0
- package/package.json +101 -4
- package/src/components/app-brand.tsx +41 -0
- package/src/components/branch-switcher.tsx +74 -0
- package/src/components/coming-soon.tsx +36 -0
- package/src/components/empty-state.tsx +42 -0
- package/src/components/language-switcher.tsx +96 -0
- package/src/components/page-loader.tsx +11 -0
- package/src/components/page-not-found.tsx +42 -0
- package/src/components/permission-denied.tsx +21 -0
- package/src/components/require-access.tsx +30 -0
- package/src/components/scroll-to-top.tsx +62 -0
- package/src/components/settings-menu.tsx +250 -0
- package/src/components/theme-switcher.tsx +72 -0
- package/src/components/toast-container.tsx +73 -0
- package/src/components/top-progress.tsx +14 -0
- package/src/components/user-menu.tsx +179 -0
- package/src/context/ui-context.ts +20 -0
- package/src/context/use-ui.ts +43 -0
- package/src/i18n/browser-language.ts +98 -0
- package/src/i18n/default-messages.ts +70 -0
- package/src/i18n/direction.ts +43 -0
- package/src/i18n/locale-groups.ts +87 -0
- package/src/i18n/locale-service.ts +259 -0
- package/src/i18n/locale-signal.ts +173 -0
- package/src/i18n/translator.ts +114 -0
- package/src/index.ts +409 -0
- package/src/interfaces/app-types.ts +160 -0
- package/src/interfaces/toast.ts +12 -0
- package/src/interfaces/ui-config.ts +342 -0
- package/src/interfaces/ui-context.ts +43 -0
- package/src/layout.ts +29 -0
- package/src/layouts/app-layout.tsx +103 -0
- package/src/layouts/article-layout.tsx +16 -0
- package/src/layouts/aside-layout.tsx +118 -0
- package/src/layouts/auth-layout.tsx +41 -0
- package/src/layouts/content-layout.tsx +11 -0
- package/src/layouts/float-layout.tsx +11 -0
- package/src/layouts/grid-layout.tsx +11 -0
- package/src/layouts/head-layout.tsx +61 -0
- package/src/layouts/header.tsx +74 -0
- package/src/layouts/layout-constants.ts +5 -0
- package/src/layouts/mega-menu.tsx +203 -0
- package/src/layouts/navigation.ts +45 -0
- package/src/layouts/rail-flyout.tsx +77 -0
- package/src/layouts/rail-tooltip.tsx +77 -0
- package/src/layouts/sidebar.tsx +296 -0
- package/src/markdown.ts +12 -0
- package/src/providers/provider-effects.ts +33 -0
- package/src/providers/register-config.ts +32 -0
- package/src/providers/shared-web-ui-provider.tsx +81 -0
- package/src/providers/theme-provider.tsx +15 -0
- package/src/providers/translation-provider.tsx +28 -0
- package/src/query/page-link.tsx +84 -0
- package/src/query/page-path.ts +26 -0
- package/src/query/query-param.ts +267 -0
- package/src/query/use-query-param.ts +23 -0
- package/src/skeleton/skeleton-article.tsx +11 -0
- package/src/skeleton/skeleton-auth-form.tsx +20 -0
- package/src/skeleton/skeleton-cards.tsx +35 -0
- package/src/skeleton/skeleton-chat.tsx +34 -0
- package/src/skeleton/skeleton-dashboard.tsx +34 -0
- package/src/skeleton/skeleton-float.tsx +10 -0
- package/src/skeleton/skeleton-form.tsx +45 -0
- package/src/skeleton/skeleton-menu.tsx +30 -0
- package/src/skeleton/skeleton-page.tsx +18 -0
- package/src/skeleton/skeleton-table.tsx +25 -0
- package/src/state/api-loader.ts +205 -0
- package/src/state/auth-service.ts +159 -0
- package/src/state/branch-service.ts +217 -0
- package/src/state/company-service.ts +107 -0
- package/src/state/document-sync.ts +43 -0
- package/src/state/language-service.ts +85 -0
- package/src/state/layout-choice-service.ts +40 -0
- package/src/state/menu-service.ts +67 -0
- package/src/state/navigation-service.ts +160 -0
- package/src/state/preference-sync.ts +101 -0
- package/src/state/progress-service.ts +18 -0
- package/src/state/screen-access.ts +70 -0
- package/src/state/sidebar-service.ts +22 -0
- package/src/state/signals.ts +215 -0
- package/src/state/toast-service.ts +45 -0
- package/src/styles.css +15 -0
- package/src/theme/custom-themes.ts +236 -0
- package/src/theme/dark-themes.ts +97 -0
- package/src/theme/logo.ts +27 -0
- package/src/theme/org-themes.json +70 -0
- package/src/theme/theme-service.ts +142 -0
- package/src/types/class-names.ts +53 -0
- package/src/types/field-error.ts +19 -0
- package/src/types/field-props.ts +23 -0
- package/src/types/field-registry.ts +27 -0
- package/src/types/field-wrapper.tsx +42 -0
- package/src/types/lang-field.ts +71 -0
- package/src/types/markdown-color-mode.ts +13 -0
- package/src/types/media-service.ts +61 -0
- package/src/types/media-viewer.tsx +57 -0
- package/src/types/type.button.tsx +108 -0
- package/src/types/type.checkbox.tsx +49 -0
- package/src/types/type.confirm.tsx +50 -0
- package/src/types/type.date.tsx +97 -0
- package/src/types/type.drawer.tsx +86 -0
- package/src/types/type.dropdown.tsx +81 -0
- package/src/types/type.filter.tsx +64 -0
- package/src/types/type.icon.ts +53 -0
- package/src/types/type.image.tsx +115 -0
- package/src/types/type.input.tsx +57 -0
- package/src/types/type.lang-md.tsx +129 -0
- package/src/types/type.lang.tsx +156 -0
- package/src/types/type.list.tsx +97 -0
- package/src/types/type.mdv.tsx +35 -0
- package/src/types/type.mdx.tsx +54 -0
- package/src/types/type.modal.tsx +77 -0
- package/src/types/type.otp.tsx +82 -0
- package/src/types/type.search.tsx +87 -0
- package/src/types/type.select.tsx +87 -0
- package/src/types/type.switch.tsx +52 -0
- package/src/types/type.table.tsx +152 -0
- package/src/types/type.text-area.tsx +51 -0
- package/src/types/type.time.tsx +61 -0
- package/src/types/type.upload.tsx +294 -0
- package/src/types/type.video.tsx +119 -0
- package/src/types/upload-service.ts +229 -0
- package/src/utils/app-config.ts +21 -0
- package/src/utils/app-http.ts +369 -0
- package/src/utils/app-storage.ts +259 -0
- package/src/utils/content-util.ts +49 -0
- package/src/utils/crypto-util.ts +88 -0
- package/src/utils/error-util.ts +64 -0
- package/src/utils/event-util.ts +58 -0
- package/src/utils/file-util.ts +186 -0
- package/src/utils/lang-util.ts +60 -0
- package/src/utils/language-util.ts +107 -0
- package/src/utils/leave-guard.ts +26 -0
- package/src/utils/lucide-icon.ts +55 -0
- package/src/utils/menu-util.ts +165 -0
- package/src/utils/option-util.ts +108 -0
- package/src/utils/session-id.ts +48 -0
- package/src/utils/shared-regexp.ts +18 -0
- package/src/utils/signal-source.ts +15 -0
- package/src/utils/storage-keys.ts +86 -0
package/README.md
CHANGED
|
@@ -1,3 +1,885 @@
|
|
|
1
|
-
#
|
|
1
|
+
# shared-lib-web
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A shared **React 19 component library** for DesignForFeature apps, shipped as one npm package.
|
|
4
|
+
Open source under the [MIT license](./LICENSE): free for anybody to use.
|
|
5
|
+
|
|
6
|
+
| Entry | Required? | What |
|
|
7
|
+
| --- | --- | --- |
|
|
8
|
+
| `shared-lib-web` | **yes** | Provider, all Type* controls, page blocks, menus, switchers, overlays, skeletons, states, i18n, themes, AppHttp / AppStorage |
|
|
9
|
+
| `shared-lib-web/layout` | optional | Ready-made app shell: one **single layout** (`AppLayout`, `AsideLayout`, `AuthLayout`) or its **individual parts** (`Header`, `Sidebar`, `SidebarNav`, `MegaMenuBar`, `MegaMenuPanel`, `RailFlyout`) |
|
|
10
|
+
| `shared-lib-web/markdown` | optional | `TypeMdx`, `TypeMdv`, `TypeLangMd` (needs `@uiw/react-md-editor`) |
|
|
11
|
+
|
|
12
|
+
The project decides the layout: use `AppLayout` as it is, turn off / replace its parts, build an own layout from the
|
|
13
|
+
single parts, or skip `shared-lib-web/layout` completely and write the whole layout itself.
|
|
14
|
+
|
|
15
|
+
An app keeps **only**:
|
|
16
|
+
|
|
17
|
+
1. `config.ts` – app name, logos, layout, http and the loaders: `loadLocale`, `loadThemes`, `loadSupportLanguages`,
|
|
18
|
+
`loadBranches`, `loadMenuNavigation` (the provider calls them itself)
|
|
19
|
+
2. `<SharedWebUiProvider type="spa" | "shell" | "mfe" config={config}>
|
|
20
|
+
3. `locales/<code>/<group>.json` – its texts, one folder per language and one file per group (`en-US/nav.json` …)
|
|
21
|
+
4. its pages / modules
|
|
22
|
+
|
|
23
|
+
Everything else lives in the library: components and (optionally) layouts, header, sidebar (with icon rail),
|
|
24
|
+
full-width mega menu, pages by query parameter (no router), DaisyUI light/dark themes, lightweight i18n, RTL/LTR, permissions,
|
|
25
|
+
localStorage persistence, toasts, skeletons, overlays and `react-hook-form` controls.
|
|
26
|
+
|
|
27
|
+
Stack: React 19 · TypeScript (strict) · Vite · Tailwind CSS 4 · DaisyUI 5 · `@preact/signals-react` ·
|
|
28
|
+
`lucide-react` (through `TypeIcon`) · `react-hook-form` · `dff-util`.
|
|
29
|
+
**No router (no react-router-dom), no AG Grid.** Markdown fields are an optional extra entry (`shared-lib-web/markdown`).
|
|
30
|
+
|
|
31
|
+
The source follows strict readability rules (no nested functions, no `abcd(xyz())`, no chained calls,
|
|
32
|
+
lowercase file names) – see [CODING_RULES.md](./CODING_RULES.md). AI agents: read `.agent/skills/` in the repository.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Install
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm install shared-lib-web dff-util react react-dom @preact/signals-react lucide-react react-hook-form
|
|
40
|
+
npm install -D tailwindcss daisyui # + your bundler's Tailwind plugin, e.g. @tailwindcss/vite or @tailwindcss/postcss
|
|
41
|
+
# optional, only for shared-lib-web/markdown
|
|
42
|
+
npm install @uiw/react-md-editor
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## CSS
|
|
46
|
+
|
|
47
|
+
```css
|
|
48
|
+
/* src/index.css */
|
|
49
|
+
@import "tailwindcss";
|
|
50
|
+
@import "shared-lib-web/styles.css"; /* lets Tailwind find the classes used inside the library */
|
|
51
|
+
@plugin "daisyui" {
|
|
52
|
+
themes: all; /* all 35 DaisyUI themes; or list the ones you need */
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`config.themes` is optional: without it the theme switcher offers all 35 DaisyUI themes (enable them with
|
|
57
|
+
`themes: all`, or list the ones you need and pass the same names in `config.themes`). The dark ones (dark logo,
|
|
58
|
+
dark markdown editor) default to the DaisyUI dark themes; `config.darkThemes` replaces that list.
|
|
59
|
+
|
|
60
|
+
### Custom themes as JSON (no CSS file, no rebuild)
|
|
61
|
+
|
|
62
|
+
Your own themes are plain data: an **object keyed by theme name**, each with `isDark`, `name` and the DaisyUI theme
|
|
63
|
+
variables (`name` may be left out — the key is the name; a plain list `[{ name, ... }]` still works). Pass them with
|
|
64
|
+
`config.loadThemes` (or `config.customThemes`); they are listed first in the switcher, and `isDark: true` adds them to the dark themes.
|
|
65
|
+
The library writes one `<style>` with `[data-theme="org-dark"] { color-scheme: dark; --color-primary: …; }`, which
|
|
66
|
+
DaisyUI's components read like a built-in theme.
|
|
67
|
+
|
|
68
|
+
```json
|
|
69
|
+
// src/theme/org-themes.json
|
|
70
|
+
{
|
|
71
|
+
"org-dark": {
|
|
72
|
+
"isDark": true,
|
|
73
|
+
"name": "org-dark",
|
|
74
|
+
"variables": {
|
|
75
|
+
"border": "1px",
|
|
76
|
+
"color-accent": "oklch(70.4% 0.04 256.8)",
|
|
77
|
+
"color-accent-content": "oklch(12.9% 0.042 264.7)",
|
|
78
|
+
"color-base-100": "oklch(25.5% 0.04 264.5)",
|
|
79
|
+
"color-base-200": "oklch(20.8% 0.042 265.8)",
|
|
80
|
+
"color-base-300": "oklch(32% 0.04 262)",
|
|
81
|
+
"color-base-content": "oklch(92.9% 0.013 255.5)",
|
|
82
|
+
"color-error": "oklch(70.4% 0.191 22.2)",
|
|
83
|
+
"color-error-content": "oklch(25.8% 0.092 26)",
|
|
84
|
+
"color-info": "oklch(78.9% 0.154 211.5)",
|
|
85
|
+
"color-info-content": "oklch(30.2% 0.056 229.7)",
|
|
86
|
+
"color-neutral": "oklch(37.2% 0.044 257.3)",
|
|
87
|
+
"color-neutral-content": "oklch(96.8% 0.007 247.9)",
|
|
88
|
+
"color-primary": "oklch(74.6% 0.16 232.7)",
|
|
89
|
+
"color-primary-content": "oklch(29.3% 0.066 243.2)",
|
|
90
|
+
"color-secondary": "oklch(82.8% 0.189 84.4)",
|
|
91
|
+
"color-secondary-content": "oklch(27.9% 0.077 45.6)",
|
|
92
|
+
"color-success": "oklch(79.2% 0.209 151.7)",
|
|
93
|
+
"color-success-content": "oklch(26.6% 0.065 152.9)",
|
|
94
|
+
"color-warning": "oklch(75% 0.183 55.9)",
|
|
95
|
+
"color-warning-content": "oklch(26.6% 0.079 36.3)",
|
|
96
|
+
"depth": "1",
|
|
97
|
+
"noise": "0",
|
|
98
|
+
"radius-box": "0.75rem",
|
|
99
|
+
"radius-field": "0.5rem",
|
|
100
|
+
"radius-selector": "1rem",
|
|
101
|
+
"size-field": "0.25rem",
|
|
102
|
+
"size-selector": "0.25rem"
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"org-light": {
|
|
106
|
+
"isDark": false,
|
|
107
|
+
"name": "org-light",
|
|
108
|
+
"variables": {
|
|
109
|
+
"border": "1px",
|
|
110
|
+
"color-accent": "oklch(55.4% 0.046 257.4)",
|
|
111
|
+
"color-accent-content": "oklch(98.4% 0.003 247.9)",
|
|
112
|
+
"color-base-100": "oklch(100% 0 0)",
|
|
113
|
+
"color-base-200": "oklch(96.8% 0.007 247.9)",
|
|
114
|
+
"color-base-300": "oklch(92.9% 0.013 255.5)",
|
|
115
|
+
"color-base-content": "oklch(20.8% 0.042 265.8)",
|
|
116
|
+
"color-error": "oklch(55% 0.23 27.3)",
|
|
117
|
+
"color-error-content": "oklch(97.1% 0.013 17.4)",
|
|
118
|
+
"color-info": "oklch(71.5% 0.143 215.2)",
|
|
119
|
+
"color-info-content": "oklch(30.2% 0.056 229.7)",
|
|
120
|
+
"color-neutral": "oklch(27.9% 0.041 260)",
|
|
121
|
+
"color-neutral-content": "oklch(98.4% 0.003 247.9)",
|
|
122
|
+
"color-primary": "oklch(55.8% 0.154 249.1)",
|
|
123
|
+
"color-primary-content": "oklch(98.5% 0.01 240)",
|
|
124
|
+
"color-secondary": "oklch(76.9% 0.188 70.1)",
|
|
125
|
+
"color-secondary-content": "oklch(27.9% 0.077 45.6)",
|
|
126
|
+
"color-success": "oklch(52.7% 0.154 150.1)",
|
|
127
|
+
"color-success-content": "oklch(98.2% 0.018 155.8)",
|
|
128
|
+
"color-warning": "oklch(75% 0.183 55.9)",
|
|
129
|
+
"color-warning-content": "oklch(26.6% 0.079 36.3)",
|
|
130
|
+
"depth": "1",
|
|
131
|
+
"noise": "0",
|
|
132
|
+
"radius-box": "0.75rem",
|
|
133
|
+
"radius-field": "0.5rem",
|
|
134
|
+
"radius-selector": "1rem",
|
|
135
|
+
"size-field": "0.25rem",
|
|
136
|
+
"size-selector": "0.25rem"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Load them lazily with `loadThemes`, the same way as `loadLocale` (its own chunk, loaded when the provider mounts):
|
|
143
|
+
|
|
144
|
+
```ts
|
|
145
|
+
// config.ts
|
|
146
|
+
import type { CustomThemesModule, UiConfig } from "shared-lib-web";
|
|
147
|
+
|
|
148
|
+
function loadThemes(): Promise<CustomThemesModule> {
|
|
149
|
+
return import("./theme/org-themes.json");
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
export const config: UiConfig = {
|
|
153
|
+
appNameKey: "ORG",
|
|
154
|
+
loadThemes: loadThemes, // + all 35 DaisyUI themes (themes is optional)
|
|
155
|
+
};
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
`loadThemes` can also read from your API or a file deployed next to the app (change the themes without a build):
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
async function loadThemes(): Promise<CustomThemesModule> {
|
|
162
|
+
const response = await fetch("/themes.json");
|
|
163
|
+
return response.json();
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
While they load, a saved custom theme stays on screen (no flash of the default theme); when the load fails or the
|
|
168
|
+
saved theme is not in the result, the default theme is used. Themes you already have in code can go straight into
|
|
169
|
+
`customThemes: orgThemes` (no loading; the object keyed by name, or a list); both together are merged, and a loaded theme replaces one with the same name.
|
|
170
|
+
|
|
171
|
+
The variable names are the DaisyUI ones, with or without `--`: `color-base-100/200/300`, `color-base-content`,
|
|
172
|
+
`color-primary`, `color-primary-content`, `color-secondary`, `color-accent`, `color-neutral`, `color-info`,
|
|
173
|
+
`color-success`, `color-warning`, `color-error` (each with `-content`), `radius-selector`, `radius-field`,
|
|
174
|
+
`radius-box`, `size-selector`, `size-field`, `border`, `depth`, `noise`. Theme names may use lowercase letters,
|
|
175
|
+
digits and `-`; values with `; { } < > " \` are skipped (safe for JSON from a server).
|
|
176
|
+
|
|
177
|
+
**Or a signal:** `loadThemes: themesSignal` (`signal<CustomThemesModule | null>(null)`). `null` = not here yet (a
|
|
178
|
+
saved custom theme stays on screen); every new value replaces the loaded themes:
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
const themeModule = await import("./theme/org-themes.json");
|
|
182
|
+
themesSignal.value = themeModule;
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
Any time later (for example after the user signs in) `setCustomThemes(themes)` replaces the custom themes (the object
|
|
186
|
+
keyed by name or a list). `toCustomThemeList(themes)` turns the object into a list (`CustomTheme[]`, key order).
|
|
187
|
+
|
|
188
|
+
The theme dropdown, the ⚙ settings dialog and the example Settings page show **Light themes** and **Dark themes**
|
|
189
|
+
as two groups (split by the dark themes). In your own UI: `const { lightThemes, darkThemes } = useUi();`
|
|
190
|
+
or `splitThemesByMode(themes)`, `isDarkThemeName(theme)`. Texts: `ui.lightThemes`, `ui.darkThemes`.
|
|
191
|
+
|
|
192
|
+
## App bundler (Vite example)
|
|
193
|
+
|
|
194
|
+
The library itself has no bundler. Your **app** uses its own (Vite, Next.js, webpack …).
|
|
195
|
+
`dff-util` uses packages that expect Node's `global`, so define it — with Vite:
|
|
196
|
+
|
|
197
|
+
```ts
|
|
198
|
+
export default defineConfig({
|
|
199
|
+
plugins: [reactPlugin, tailwindPlugin],
|
|
200
|
+
define: { global: "globalThis" },
|
|
201
|
+
});
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
## 1. config.ts
|
|
207
|
+
|
|
208
|
+
```ts
|
|
209
|
+
import { loadLocaleGroups, readEnvData, toAbsoluteUrl, type CustomThemesModule, type UiConfig } from "shared-lib-web";
|
|
210
|
+
|
|
211
|
+
const APP_NAME_KEY = "ORG";
|
|
212
|
+
const APP_API_KEY = APP_NAME_KEY.toLowerCase(); // "org" -> /org-api, /org-sor ...
|
|
213
|
+
|
|
214
|
+
// window.env.REACT_APP_ORG_API_BASE_URL (env.js), else the default
|
|
215
|
+
const envBaseUrl = readEnvData(APP_NAME_KEY, "API_BASE_URL");
|
|
216
|
+
const API_BASE_URL = toAbsoluteUrl(envBaseUrl ?? "https://api.example.com/api");
|
|
217
|
+
|
|
218
|
+
// Service paths are PROJECT level (not part of AppHttp). AppHttp adds the base URL to a path:
|
|
219
|
+
// AppHttp.Get(`${MsUrl.main}/menu-access`) -> https://api.example.com/api/org-api/menu-access
|
|
220
|
+
export const MsUrl = {
|
|
221
|
+
api: `/${APP_API_KEY}-api`,
|
|
222
|
+
main: `/${APP_API_KEY}-api`,
|
|
223
|
+
sor: `/${APP_API_KEY}-sor`,
|
|
224
|
+
events: `/${APP_API_KEY}-events`,
|
|
225
|
+
tms: `/${APP_API_KEY}-tms`,
|
|
226
|
+
utils: `/${APP_API_KEY}-util`,
|
|
227
|
+
};
|
|
228
|
+
|
|
229
|
+
/** locales/<code>/<group>.json — lazy: only the files of the language in use are downloaded (see section 2) */
|
|
230
|
+
const localeFiles = import.meta.glob("./locales/*/*.json");
|
|
231
|
+
|
|
232
|
+
/** theme/org-themes.json, loaded lazily like the locale files (see "Custom themes as JSON") */
|
|
233
|
+
function loadThemes(): Promise<CustomThemesModule> {
|
|
234
|
+
return import("./theme/org-themes.json");
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
export const config: UiConfig = {
|
|
238
|
+
appNameKey: APP_NAME_KEY, // key: storage ORG-TOKEN, env REACT_APP_ORG_API_BASE_URL
|
|
239
|
+
loadCompanyDetails: `${MsUrl.sor}/company-details`, // app name, logos, favicon from the backend (see "Company details")
|
|
240
|
+
// appName / logoUrl / logoDarkUrl: only for apps WITHOUT company details (static brand)
|
|
241
|
+
// defaultLanguage: "en-US", // optional: without it the browser / system language, else en-US
|
|
242
|
+
loadLocale: loadLocaleGroups.bind(null, localeFiles),
|
|
243
|
+
// defaultTheme: "light", // optional: without it the browser preference picks "dark" or "light"
|
|
244
|
+
loadThemes: loadThemes, // optional: your own themes as JSON (see "Custom themes as JSON")
|
|
245
|
+
// themes: ["light", "dark"], // optional: default all 35 DaisyUI themes
|
|
246
|
+
layout: { menuMode: "sidebar", isSidebarCollapsible: true },
|
|
247
|
+
http: { baseUrl: API_BASE_URL, logoutUrl: "/login" },
|
|
248
|
+
};
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
| Setting | What it does |
|
|
252
|
+
| --- | --- |
|
|
253
|
+
| `defaultLanguage` | Optional. Language of the first visit (nothing saved). Without it the **browser / system language** is used: `navigator.languages` matched to the language list (exact code, else the same base language: `fr-CA` → `fr-FR`); without a list each browser code is tried and a missing locale file is skipped. Nothing matches → `"en-US"`. Keys missing in a language are shown in `defaultLanguage` (else en-US). Without `defaultLanguage`, `languages`, `loadLocale` and `loadSupportLanguages` the app runs in en-US with the library's built-in English texts and no language switcher. |
|
|
254
|
+
| `loadLocale(code)` | Loads the texts of a language lazily (dynamic `import()` / `import.meta.glob`): `loadLocaleGroups.bind(null, localeFiles)` for `locales/<code>/<group>.json`, or your own function returning one JSON. |
|
|
255
|
+
| `languages` | Not needed: the list comes from `loadSupportLanguages` (below). Only for apps with a fixed list (`{ code, label, flag?, direction?, load? }`). |
|
|
256
|
+
| `themes`, `darkThemes` | Optional. The theme switcher list (default: all 35 DaisyUI themes) and the dark ones (default: the DaisyUI dark themes). Dark themes switch to `logoDarkUrl` and dark markdown. |
|
|
257
|
+
| `customThemes`, `loadThemes` | Optional. Your own themes as data / JSON — an object keyed by theme name (`{ "org-dark": { isDark, name, variables }, ... }`) or a list — listed first: `customThemes` directly, or `loadThemes()` lazily like `loadLocale` (JSON file or API). Later ones: `setCustomThemes(json)`. |
|
|
258
|
+
| `defaultTheme` | Optional. Theme of the first visit (nothing saved yet). Without it the browser preference decides: `"dark"` when it prefers a dark colour scheme, otherwise `"light"`. |
|
|
259
|
+
| `layout.headerSettings` | `"inline"` (language + theme switchers in the header) or `"menu"` (one ⚙ button opening a settings dialog with language, theme and navigation style). |
|
|
260
|
+
| `layout.showLayoutChoice` | Optional (default `false`). Adds **Layout** (App layout / Aside layout) to the ⚙ settings dialog — for a shell that renders `AppLayout` or `AsideLayout` from `layoutChoiceSignal`. Saved as `LAYOUT_CHOICE`; `<SettingsMenu showLayoutChoice />` does the same for one menu. |
|
|
261
|
+
| `layout.toastPosition`, `layout.showScrollToTop` | Toast corner (`top-end` …) and the scroll-to-top button. |
|
|
262
|
+
| `layout.showMenu` | Menu shown at start (default `true`); switch at runtime with `setMenuVisible()` / `toggleMenuVisible()`. |
|
|
263
|
+
| `layout.menuMode` | `"sidebar"` (drawer + collapsible icon rail) or `"megamenu"` (top bar + full-width panels). Users can switch with `changeNavigationMode()`; the choice is saved. |
|
|
264
|
+
| `homePath`, `layout.pageParam` | The page shown when `?page` is missing (default `/`) and the name of the page parameter (default `page`). |
|
|
265
|
+
| `http.baseUrl` | API base URL of `AppHttp` (`window.env.REACT_APP_<APPNAMEKEY>_API_BASE_URL` wins when set; a relative `/api` becomes absolute). |
|
|
266
|
+
| `http.logoutUrl` | Where the browser goes after `endSession()` (log out), for example `/login` or an SSO logout URL. `endSession(keepKeys, false)` stays on the page. |
|
|
267
|
+
| `http.tokenKey`, `http.headers`, `http.loadUrl`, `http.showProgress` | Optional: AppStorage key of the token (default `TOKEN`), extra headers, `AppHttp.Load` URL or path (default `/load` on the base URL), progress bar (default `true`). |
|
|
268
|
+
| `appNameKey` | Key of the app (`ENV_BASE_NAME`): prefix of every AppStorage key (`ORG-TOKEN`, `ORG-LANG`) and of the `window.env` names (`REACT_APP_ORG_…`). The key names are fixed constants — no `storage` / `languageKey` / `themeKey` settings. |
|
|
269
|
+
| `appName`, `logoUrl`, `logoDarkUrl` | Optional static brand, for apps without `loadCompanyDetails`: label in header, sidebar and login (`t(config.appName)`, default `appNameKey`) and the logos. Not needed when the company details come from the backend. |
|
|
270
|
+
| `loadCompanyDetails` | Optional. Company / brand details from the backend (`{ appName, companyName, faviconUrl, logoUrl, logoDarkUrl }`), loaded once on start; they win over `appName`, `logoUrl`, `logoDarkUrl`. See "Company details" below. |
|
|
271
|
+
| `loadSupportLanguages`, `loadBranches`, `loadMenuNavigation` | Backend loaders the provider calls (like `loadThemes`): languages on start, branches then menu after sign in. See "Backend data" below. |
|
|
272
|
+
| `navigation` | Not needed: the menu comes from `loadMenuNavigation` (below). Only for apps with a fixed menu and no backend (`NavItem[]`). |
|
|
273
|
+
| `navOptions` | How the backend menu is converted: `rootMenuIds` (default: groups named "Root" or ids ending in `_ROOT`), `isRootFlattened` (default `true`). |
|
|
274
|
+
|
|
275
|
+
### Backend data: `loadSupportLanguages`, `loadBranches`, `loadMenuNavigation`
|
|
276
|
+
|
|
277
|
+
Like `loadThemes`, these are loaders in the config, and the provider calls them itself — no `nav` / `lang` /
|
|
278
|
+
`branch` props. A loader is your function returning the reply (or just a URL / path, sent with `AppHttp.Get`).
|
|
279
|
+
Replies may be `{ data: [...], meta }` or only the list.
|
|
280
|
+
|
|
281
|
+
```ts
|
|
282
|
+
// config.ts
|
|
283
|
+
function loadSupportLanguages(): Promise<unknown> {
|
|
284
|
+
return AppHttp.Get(`${MsUrl.main}/languages`); // { data: [{ code: "en-US", name: "English", isDefault: true }] }
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
function loadBranches(): Promise<unknown> {
|
|
288
|
+
return AppHttp.Get(`${MsUrl.main}/branches`);
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
function loadMenuNavigation(): Promise<unknown> {
|
|
292
|
+
return AppHttp.Get(`${MsUrl.main}/menu-access`, { persona: "admin" });
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
export const config: UiConfig = {
|
|
296
|
+
appNameKey: "ORG",
|
|
297
|
+
loadLocale: loadLocale,
|
|
298
|
+
loadThemes: loadThemes,
|
|
299
|
+
loadSupportLanguages: loadSupportLanguages, // on start -> language switchers
|
|
300
|
+
loadBranches: loadBranches, // after sign in -> branch switcher (before the menu)
|
|
301
|
+
loadMenuNavigation: loadMenuNavigation, // after sign in -> menu (skeleton until it answers)
|
|
302
|
+
};
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
| When | What happens |
|
|
306
|
+
| --- | --- |
|
|
307
|
+
| Provider mounts | `loadSupportLanguages` runs once; on an error the default language stays. |
|
|
308
|
+
| Sign in (`startSession`) or a restored session on start | `loadBranches`, then `loadMenuNavigation` (so the menu request sends `x-branch-id`). A menu error shows an empty menu, a branch error no switcher. |
|
|
309
|
+
| Sign out (`endSession`) | Branches removed; the menu goes back to the skeleton for the next user. |
|
|
310
|
+
|
|
311
|
+
**Or pass signals.** Each of the three can also be a signal you fill yourself (`null` first, then the reply). The
|
|
312
|
+
provider follows it: every new value is shown at once, and nothing is called for it (no sign-in rule — your code
|
|
313
|
+
decides when it changes):
|
|
314
|
+
|
|
315
|
+
```ts
|
|
316
|
+
// nav.service.ts
|
|
317
|
+
export const navSignal = signal<MenuSource | null>(null); // null = menu skeleton
|
|
318
|
+
export const branchSignal = signal<BranchSource | null>(null); // null = no branch switcher
|
|
319
|
+
export const supportLangSignal = signal<LangSource | null>(null); // null = no list yet
|
|
320
|
+
|
|
321
|
+
export async function loadNav(): Promise<void> {
|
|
322
|
+
navSignal.value = await AppHttp.Get(`${MsUrl.main}/menu-access`) as MenuSource;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
// config.ts
|
|
326
|
+
loadSupportLanguages: supportLangSignal,
|
|
327
|
+
loadBranches: branchSignal,
|
|
328
|
+
loadMenuNavigation: navSignal,
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
Functions, URLs and signals can be mixed (for example languages as a function, the menu as a signal).
|
|
332
|
+
|
|
333
|
+
Without `loadMenuNavigation` the menu is `config.navigation` (static). By hand, without loaders: `setLanguages(reply)`,
|
|
334
|
+
`setBranches(reply)`, `setMenuLoading()` → `setMenu(reply)`, `clearMenu()`.
|
|
335
|
+
|
|
336
|
+
### Company details: `loadCompanyDetails`
|
|
337
|
+
|
|
338
|
+
The app name, company name, favicon and logos can come from the backend:
|
|
339
|
+
|
|
340
|
+
```json
|
|
341
|
+
// GET /org-api/company-details (or { "data": { ... } })
|
|
342
|
+
{
|
|
343
|
+
"appName": "YourAppName",
|
|
344
|
+
"companyName": "YourBrandName",
|
|
345
|
+
"faviconUrl": "https://www.w3.org/favicon.ico",
|
|
346
|
+
"logoUrl": "https://www.w3.org/Icons/w3c_home.png",
|
|
347
|
+
"logoDarkUrl": "https://www.w3.org/Icons/w3c_home.png"
|
|
348
|
+
}
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
```ts
|
|
352
|
+
// config.ts — a function, a URL / path (AppHttp.Get) or a signal, like the other loaders
|
|
353
|
+
loadCompanyDetails: `${MsUrl.sor}/company-details`,
|
|
354
|
+
// or: loadCompanyDetails: companySignal, // signal<CompanySource | null>(null); null = config values for now
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
| Field | Used for |
|
|
358
|
+
| --- | --- |
|
|
359
|
+
| `appName` | Label in the header, sidebar and login (wins over `config.appName`) and the browser tab title |
|
|
360
|
+
| `companyName` | Alt text of the logo; read `companyDetailsSignal.value?.companyName` to show it anywhere (footer, login) |
|
|
361
|
+
| `faviconUrl` | `<link rel="icon">` (created when the page has none) |
|
|
362
|
+
| `logoUrl` | Logo on light themes, and on dark themes without `logoDarkUrl` (wins over `config.logoUrl` / `logoDarkUrl`) |
|
|
363
|
+
| `logoDarkUrl` | Logo on dark themes (wins over `config.logoDarkUrl`) |
|
|
364
|
+
|
|
365
|
+
**No `appName`, `logoUrl` or `logoDarkUrl` in the config is needed** — the brand comes from this reply (the example
|
|
366
|
+
apps have none in their config). Until it arrives no app name and no logo are shown (the app key does not flash);
|
|
367
|
+
on an error the app key is shown. Every field is optional: a missing one keeps the config value, when the config
|
|
368
|
+
has one. Loaded once when the provider mounts; on an error the
|
|
369
|
+
config values stay. For type `"mfe"` only when the MFE sets it (the shell owns the brand; an auth MFE with the brand on its login sets it). By hand: `setCompanyDetails(reply)`.
|
|
370
|
+
Helpers: `readLogoUrl(config, isDarkTheme, details)`, `readAppNameLabel(config, details)`, `readCompanyDetails(reply)`.
|
|
371
|
+
The example apps load sor `/company-details` into `companySignal` on start.
|
|
372
|
+
|
|
373
|
+
### Layout choice (shell with microfrontends)
|
|
374
|
+
|
|
375
|
+
`layoutChoiceSignal` (`"app"` | `"aside"`) and `changeLayoutChoice(choice)` keep the picked app layout in
|
|
376
|
+
`LAYOUT_CHOICE` (localStorage). The provider reads it on start, and every copy of the library on the page (shell and
|
|
377
|
+
MFEs) follows a change at once, like the theme. The shell renders `AppLayout` or `AsideLayout` from it; an MFE uses
|
|
378
|
+
it to know whether the shell shows a header (`isAsideLayoutSignal`).
|
|
379
|
+
|
|
380
|
+
### App type: `<SharedWebUiProvider type="...">`
|
|
381
|
+
|
|
382
|
+
| `type` | For | Differences |
|
|
383
|
+
| --- | --- | --- |
|
|
384
|
+
| `"spa"` (default) | a normal app | layouts, menu, login; pages in `?page=...` |
|
|
385
|
+
| `"shell"` | the root app that hosts microfrontends | like `spa`, but pages are paths by default (`/settings`) |
|
|
386
|
+
| `"mfe"` | a microfrontend inside a shell | page layouts only: no menu (no skeleton), `loadMenuNavigation` / `loadBranches` not called (the shell owns them; `loadCompanyDetails` only when the MFE sets it); `appName`, `logoUrl`, `logoDarkUrl`, `homePath`, `branchLabel` are not used. `loadSupportLanguages` still works. |
|
|
387
|
+
|
|
388
|
+
`layout.pageMode` set in the config always wins over the type.
|
|
389
|
+
|
|
390
|
+
What happens to the reply (`MenuAccessType`: `id`, `name`, `nameLang`, `href`, `icon`, `type`, `priority`,
|
|
391
|
+
`read/create/update/delete` or `permissions`, `active`, `children`):
|
|
392
|
+
|
|
393
|
+
- the children of the **Root** group (`ADMIN_ROOT`) move to the top level, in the place of the group;
|
|
394
|
+
- sorted by `priority`; the same priority keeps the backend order; `active: false` is removed;
|
|
395
|
+
- icons like `layout-dashboard`, `users`, `User-Round-Key` become lucide names (unknown → `Circle`);
|
|
396
|
+
- `nameLang` `{ "en-US": "..." }` is used for `en`, `en-US`, … (`trans()`), else `name`;
|
|
397
|
+
- `read: false` hides the item and blocks the page; `create/update/delete` feed `canAccess()`.
|
|
398
|
+
|
|
399
|
+
`toNavigation(menuResponse, options)` does the conversion if you need the `NavItem[]` yourself.
|
|
400
|
+
|
|
401
|
+
### Languages from the backend (`loadSupportLanguages`)
|
|
402
|
+
|
|
403
|
+
Called once on start (see above). Texts come from `locales/<code>/<group>.json` via `loadLocale`.
|
|
404
|
+
|
|
405
|
+
- Row fields: `code` (or `langCode` / `languageCode` / `id`), `name` or `label`, `flag`, `direction` or `dir`,
|
|
406
|
+
`isDefault` (or `default`), `active` (false hides it), `priority`. RTL is automatic for `ar`, `he`, `fa`, `ur`.
|
|
407
|
+
- Until the reply arrives: the saved language, else `defaultLanguage`, else the browser language (when its file
|
|
408
|
+
loads), else `en-US` is shown; the switchers have no list yet.
|
|
409
|
+
- When the list arrives: the user's saved language stays if it is listed; otherwise the row with `isDefault`,
|
|
410
|
+
else `defaultLanguage`, else the browser / system language (matched to the list), else `en-US`,
|
|
411
|
+
else the first is loaded. Only a language the user picks is saved to localStorage.
|
|
412
|
+
- `TypeLang` / `TypeLangMd` fields get one entry per listed language: `{ "en-US": "...", "ar-SA": "..." }`;
|
|
413
|
+
backend `nameLang` with the same codes is shown by `trans()` and the menu.
|
|
414
|
+
- By hand: `setLanguages(reply)`. Conversion only: `toLanguageOptions(reply)`, `readDefaultLanguageCode(reply)`.
|
|
415
|
+
|
|
416
|
+
### AppStorage and AppHttp
|
|
417
|
+
|
|
418
|
+
The same helpers the apps had in `utils/services/app.storage.ts` and `app.http.ts`, now in the library:
|
|
419
|
+
|
|
420
|
+
```ts
|
|
421
|
+
import { AppHttp, AppStorage, BRANCH_ID, LANG, THEME, TOKEN } from "shared-lib-web";
|
|
422
|
+
|
|
423
|
+
AppStorage.setData(BRANCH_ID, branchId); // sessionStorage "ORG-BRANCH_ID"
|
|
424
|
+
const token = AppStorage.getData(TOKEN); // objects come back parsed
|
|
425
|
+
AppStorage.getText(THEME); // localStorage "ORG-THEME"
|
|
426
|
+
AppStorage.removeData(BRANCH_ID); // from both storages
|
|
427
|
+
AppStorage.clearData(); // log out: keeps the localStorage preferences
|
|
428
|
+
AppStorage.envData("API_BASE_URL"); // window.env.REACT_APP_ORG_API_BASE_URL (env.js of the deployed app)
|
|
429
|
+
|
|
430
|
+
// MsUrl comes from the project's config.ts (see section 1)
|
|
431
|
+
const rows = await AppHttp.Get(`${MsUrl.main}/profile/search`, params);
|
|
432
|
+
|
|
433
|
+
// A path works too: it is appended to http.baseUrl (or window.env API_BASE_URL)
|
|
434
|
+
const same = await AppHttp.Get("/org-api/profile/search", params); // -> https://api.example.com/api/org-api/profile/search
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
**URLs in every AppHttp method** (`Get`, `Post`, `Put`, `Delete`, `Patch`, `Load`, `Media`, `CloudUpload`, `DownloadFile`): a URL that
|
|
438
|
+
starts with `http://` or `https://` is used as it is; anything else is appended to the base URL with one `/` between
|
|
439
|
+
(`"/items"` and `"items"` both become `<baseUrl>/items`). `AppHttp.FullUrl(url)` returns the URL a request would use.
|
|
440
|
+
|
|
441
|
+
**Shared requests (shell + microfrontends):** `AppHttp.GetShared(url, params?)` is a GET that runs **once per page**
|
|
442
|
+
for every copy of the library: the shell and each MFE bundle their own copy, and the same URL + params (running or
|
|
443
|
+
answered) gives the same promise, so the languages, themes, texts and company details are not loaded again by each MFE.
|
|
444
|
+
An MFE that runs alone still loads them itself. Only for data that is the same for everyone (not the menu or branches);
|
|
445
|
+
a failed request is not kept; `clearSharedGetCache()` empties it.
|
|
446
|
+
|
|
447
|
+
```ts
|
|
448
|
+
const reply = await AppHttp.GetShared(`${MsUrl.sor}/load/LANG`, { active: true });
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
**Binary files:** `AppHttp.Media(url, params?)` is a GET that returns the body as a `Blob` (images, video, audio, any
|
|
452
|
+
file), with the same headers (token, `x-session-id`, `x-branch-id`, no `Content-Type`) and no progress bar:
|
|
453
|
+
|
|
454
|
+
```ts
|
|
455
|
+
const blob = await AppHttp.Media(`${MsUrl.utils}/files/${fileId}`);
|
|
456
|
+
const objectUrl = URL.createObjectURL(blob); // <img src={objectUrl} />; URL.revokeObjectURL(objectUrl) when done
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
**Which storage:** decided only by the key (no argument).
|
|
460
|
+
|
|
461
|
+
| localStorage (preferences, kept on log out) | sessionStorage (everything else) |
|
|
462
|
+
| --- | --- |
|
|
463
|
+
| `LANG`, `THEME`, `LAYOUT_CHOICE`, `MENU_MODE`, `SIDEBAR_COLLAPSED`, `REMEMBER_ME` + `config.localStorageKeys` | `TOKEN`, `ACTIVE_SESSION_ID` (tab id, sent as `x-session-id`), `AUTH_USER`, `SESSION_INFO`, `SCREEN_ACCESS`, `SCREEN_ACTION`, `NAV`, `TRANS`, `DIR`, `OTP_ID`, `BRANCH_ID`, `BRANCH_NAME`, `REGEN_EXPIRES_AT`, project keys |
|
|
464
|
+
|
|
465
|
+
`startSession(token, user, isRemembered)` keeps the token in sessionStorage; `isRemembered` only saves `REMEMBER_ME`.
|
|
466
|
+
On start the provider removes old app values from localStorage that are not preferences (`AppStorage.cleanLocalStorage()`).
|
|
467
|
+
Saving a preference (`THEME`, `LANG` …) also fires the window event `PREFERENCE_EVENT`; every copy of the library on the
|
|
468
|
+
page (microfrontends) and every other tab applies the new theme / language at once.
|
|
469
|
+
`startSession` / `endSession` fire `SESSION_EVENT` the same way: every other library copy on the page reads the session
|
|
470
|
+
from AppStorage (sign in) or clears it (sign out). So an **auth microfrontend** can sign in and the shell (its own
|
|
471
|
+
library copy) is signed in at once — the shell needs no login of its own (see `example-mfe/auth`).
|
|
472
|
+
|
|
473
|
+
Key constants (also as `StorageKeys.*`): `TOKEN`, `AUTH_USER`, `SESSION_INFO`, `SCREEN_ACCESS`, `SCREEN_ACTION`, `NAV`,
|
|
474
|
+
`REMEMBER_ME`, `TRANS`, `DIR`, `LANG`, `THEME`, `LAYOUT_CHOICE`, `MENU_MODE`, `SIDEBAR_COLLAPSED`, `OTP_ID`, `BRANCH_ID`, `BRANCH_NAME`,
|
|
475
|
+
`REGEN_EXPIRES_AT`. The library saves the chosen language in `LANG`, the theme in `THEME`, the navigation style in
|
|
476
|
+
`MENU_MODE` and the rail state in `SIDEBAR_COLLAPSED`.
|
|
477
|
+
|
|
478
|
+
AppHttp headers on every request: `Content-Type`, `Authorization: Bearer <TOKEN>`, `x-session-id` (per-tab id, saved as `ORG-ACTIVE_SESSION_ID`),
|
|
479
|
+
`x-branch-id` (AppStorage `BRANCH_ID`, `""` when no branch), `http.headers` and `AppHttp.setHeader(name, value)`.
|
|
480
|
+
Pick the branch with `setBranch(branch.id, branch.name)` (saved as `BRANCH_ID` / `BRANCH_NAME`, read back with
|
|
481
|
+
`readBranchId()` or `branchIdSignal`); `clearBranch()` removes it and `endSession()` clears it too.
|
|
482
|
+
|
|
483
|
+
**Branch switcher** – `config.loadBranches` (called after sign in, before the menu); the default and disabled
|
|
484
|
+
branches come with the rows:
|
|
485
|
+
|
|
486
|
+
```ts
|
|
487
|
+
loadBranches: loadBranches, // () => AppHttp.Get(`${MsUrl.main}/branches`)
|
|
488
|
+
branchLabel: "branch.title", // title of the switcher, shown with t() (default "ui.branch" = "Branch")
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
- Rows: `{ id | branchId | code, name | branchName | label, nameLang?, isDefault?, disabled?, active?, priority? }`, as `{ data: [...] }` or the list.
|
|
492
|
+
- `disabled: true` shows the branch greyed out; it can not be selected. `active: false` hides it.
|
|
493
|
+
- Selected when the list arrives: the saved `BRANCH_ID` (if listed and not disabled) → the row with `isDefault` → the first one that is not disabled.
|
|
494
|
+
- Shown as a dropdown in the `Header` and as the first section of the settings dialog. `null` or `[]` = no switcher.
|
|
495
|
+
- `setBranches(reply)` does the same by hand (call it before the menu request so it already
|
|
496
|
+
sends `x-branch-id`). Own layouts: `<BranchSwitcher />`. Helpers: `toBranchOptions`, `pickBranch`, `branchesSignal`.
|
|
497
|
+
The token is read from AppStorage (`TOKEN`, sessionStorage then localStorage).
|
|
498
|
+
|
|
499
|
+
`AppHttp` and `AppStorage` use no signals: they read the config saved by `<SharedWebUiProvider>`.
|
|
500
|
+
Code that runs before the provider (for example at module load) calls `setAppConfig(config)` first, in `main.tsx`.
|
|
501
|
+
|
|
502
|
+
## 2. locales: one folder per language, one file per group
|
|
503
|
+
|
|
504
|
+
```
|
|
505
|
+
locales/
|
|
506
|
+
en-US/
|
|
507
|
+
app.json { "name": "My App" } -> t("app.name")
|
|
508
|
+
nav.json { "dashboard": "Dashboard", "users": "Users" } -> t("nav.users")
|
|
509
|
+
roles.json { "admin": "Admin", "viewer": "Viewer" } -> t("roles.admin")
|
|
510
|
+
root.json { "greeting": "Hello {{name}}", "REQUIRED": "..." } -> t("greeting"), t("REQUIRED") (top level)
|
|
511
|
+
fr-FR/
|
|
512
|
+
app.json …
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
```ts
|
|
516
|
+
// config.ts
|
|
517
|
+
import { loadLocaleGroups } from "shared-lib-web";
|
|
518
|
+
|
|
519
|
+
const localeFiles = import.meta.glob("./locales/*/*.json"); // lazy: nothing is downloaded yet
|
|
520
|
+
|
|
521
|
+
export const config: UiConfig = {
|
|
522
|
+
loadLocale: loadLocaleGroups.bind(null, localeFiles), // fr-FR used -> only locales/fr-FR/*.json load
|
|
523
|
+
};
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
- **Dynamic:** `import.meta.glob` (without `eager`) gives one lazy loader per file; `loadLocaleGroups` runs only
|
|
527
|
+
the files of the language that is used, in parallel, and merges them (the file name is the group, `root.json`
|
|
528
|
+
stays at the top level). The default language (en-US) is loaded too, for keys missing in the current one.
|
|
529
|
+
- **Several folders:** merge them, `{ ...sharedFiles, ...ownFiles }` (MFEs: shared groups + the MFE's own); the same
|
|
530
|
+
group in two folders is merged, the later file wins per key.
|
|
531
|
+
- **Or a signal:** `loadLocale: localeSignal`, a `LocaleBundle` (`{ "en-US": {...}, "fr-FR": {...} }`) your app fills.
|
|
532
|
+
The library adds the codes it needs to `requestedLocalesSignal` and waits; `fillLocaleBundle` loads them for you
|
|
533
|
+
(a code set to `null` = no texts for that language, the next one is tried):
|
|
534
|
+
|
|
535
|
+
```ts
|
|
536
|
+
export const localeSignal = signal<LocaleBundle | null>(null);
|
|
537
|
+
const loadTexts = loadLocaleGroups.bind(null, import.meta.glob("./locales/*/*.json"));
|
|
538
|
+
loadLocale: localeSignal, // config.ts
|
|
539
|
+
useEffect(() => fillLocaleBundle(localeSignal, loadTexts)); // start once (returns the stop function)
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
This `localeSignal` is your app's own signal. The library also exports a `localeSignal` (the current language
|
|
543
|
+
code); in a file that needs both, import the library one with an alias:
|
|
544
|
+
`import { localeSignal as currentLanguageSignal } from "shared-lib-web"`.
|
|
545
|
+
- One JSON per language still works: `loadLocale: (code) => import(\`./locales/${code}.json\`)`.
|
|
546
|
+
|
|
547
|
+
**One sublevel only:** a key is `"key"` or `"group.key"` (`t("user.title")`, `t("branch.title")`). Deeper keys like
|
|
548
|
+
`user.role.admin` are not looked up, and the library warns in the console when a locale file has them — use
|
|
549
|
+
`role.admin` or `user.roleAdmin` instead.
|
|
550
|
+
|
|
551
|
+
Lookup order: current language → `defaultLanguage` (else en-US) → library defaults (`ui.*` and dff-util `ConstMessages`) → the key.
|
|
552
|
+
Shell texts to translate: `ui.language, theme, openMenu, expandMenu, collapseMenu, home, loading, close, noData,
|
|
553
|
+
selectOption, search, navigation, account, logout, confirm, cancel, translate, permissionDenied,
|
|
554
|
+
permissionDeniedText, pageNotFound, pageNotFoundText, backToHome, goBack, reloadPage, comingSoon, comingSoonText,
|
|
555
|
+
openPreview, playVideo, mediaError`.
|
|
556
|
+
|
|
557
|
+
## 3. main.tsx and app.tsx
|
|
558
|
+
|
|
559
|
+
```tsx
|
|
560
|
+
// root.tsx – one input: the config (menu, languages, branches come from its loaders)
|
|
561
|
+
export function Root() {
|
|
562
|
+
return (
|
|
563
|
+
<SharedWebUiProvider type="spa" config={config}>
|
|
564
|
+
<App />
|
|
565
|
+
</SharedWebUiProvider>
|
|
566
|
+
);
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
// main.tsx
|
|
570
|
+
const root = createRoot(rootElement);
|
|
571
|
+
root.render(<Root />);
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
```tsx
|
|
575
|
+
// app.tsx – ONE component holds all pages; ?page picks which one is shown
|
|
576
|
+
import { AppLayout, AuthLayout } from "shared-lib-web/layout"; // optional, see "Layout" below
|
|
577
|
+
|
|
578
|
+
const PAGE_ELEMENTS: Record<string, ReactElement> = {
|
|
579
|
+
"/": <DashboardPage />,
|
|
580
|
+
"/profiles": <UserPage />, // keys = the menu hrefs
|
|
581
|
+
"/app-settings": <SettingsPage />,
|
|
582
|
+
};
|
|
583
|
+
|
|
584
|
+
function readPageElement(page: string): ReactElement {
|
|
585
|
+
return PAGE_ELEMENTS[page] ?? <PageNotFound />;
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
export function App() {
|
|
589
|
+
const page = useCurrentPage(); // "/profiles" from ?page=profiles (re-renders on change)
|
|
590
|
+
if (!isLoggedIn.value) {
|
|
591
|
+
return (
|
|
592
|
+
<AuthLayout>
|
|
593
|
+
<LoginPage />
|
|
594
|
+
</AuthLayout>
|
|
595
|
+
);
|
|
596
|
+
}
|
|
597
|
+
const pageElement = readPageElement(page);
|
|
598
|
+
return (
|
|
599
|
+
<AppLayout headerEnd={<UserMenu name={userName} email={email} onLogout={handleLogout} />}>
|
|
600
|
+
<RequireAccess key={page}>{pageElement}</RequireAccess>
|
|
601
|
+
</AppLayout>
|
|
602
|
+
);
|
|
603
|
+
}
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
### Layout: single, parts or own (optional)
|
|
607
|
+
|
|
608
|
+
```tsx
|
|
609
|
+
import { AppLayout, AsideLayout, AuthLayout, Header, Sidebar, SidebarNav } from "shared-lib-web/layout";
|
|
610
|
+
|
|
611
|
+
// 1. Single layout – everything ready-made
|
|
612
|
+
<AppLayout headerEnd={<UserMenu ... />} sidebarFooter="v1.0">{page}</AppLayout>
|
|
613
|
+
|
|
614
|
+
// 2. Single layout with options
|
|
615
|
+
<AppLayout showSidebar={false}>{page}</AppLayout> // header + page only
|
|
616
|
+
<AppLayout showHeader={false}>{page}</AppLayout> // sidebar + page only
|
|
617
|
+
<AppLayout header={<MyHeader />} sidebar={<MySidebar />} footer={<MyFooter />}>{page}</AppLayout>
|
|
618
|
+
|
|
619
|
+
// 2b. AsideLayout – no top header, only the side menu and the page
|
|
620
|
+
<AsideLayout sidebarUser={<UserMenu isInSidebar ... />}>{page}</AsideLayout>
|
|
621
|
+
// desktop: collapsible to an icon rail (button at the bottom, tooltips on the rail)
|
|
622
|
+
// small screens: always the icon rail (no drawer, no menu button)
|
|
623
|
+
// no mega menu: menuMode is ignored and hidden in the settings dialog
|
|
624
|
+
// the user at the bottom of the sidebar; HeadLayout sticks at top-0
|
|
625
|
+
// options: sidebarFooter, showSettings (settings button at the bottom, default false), showSidebar, sidebar, footer
|
|
626
|
+
// signals: isAsideLayoutSignal, isSmallScreenSignal, isRailEverywhereSignal
|
|
627
|
+
|
|
628
|
+
// 3. MainLayout: the project's own layout from the individual parts (any markup around them)
|
|
629
|
+
<div className="flex min-h-screen flex-col">
|
|
630
|
+
<Header endContent={<UserMenu ... />} isStandalone /> {/* brand always shown on desktop */}
|
|
631
|
+
<div className="flex flex-1">
|
|
632
|
+
<aside className="w-64"><SidebarNav isAlwaysExpanded /></aside> {/* only the menu */}
|
|
633
|
+
<main>{page}</main>
|
|
634
|
+
</div>
|
|
635
|
+
</div>
|
|
636
|
+
|
|
637
|
+
// 4. No layout entry at all – the project writes everything with the main entry:
|
|
638
|
+
// AppBrand, UserMenu, LanguageSwitcher, ThemeSwitcher, SettingsMenu, PageLink, toggleSidebar ...
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
**Menu on / off at runtime** (works with `AppLayout`, `Header`, `SidebarNav` and the mega menu):
|
|
642
|
+
|
|
643
|
+
```ts
|
|
644
|
+
setMenuVisible(false); // hide the sidebar / rail / mega menu bar and the menu buttons, e.g. a full-screen page
|
|
645
|
+
setMenuVisible(true); // show it again
|
|
646
|
+
toggleMenuVisible(); // switch
|
|
647
|
+
isMenuVisibleSignal.value // current state (re-renders components)
|
|
648
|
+
// start value: config.layout.showMenu (default true)
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
| Part | Options |
|
|
652
|
+
| --- | --- |
|
|
653
|
+
| `AppLayout` | `headerEnd`, `sidebarFooter`, `showHeader`, `showSidebar` (default: `isMenuVisibleSignal`), `header`, `sidebar`, `footer` |
|
|
654
|
+
| `Header` | `endContent`, `startContent`, `showMenuButtons`, `showSwitchers`, `isStandalone` |
|
|
655
|
+
| `Sidebar` | `footer`, `showBrand` |
|
|
656
|
+
| `SidebarNav` | `className`, `isAlwaysExpanded`, `isAlwaysShown` (menu list only, follows permissions and the menu on/off switch, skeleton until `loadMenuNavigation` answers) |
|
|
657
|
+
|
|
658
|
+
The example app shows both: Settings → *App layout* switches between `AppLayout` and
|
|
659
|
+
`MainLayout` in `example/src/layout/main-layout.tsx`.
|
|
660
|
+
|
|
661
|
+
### No router: query parameters
|
|
662
|
+
|
|
663
|
+
There is no router and nothing redirects. A menu click only sets `?page=<menu href>` with the History API
|
|
664
|
+
(no reload); the app shows the component for that value. Back / forward work.
|
|
665
|
+
|
|
666
|
+
**Path mode:** `layout: { pageMode: "path" }` puts the page in the path instead — `http://host/profiles` rather than
|
|
667
|
+
`http://host/?page=profiles`. Menu links, `openPage`, `PageLink`, `useCurrentPage` and back / forward all follow it;
|
|
668
|
+
other query parameters still work (`/profiles?userId=7`). The server must answer every path with `index.html`
|
|
669
|
+
(Vite dev does). For code outside React (for example single-spa `activeWhen`) use `readPageFromLocation(location)`,
|
|
670
|
+
which reads the page in either mode.
|
|
671
|
+
|
|
672
|
+
| Function | What it does |
|
|
673
|
+
| --- | --- |
|
|
674
|
+
| `openPage("/profiles")` | Sets `?page=profiles` (no leading slash in the address bar; inside the app pages stay menu hrefs like `"/profiles"`; old `?page=/profiles` links still work; helpers `toPageParamValue` / `toPagePath`), removes the old page's parameters, closes menus, scrolls up. `openPage(page, { userId: "42" })` adds values; `{ isKeepingOtherParams: true }` keeps the old ones. |
|
|
675
|
+
| `setQueryParam("userId", "42")` | Adds or changes one parameter: `?page=profiles&userId=42`. `undefined` / `""` removes it. `{ isReplace: true }` replaces the history entry. |
|
|
676
|
+
| `setQueryParams({ userId: "42", mode: "edit" })` | Several at once. |
|
|
677
|
+
| `removeQueryParam("userId")` | Removes one. |
|
|
678
|
+
| `readQueryParam("userId")`, `readQueryParams()` | Read values (outside components or in handlers). |
|
|
679
|
+
| `useQueryParam("userId")`, `useCurrentPage()` | Read values in a component and re-render when they change. |
|
|
680
|
+
| `<PageLink page="/profiles">` | A link that calls `openPage` (Ctrl/Cmd-click opens a new tab). |
|
|
681
|
+
|
|
682
|
+
Example (users page): row click → `setQueryParams({ userId, mode: "view" })`; on load
|
|
683
|
+
`readQueryParams()` reopens the drawer, so a refresh or a shared link shows the same user.
|
|
684
|
+
|
|
685
|
+
## 4. Pages
|
|
686
|
+
|
|
687
|
+
```tsx
|
|
688
|
+
const { locale, theme, direction, t, changeLanguage, changeTheme } = useUi();
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
Permissions: wrap the page in `<RequireAccess>` (shows `PermissionDenied` when the menu item of the current `?page` has `read: false`) and use
|
|
692
|
+
`canAccess("update")` / `canAccess("delete")` for buttons.
|
|
693
|
+
|
|
694
|
+
## 5. Icons – TypeIcon
|
|
695
|
+
|
|
696
|
+
```tsx
|
|
697
|
+
<TypeIcon name="Users" />
|
|
698
|
+
<TypeIcon name="Pencil" size={16} title="Edit" onPress={handleEditClick} />
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
All icons (navigation, buttons, library) use lucide names from https://lucide.dev/icons.
|
|
702
|
+
|
|
703
|
+
## 6. Forms – react-hook-form
|
|
704
|
+
|
|
705
|
+
Every control takes `{ control, name, label, rules }` and translates its error message
|
|
706
|
+
(use dff-util `ConstKeys` as messages and `RegExp` as patterns).
|
|
707
|
+
|
|
708
|
+
| Control | Value |
|
|
709
|
+
| --- | --- |
|
|
710
|
+
| `TypeInput`, `TypeTextArea` | text |
|
|
711
|
+
| `TypeSelect` | option key (dff-util `OptionType`, `option.lang[locale]` shown) |
|
|
712
|
+
| `TypeSwitch`, `TypeCheckbox` | boolean |
|
|
713
|
+
| `TypeDate` (`isDateTime`) | `"2026-11-05"` / `"2026-11-05T14:30"` |
|
|
714
|
+
| `TypeTime` | `"14:30"` |
|
|
715
|
+
| `TypeOtp` (`length`) | `"123456"` |
|
|
716
|
+
| `TypeList` (`selectionMode`) | `string[]` or `string` |
|
|
717
|
+
| `TypeLang` (`type="text" | "textarea"`) | `TranslationType` `{ en: "...", fr: "..." }` for every config language, with translate buttons (dff-util `CallLangText`) |
|
|
718
|
+
| `TypeMdx` (from `shared-lib-web/markdown`) | markdown text (editor) |
|
|
719
|
+
| `TypeLangMd` (from `shared-lib-web/markdown`) | markdown per language `{ en: "...", fr: "..." }` with translate buttons |
|
|
720
|
+
|
|
721
|
+
`TypeMdv` (from `shared-lib-web/markdown`) shows markdown, or the current language of `textByLanguage`. All three follow light/dark themes.
|
|
722
|
+
|
|
723
|
+
```tsx
|
|
724
|
+
import { TypeLangMd, TypeMdv, TypeMdx } from "shared-lib-web/markdown";
|
|
725
|
+
|
|
726
|
+
<TypeLang control={control} name="title" label={t("page.title")} rules={pageValidation.title} />
|
|
727
|
+
<TypeLangMd control={control} name="body" label={t("page.body")} height={250} />
|
|
728
|
+
<TypeMdv textByLanguage={page.body} />
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
### File upload – TypeUpload
|
|
732
|
+
|
|
733
|
+
```tsx
|
|
734
|
+
<TypeUpload control={control} name="csvFile" label={t("product.csv")} fileType="csv" maxSize="10MB" rules={rules.csvFile} />
|
|
735
|
+
<TypeUpload control={control} name="photos" label={t("product.photos")} fileType={["png", "jpg"]} maxSize="5MB" isMultiple totalSize="20MB" />
|
|
736
|
+
<TypeUploadBox name="import" fileType="csv" maxSize={10} value={importFile.value} onChange={handleImportFileChange} />
|
|
737
|
+
```
|
|
738
|
+
|
|
739
|
+
Drag & drop or browse, type and size checks (per file and total), warning banner + toast, file list with remove.
|
|
740
|
+
Value: `File` (single) or `File[]` (`isMultiple`). Then upload with:
|
|
741
|
+
|
|
742
|
+
```ts
|
|
743
|
+
const signed = await AppHttp.Post(`${MsUrl.utils}/s3/upload-url`, { fileName: file.name });
|
|
744
|
+
const uploaded = await uploadToSignedUrl(file, signed.data.upload, signed.data.download); // FileType
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
Helpers: `parseSizeToBytes`, `formatBytes`, `normalizeFileTypes`, `isFileTypeAllowed`, `readFileIconName`, `setLeaveGuard`.
|
|
748
|
+
|
|
749
|
+
Option lists from dff-util data: `readCountryOptions()`, `readTelCodeOptions()` (+ `readTelCode("IN")` → `"+91"`), `readLanguageOptions()`.
|
|
750
|
+
|
|
751
|
+
## 7. Other components
|
|
752
|
+
|
|
753
|
+
### Sticky page header (HeadLayout)
|
|
754
|
+
|
|
755
|
+
```tsx
|
|
756
|
+
const headActions = (
|
|
757
|
+
<>
|
|
758
|
+
<TypeButton action="ghost" icon="X" label={t("user.cancel")} onPress={handleUserCancel} />
|
|
759
|
+
<TypeButton type="submit" form="user-form" icon="Save" label={t("user.save")} />
|
|
760
|
+
</>
|
|
761
|
+
);
|
|
762
|
+
|
|
763
|
+
<HeadLayout title={t("user.editTitle")} actions={headActions} />
|
|
764
|
+
<form id="user-form" onSubmit={onSubmit}>...</form>
|
|
765
|
+
```
|
|
766
|
+
|
|
767
|
+
- Put it first in the page. It sticks at `top-16` (under the 4rem app `Header`); `isBelowHeader={false}` sticks at `top-0`.
|
|
768
|
+
- `isFullWidth` (default true) stretches it over the `<main>` padding (`p-4 lg:p-6`) to both edges; `false` gives a rounded card.
|
|
769
|
+
- The buttons sit outside the `<form>`, so give the form an `id` and pass it to `TypeButton form="..."`.
|
|
770
|
+
- Optional `children` add a row under the title (filters, tabs).
|
|
771
|
+
|
|
772
|
+
| Export | What it is |
|
|
773
|
+
| --- | --- |
|
|
774
|
+
| `AppLayout`, `AuthLayout` (from `shared-lib-web/layout`) | Optional single layouts (children = page) |
|
|
775
|
+
| `Header`, `Sidebar`, `SidebarNav`, `SidebarCollapseButton`, `MegaMenuBar`, `MegaMenuPanel`, `RailFlyout` (from `shared-lib-web/layout`) | Optional individual layout parts. The collapse / expand button sits fixed at the bottom of `Sidebar` (desktop, sidebar mode); `<Sidebar showCollapseButton={false} />` hides it, `SidebarCollapseButton` places it in an own layout. User at the bottom of the side menu: `<AppLayout sidebarUser={<UserMenu isInSidebar ... />}>` (avatar + name + email; avatar only on the collapsed rail, menu opens next to it). On the collapsed rail every icon (links, groups, user, expand button) shows a tooltip with its label (`RailTooltip`, rendered by AppLayout; own layouts render `<RailTooltip />` once; any element can opt in with `data-rail-tip="Label"`) |
|
|
776
|
+
| `AppBrand`, `PageLink` | Navigation pieces for any layout (main entry) |
|
|
777
|
+
| `HeadLayout` | Sticky page header (h-16, same height as the logo box): one-line title on the start side, actions (Cancel, Submit) on the end side; stays under the app header while the page scrolls |
|
|
778
|
+
| `ArticleLayout`, `ContentLayout`, `GridLayout`, `FloatLayout` | Page sections |
|
|
779
|
+
| `TypeButton`, `TypeTable` (+ `readRowKey`), `TypeDropdown` (+ `readDataValue`) | Actions and lists |
|
|
780
|
+
| `TypeSearch` (`onChange` live or `onSearch` on Enter + `readSearchText`), `TypeFilter` | List filters (not form fields) |
|
|
781
|
+
| `TypeImage`, `TypeVideo` | Media thumbnails: skeleton while loading, error icon if the file fails; a click opens one shared popup (`MediaViewer`, rendered by the provider) with the full image, or the video playing with controls. `<TypeImage src alt previewSrc? fit? className? width? height? isPreviewable? />`, `<TypeVideo src title poster? className? width? height? isPreviewable? />` (optional `width` / `height`: number = px, string = any CSS size such as `"12rem"` or `"100%"`; only a height keeps the 16:9 shape) (no poster = first frame; `isPreviewable={false}` plays inline). `openMediaPreview({ type, src, title, poster })` / `closeMediaPreview()` open it from code |
|
|
782
|
+
| `TypeModal`, `TypeDrawer`, `TypeConfirm` | Overlays (Escape, backdrop and ✕ close them) |
|
|
783
|
+
| `UserMenu`, `LanguageSwitcher`, `ThemeSwitcher`, `SettingsMenu` | Header menus |
|
|
784
|
+
| `ShowProgress(true/false)`, `TopProgress`, `ScrollToTop` | Request progress bar and scroll-to-top button |
|
|
785
|
+
| `EmptyState`, `PermissionDenied`, `RequireAccess`, `PageNotFound`, `ComingSoon`, `PageLoader` | States and pages |
|
|
786
|
+
| `SkeletonArticle`, `SkeletonTable`, `SkeletonForm`, `SkeletonCards`, `SkeletonDashboard`, `SkeletonChat`, `SkeletonMenu`, `SkeletonAuthForm`, `SkeletonPage`, `SkeletonFloat` | Loading placeholders |
|
|
787
|
+
| `ShowToast(message, type)` | Toasts |
|
|
788
|
+
| `trans(textByLanguage, defaultText)` | Pick a backend translation for the current language |
|
|
789
|
+
| `AppStorage.getData / getText / setData / removeData / clearData / envData`, `TOKEN`, `LANG`, `THEME`, `BRANCH_ID` … `StorageKeys` | Prefixed session/local storage, shared key constants, `window.env` settings |
|
|
790
|
+
| `openPage`, `setQueryParam(s)`, `removeQueryParam`, `readQueryParam(s)`, `useQueryParam`, `useCurrentPage`, `PageLink`, `currentPageSignal`, `queryParamsSignal` | Pages and query parameters (no router) |
|
|
791
|
+
| `setLanguages(reply)`, `toLanguageOptions(reply)`, `languagesSignal`, `LangSource`, `LanguageRowType`, `setMenu(reply)`, `setMenuLoading()`, `clearMenu()`, `toNavigation(reply)`, `toNavItems(menus)`, `unwrapRootMenu(menus, "ADMIN_ROOT")`, `MenuAccessType`, `MenuResponseType`, `MenuSource`, `MenuOptions`, `ScreenAccessType`, `TranslationType`, `AuthUser` | Backend menus and shared app types (menu icons are fixed with `resolveLucideIcon`) |
|
|
792
|
+
| `AppHttp.Get / GetShared / Post / Put / Patch / Delete / Load / Media / CloudUpload (uploadFile) / DownloadFile`, `clearSharedGetCache()`, `AppHttp.BaseUrl()`, `AppHttp.FullUrl(url)`, `AppHttp.setHeader`, `readEnvData(appNameKey, key)`, `uploadToSignedUrl`, `setAppConfig` / `readAppConfig` | HTTP client on dff-util `Http`: bearer token, session id, branch, extra headers, progress bar |
|
|
793
|
+
| `setCompanyDetails(reply)`, `companyDetailsSignal`, `readCompanyDetails(reply)`, `readAppNameLabel(config, details)`, `readLogoUrl(config, isDark, details)`, `CompanyDetails`, `CompanySource` | Company / brand details (app name, company name, favicon, logos) |
|
|
794
|
+
| `setCustomThemes(themes)`, `toCustomThemeList(themes)`, `customThemesSignal`, `CustomThemeMap`, `CustomThemes` | Custom themes as data (object keyed by theme name, or a list) |
|
|
795
|
+
| `setBranch(id, name)`, `readBranchId()`, `clearBranch()`, `branchIdSignal`, `branchNameSignal` | Selected branch, sent as `x-branch-id` |
|
|
796
|
+
| `startSession(token, user, isRemembered)`, `restoreSession()`, `endSession(keepKeys)`, `authUserSignal`, `isAuthenticatedSignal` | Login state (restored on reload) |
|
|
797
|
+
| `toOptionTypes(rows)`, `readResponseRows(response)` | Backend option rows → `OptionType[]` |
|
|
798
|
+
| `resolveLucideIcon("user-round-key")` | Backend icon names → lucide names |
|
|
799
|
+
| `encryptPayload`, `decryptResponse` | AES-GCM payload encryption (key passed in) |
|
|
800
|
+
| `SharedRegExp` | dff-util `RegExp` + `MOBILE_10`, `PERSON_NAME`, `ADDRESS_TEXT`, `UPPER_ALPHA_NUMERIC` |
|
|
801
|
+
| `canAccessPath(action, path)` | Permission check for any path |
|
|
802
|
+
| Signals | `localeSignal`, `themeSignal`, `directionSignal`, `translationSignal`, `isDarkThemeSignal`, `navigationSignal`, `navigationModeSignal`, `pathnameSignal`, `screenAccessSignal` … |
|
|
803
|
+
|
|
804
|
+
Every component uses DaisyUI theme colours (`base-*`, `primary` …), so all themes – light and dark – work.
|
|
805
|
+
|
|
806
|
+
---
|
|
807
|
+
|
|
808
|
+
## Example apps
|
|
809
|
+
|
|
810
|
+
There are two examples, each its own small Vite app that uses the library source directly:
|
|
811
|
+
|
|
812
|
+
| Folder | Port | Shows |
|
|
813
|
+
| --- | --- | --- |
|
|
814
|
+
| `example-basic/` | 5174 | **One language** (en-US, `defaultLanguage` + `loadLocale`, no `loadSupportLanguages`) and **no branches** (no `loadBranches`): login, dashboard, users CRUD, settings (theme, menu mode, menu on/off). The smallest real setup to copy. |
|
|
815
|
+
| `example-mfe/` | 9000 | **Microfrontends**: 4 separate Vite projects — `shell` (the only `AppLayout`, login, single-spa routing from `env.mfe.js`, menu as a signal (`loadMenuNavigation: navSignal`), `type="shell"`) and 3 MFEs `settings`, `forms`, `profile` (`type="mfe"`, page layouts only; theme and language from localStorage, kept in sync between bundles). No shared folder: each project has its own config, texts and theme. See `example-mfe/README.md`. |
|
|
816
|
+
| `example/` | 5173 | **10 languages** (`loadSupportLanguages`, 3 RTL) and **stores** (`loadBranches`, `isDefault` / `disabled`), plus every component, 3 layouts and all themes. |
|
|
817
|
+
|
|
818
|
+
```bash
|
|
819
|
+
npm run example-basic:install
|
|
820
|
+
npm run example-basic:dev # http://localhost:5174
|
|
821
|
+
```
|
|
822
|
+
|
|
823
|
+
### Full example
|
|
824
|
+
|
|
825
|
+
`example/` is its own small app package (Vite is used only there — an app needs a bundler; the library does not).
|
|
826
|
+
It shows login, dashboard, users CRUD (drawer + confirm + permissions), a **Components** section with every control,
|
|
827
|
+
upload, overlay, skeleton and state, and settings for language (10, including 3 RTL and Telugu, Kannada, Tamil), theme (all 35 DaisyUI themes + custom `org-light` / `org-dark`) and navigation style.
|
|
828
|
+
All pages live in one `App` component (`example/src/app.tsx`) and are picked by `?page`; the languages, branches and
|
|
829
|
+
menu are signals in the config (`example/src/app-init/app-init-signals.ts`), filled from the sor replies by
|
|
830
|
+
`app-init/app-init.service.ts`. It uses the library source directly, so changes show up without a build.
|
|
831
|
+
|
|
832
|
+
The example loads everything from the **sor** service (`MsUrl.sor` → `/api/org-sor`), except the menu, which comes
|
|
833
|
+
from **utils** (`MsUrl.utils` → `/api/org-util`):
|
|
834
|
+
|
|
835
|
+
| Data | Request | Signal |
|
|
836
|
+
| --- | --- | --- |
|
|
837
|
+
| Company details | `GET /company-details` | `companySignal` (on start) |
|
|
838
|
+
| Languages | `GET /load/LANG?active=true` | `supportLangSignal` (on start) |
|
|
839
|
+
| Themes | `GET /content-load?query=theme` | `themesSignal` (on start) |
|
|
840
|
+
| Texts of a language | `GET /content-load?query=locales.<code>` (all languages: `?query=locales`) | `localeSignal` (languages the library asks for) |
|
|
841
|
+
| Menu (utils) | `GET /authorization/<persona>?roles=<roles joined with ",">` (from the signed-in user) | `navSignal` (after sign in) |
|
|
842
|
+
| Branches | `GET /load/BRANCHS?profile=<user id>` | `branchSignal` (after sign in, before the menu) |
|
|
843
|
+
|
|
844
|
+
`readContent(reply, query)` takes the content out of a `content-load` reply (`{ data }` and the query path are
|
|
845
|
+
optional: `readContent(reply, "locales.en-US")`). The examples have no fake backend: they call these services at
|
|
846
|
+
`http.baseUrl` (`/api`) or `window.env.REACT_APP_ORG_API_BASE_URL` (`public/env.js`), so point that at your backend.
|
|
847
|
+
example-basic and the MFE shell work the same way (no branches).
|
|
848
|
+
|
|
849
|
+
```bash
|
|
850
|
+
npm run example:install
|
|
851
|
+
npm run example:dev # http://localhost:5173 – log in with any email and a 6+ character password
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
## Development
|
|
855
|
+
|
|
856
|
+
The library has **no bundler and no Vite**: `tsc` compiles `src/` file by file into `dist/` (readable ES modules + `.d.ts`),
|
|
857
|
+
and the tests run on Node's built-in test runner (`node:test` + `jsdom`, setup in `scripts/test-setup.mjs`).
|
|
858
|
+
|
|
859
|
+
```bash
|
|
860
|
+
npm install
|
|
861
|
+
npm run verify # typecheck + code style + tests + build
|
|
862
|
+
npm run build # tsc -> dist/, fix .d.ts import paths, copy styles.css
|
|
863
|
+
npm run check:style # readability rules only
|
|
864
|
+
npm test # tsc -> build-test/, then Node's built-in test runner (node --test) with jsdom
|
|
865
|
+
```
|
|
866
|
+
|
|
867
|
+
Inside `src/`, relative imports use the real file extension (`./type.icon.ts`); `tsc` rewrites them to `.js` in `dist/`.
|
|
868
|
+
|
|
869
|
+
## Publishing
|
|
870
|
+
|
|
871
|
+
```bash
|
|
872
|
+
npm login
|
|
873
|
+
npm version minor
|
|
874
|
+
npm publish
|
|
875
|
+
```
|
|
876
|
+
|
|
877
|
+
Or use `github-workflows/publish.yml` (move it to `.github/workflows/` and add the `NPM_TOKEN` secret).
|
|
878
|
+
|
|
879
|
+
## License
|
|
880
|
+
|
|
881
|
+
[MIT](./LICENSE) © 2026 DesignForFeature.
|
|
882
|
+
|
|
883
|
+
Anybody can use this library for free, in personal or commercial projects: use it, copy it, change it, merge it,
|
|
884
|
+
publish it, share it and sell software built with it. The only condition is to keep the copyright and license notice
|
|
885
|
+
(the `LICENSE` file) with copies of the library. It comes "as is", without warranty.
|