shared-lib-web 0.0.0-stage → 0.0.2
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 +630 -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 +23 -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 +19 -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 +8 -0
- package/dist/components/language-switcher.d.ts.map +1 -0
- package/dist/components/language-switcher.js +48 -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 +17 -0
- package/dist/components/settings-menu.d.ts.map +1 -0
- package/dist/components/settings-menu.js +102 -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 +39 -0
- package/dist/context/use-ui.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 +64 -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-service.d.ts +36 -0
- package/dist/i18n/locale-service.d.ts.map +1 -0
- package/dist/i18n/locale-service.js +163 -0
- package/dist/i18n/locale-service.js.map +1 -0
- package/dist/i18n/translator.d.ts +14 -0
- package/dist/i18n/translator.d.ts.map +1 -0
- package/dist/i18n/translator.js +81 -0
- package/dist/i18n/translator.js.map +1 -0
- package/dist/index.d.ts +106 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +119 -0
- package/dist/index.js.map +1 -0
- package/dist/interfaces/app-types.d.ts +137 -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 +172 -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 +26 -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 +28 -0
- package/dist/providers/register-config.js.map +1 -0
- package/dist/providers/shared-web-ui-provider.d.ts +31 -0
- package/dist/providers/shared-web-ui-provider.d.ts.map +1 -0
- package/dist/providers/shared-web-ui-provider.js +54 -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 +63 -0
- package/dist/query/query-param.d.ts.map +1 -0
- package/dist/query/query-param.js +215 -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/auth-service.d.ts +28 -0
- package/dist/state/auth-service.d.ts.map +1 -0
- package/dist/state/auth-service.js +92 -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/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 +16 -0
- package/dist/state/language-service.d.ts.map +1 -0
- package/dist/state/language-service.js +73 -0
- package/dist/state/language-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 +85 -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 +84 -0
- package/dist/state/signals.d.ts.map +1 -0
- package/dist/state/signals.js +137 -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/dark-themes.d.ts +2 -0
- package/dist/theme/dark-themes.d.ts.map +1 -0
- package/dist/theme/dark-themes.js +20 -0
- package/dist/theme/dark-themes.js.map +1 -0
- package/dist/theme/logo.d.ts +4 -0
- package/dist/theme/logo.d.ts.map +1 -0
- package/dist/theme/logo.js +10 -0
- package/dist/theme/logo.js.map +1 -0
- package/dist/theme/theme-service.d.ts +21 -0
- package/dist/theme/theme-service.d.ts.map +1 -0
- package/dist/theme/theme-service.js +69 -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 +49 -0
- package/dist/utils/app-http.d.ts.map +1 -0
- package/dist/utils/app-http.js +229 -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/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/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/storage-keys.d.ts +68 -0
- package/dist/utils/storage-keys.d.ts.map +1 -0
- package/dist/utils/storage-keys.js +75 -0
- package/dist/utils/storage-keys.js.map +1 -0
- package/package.json +101 -4
- package/src/components/app-brand.tsx +37 -0
- package/src/components/branch-switcher.tsx +74 -0
- package/src/components/coming-soon.tsx +35 -0
- package/src/components/empty-state.tsx +42 -0
- package/src/components/language-switcher.tsx +77 -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 +224 -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 +42 -0
- package/src/i18n/default-messages.ts +67 -0
- package/src/i18n/direction.ts +43 -0
- package/src/i18n/locale-service.ts +187 -0
- package/src/i18n/translator.ts +88 -0
- package/src/index.ts +341 -0
- package/src/interfaces/app-types.ts +154 -0
- package/src/interfaces/toast.ts +12 -0
- package/src/interfaces/ui-config.ts +189 -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 +30 -0
- package/src/providers/register-config.ts +30 -0
- package/src/providers/shared-web-ui-provider.tsx +98 -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 +263 -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/auth-service.ts +104 -0
- package/src/state/branch-service.ts +217 -0
- package/src/state/document-sync.ts +43 -0
- package/src/state/language-service.ts +80 -0
- package/src/state/menu-service.ts +67 -0
- package/src/state/navigation-service.ts +160 -0
- package/src/state/preference-sync.ts +93 -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 +183 -0
- package/src/state/toast-service.ts +45 -0
- package/src/styles.css +15 -0
- package/src/theme/dark-themes.ts +20 -0
- package/src/theme/logo.ts +12 -0
- package/src/theme/theme-service.ts +82 -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 +255 -0
- package/src/utils/app-storage.ts +259 -0
- package/src/utils/crypto-util.ts +88 -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/storage-keys.ts +80 -0
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
// ui-config.ts
|
|
2
|
+
// The strongly typed contract between an app and the UI shell.
|
|
3
|
+
// An app only writes ONE object of type UiConfig (in its config.ts),
|
|
4
|
+
// its locale JSON files and its pages. Everything else lives in this package.
|
|
5
|
+
|
|
6
|
+
import type { LangDirType } from "dff-util";
|
|
7
|
+
import type { IconName } from "../types/type.icon.ts";
|
|
8
|
+
import type { MenuOptions } from "./app-types.ts";
|
|
9
|
+
|
|
10
|
+
/** Text direction. "ltr" = left to right, "rtl" = right to left. Same type as dff-util. */
|
|
11
|
+
export type Direction = LangDirType;
|
|
12
|
+
|
|
13
|
+
/** A DaisyUI theme name, for example "light", "dark", "corporate", "dracula". */
|
|
14
|
+
export type Theme = string;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Translations for one language.
|
|
18
|
+
* Values are text or nested groups: { "nav": { "home": "Home" } } is read with t("nav.home").
|
|
19
|
+
*/
|
|
20
|
+
export interface LocaleMessages {
|
|
21
|
+
[key: string]: string | LocaleMessages;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/** What a locale loader may return: the messages, or a JSON module with a default export. */
|
|
25
|
+
export type LocaleModule = LocaleMessages | { default: LocaleMessages };
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Loads one locale JSON file lazily.
|
|
29
|
+
* Example in config.ts: function loadEnglish(): Promise<LocaleModule> { return import("./locales/en.json"); }
|
|
30
|
+
*/
|
|
31
|
+
export type LocaleLoader = () => Promise<LocaleModule>;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Loads the locale JSON file of any language code. Used when the languages come from the backend.
|
|
35
|
+
* Example in config.ts: function loadLocale(code: string): Promise<LocaleModule> { return import(`./locales/${code}.json`); }
|
|
36
|
+
*/
|
|
37
|
+
export type LocaleCodeLoader = (languageCode: string) => Promise<LocaleModule>;
|
|
38
|
+
|
|
39
|
+
/** One language offered in the language switcher. */
|
|
40
|
+
export interface LanguageOption {
|
|
41
|
+
/** Language code, for example "en-US", "fr-FR", "ar-SA". Used for <html lang> and the locale file name. */
|
|
42
|
+
code: string;
|
|
43
|
+
/** Name shown in the switcher, in that language (for example "Français"). */
|
|
44
|
+
label: string;
|
|
45
|
+
/** Optional flag or short text shown before the label. */
|
|
46
|
+
flag?: string;
|
|
47
|
+
/** Force a direction. When missing, ar, he, fa and ur are "rtl" and every other code is "ltr". */
|
|
48
|
+
direction?: Direction;
|
|
49
|
+
/** Loads the locale JSON file for this language. Default: config.loadLocale(code). */
|
|
50
|
+
load?: LocaleLoader;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/** What the current user may do on a screen. Missing values count as true. */
|
|
54
|
+
export interface ScreenPermissions {
|
|
55
|
+
read?: boolean;
|
|
56
|
+
create?: boolean;
|
|
57
|
+
update?: boolean;
|
|
58
|
+
delete?: boolean;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** One entry in the navigation (sidebar and mega menu). */
|
|
62
|
+
export interface NavItem {
|
|
63
|
+
/** Unique id. */
|
|
64
|
+
id: string;
|
|
65
|
+
/** Translation key (or plain text) of the visible label, for example "nav.users". */
|
|
66
|
+
labelKey: string;
|
|
67
|
+
/** Label per language from the backend, for example { en: "Users", fr: "Utilisateurs" }. Wins over labelKey. */
|
|
68
|
+
labelLang?: Record<string, string>;
|
|
69
|
+
/** Translation key of a short description, shown in the mega menu. */
|
|
70
|
+
descriptionKey?: string;
|
|
71
|
+
/** Route path, for example "/users". Leave empty for a group that only has children. */
|
|
72
|
+
path?: string;
|
|
73
|
+
/** lucide-react icon name shown with TypeIcon, for example "Users". */
|
|
74
|
+
icon?: IconName;
|
|
75
|
+
/** Permissions for this screen. read: false hides the item and blocks the page (RequireAccess). */
|
|
76
|
+
permissions?: ScreenPermissions;
|
|
77
|
+
/** Child items shown as a sub menu (sidebar) or a column (mega menu). */
|
|
78
|
+
children?: NavItem[];
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* How the main navigation is shown.
|
|
83
|
+
* - "sidebar": left drawer (collapses to an icon rail on desktop)
|
|
84
|
+
* - "megamenu": top bar with full-width mega menu panels (drawer on small screens)
|
|
85
|
+
*/
|
|
86
|
+
export type NavigationMode = "sidebar" | "megamenu";
|
|
87
|
+
|
|
88
|
+
/** Layout settings. */
|
|
89
|
+
export interface LayoutConfig {
|
|
90
|
+
/** Menu mode at start: "sidebar" or "megamenu". Default "sidebar". The user's pick is saved as MENU_MODE. */
|
|
91
|
+
menuMode?: NavigationMode;
|
|
92
|
+
/** Show the menu (sidebar / mega menu bar) at start. Change it at runtime with setMenuVisible(). Default true. */
|
|
93
|
+
showMenu?: boolean;
|
|
94
|
+
/** Allow collapsing the sidebar to an icon rail on desktop. Default true. */
|
|
95
|
+
isSidebarCollapsible?: boolean;
|
|
96
|
+
/** "inline": language and theme switchers in the header. "menu": one settings button that opens them. Default "inline". */
|
|
97
|
+
headerSettings?: "inline" | "menu";
|
|
98
|
+
/** Where toasts appear. Default "top-end". */
|
|
99
|
+
toastPosition?: ToastPosition;
|
|
100
|
+
/** Show a "scroll to top" button on long pages. Default true. */
|
|
101
|
+
showScrollToTop?: boolean;
|
|
102
|
+
/** Query parameter that holds the current page (menu href without the leading slash): ?page=profiles. Default "page". */
|
|
103
|
+
pageParam?: string;
|
|
104
|
+
/**
|
|
105
|
+
* Where the current page lives in the address:
|
|
106
|
+
* "query" (default) http://host/?page=profiles
|
|
107
|
+
* "path" http://host/profiles (the server must answer every path with index.html)
|
|
108
|
+
*/
|
|
109
|
+
pageMode?: PageMode;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/** "query" = ?page=profiles, "path" = /profiles. */
|
|
113
|
+
export type PageMode = "query" | "path";
|
|
114
|
+
|
|
115
|
+
/** Toast corner / edge. "end" is right in LTR and left in RTL. */
|
|
116
|
+
export type ToastPosition = "top-start" | "top-center" | "top-end" | "bottom-start" | "bottom-center" | "bottom-end";
|
|
117
|
+
|
|
118
|
+
/** Backend settings used by AppHttp and the session. */
|
|
119
|
+
export interface HttpConfig {
|
|
120
|
+
/** API base URL, for example "https://api.example.com/api" or "/api". window.env API_BASE_URL wins when set. */
|
|
121
|
+
baseUrl?: string;
|
|
122
|
+
/** Where the browser goes after endSession() (log out), for example "/login" or "https://sso.example.com/logout". */
|
|
123
|
+
logoutUrl?: string;
|
|
124
|
+
/** AppStorage key of the access token. Default "TOKEN". */
|
|
125
|
+
tokenKey?: string;
|
|
126
|
+
/** Extra headers sent with every request. */
|
|
127
|
+
headers?: Record<string, string>;
|
|
128
|
+
/** URL of the options loader used by AppHttp.Load(id) — the id is added: `${loadUrl}/${id}`. Default: base URL + "/load". */
|
|
129
|
+
loadUrl?: string;
|
|
130
|
+
/** Show the top progress bar during requests. Default true. */
|
|
131
|
+
showProgress?: boolean;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/** The whole configuration of an app. */
|
|
135
|
+
export interface UiConfig {
|
|
136
|
+
/**
|
|
137
|
+
* Key (base name) of the app — the apps' ENV_BASE_NAME / APP_ID, for example "ORG".
|
|
138
|
+
* - AppStorage keys: ORG-TOKEN, ORG-LANG, ORG-THEME ...
|
|
139
|
+
* - window.env names: REACT_APP_ORG_API_BASE_URL (AppStorage.envData("API_BASE_URL"))
|
|
140
|
+
*/
|
|
141
|
+
appNameKey: string;
|
|
142
|
+
/** Label shown in the header, sidebar and login: t(appName), so plain text or a translation key. Default: appNameKey. */
|
|
143
|
+
appName?: string;
|
|
144
|
+
/** Optional logo image URL (light themes). */
|
|
145
|
+
logoUrl?: string;
|
|
146
|
+
/** Optional logo image URL used on dark themes. Default: logoUrl. */
|
|
147
|
+
logoDarkUrl?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Static language list. Not needed when the languages come from the backend:
|
|
150
|
+
* pass them with <SharedWebUiProvider lang={langResponse}> or setLanguages(langResponse).
|
|
151
|
+
*/
|
|
152
|
+
languages?: LanguageOption[];
|
|
153
|
+
/** Loads locales/{code}.json for any code ("en-US" -> en-US.json). Needed for backend languages. */
|
|
154
|
+
loadLocale?: LocaleCodeLoader;
|
|
155
|
+
/** Language code used on the first visit and before the backend list arrives. Optional, default "en-US". */
|
|
156
|
+
defaultLanguage?: string;
|
|
157
|
+
/** Language used when a key is missing in the current language. Default: defaultLanguage ("en-US"). */
|
|
158
|
+
fallbackLanguage?: string;
|
|
159
|
+
/** DaisyUI themes offered in the theme switcher. They must also be enabled in your CSS @plugin "daisyui". */
|
|
160
|
+
themes: Theme[];
|
|
161
|
+
/** Theme used on the first visit. */
|
|
162
|
+
defaultTheme: Theme;
|
|
163
|
+
/** Which of the themes are dark (used for dark logos and the markdown editor). Default: DaisyUI dark themes. */
|
|
164
|
+
darkThemes?: Theme[];
|
|
165
|
+
/**
|
|
166
|
+
* Static navigation items. Optional when the menu comes from the backend:
|
|
167
|
+
* pass it with <SharedWebUiProvider nav={menuResponse}> or setMenu(menuResponse).
|
|
168
|
+
*/
|
|
169
|
+
navigation?: NavItem[];
|
|
170
|
+
/** How backend menus are converted (root group flattening). */
|
|
171
|
+
navOptions?: MenuOptions;
|
|
172
|
+
/** Layout settings. */
|
|
173
|
+
layout?: LayoutConfig;
|
|
174
|
+
/** Home page: shown when ?page is missing, used by the logo. Default "/". */
|
|
175
|
+
homePath?: string;
|
|
176
|
+
/** Backend settings for AppHttp and the session. */
|
|
177
|
+
http?: HttpConfig;
|
|
178
|
+
/**
|
|
179
|
+
* Extra AppStorage keys of the project that belong in localStorage (preferences kept on log out).
|
|
180
|
+
* The library keys LANG, THEME, LAYOUT_CHOICE, MENU_MODE, SIDEBAR_COLLAPSED and REMEMBER_ME always are;
|
|
181
|
+
* everything else is saved in sessionStorage.
|
|
182
|
+
*/
|
|
183
|
+
localStorageKeys?: string[];
|
|
184
|
+
/**
|
|
185
|
+
* Title of the branch switcher (header dropdown and settings dialog): a translation key or a text, shown with t().
|
|
186
|
+
* Default "ui.branch" ("Branch").
|
|
187
|
+
*/
|
|
188
|
+
branchLabel?: string;
|
|
189
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
// ui-context.ts
|
|
2
|
+
// Shape of the value returned by useUi().
|
|
3
|
+
|
|
4
|
+
import type { Direction, LanguageOption, Theme, UiConfig } from "./ui-config.ts";
|
|
5
|
+
|
|
6
|
+
/** Values that can be put into a translated text: t("hello", { name: "Asha" }) with "Hello {{name}}". */
|
|
7
|
+
export type TranslateParams = Record<string, string | number>;
|
|
8
|
+
|
|
9
|
+
/** The translate function. Returns the key itself when no text is found. */
|
|
10
|
+
export type TranslateFunction = (key: string, params?: TranslateParams) => string;
|
|
11
|
+
|
|
12
|
+
/** Everything useUi() gives you. */
|
|
13
|
+
export interface UiContextValue {
|
|
14
|
+
/** The config passed to <SharedWebUiProvider>. */
|
|
15
|
+
config: UiConfig;
|
|
16
|
+
/** Current language code, for example "en". */
|
|
17
|
+
locale: string;
|
|
18
|
+
/** Current DaisyUI theme. */
|
|
19
|
+
theme: Theme;
|
|
20
|
+
/** Current text direction. */
|
|
21
|
+
direction: Direction;
|
|
22
|
+
/** true when the current locale file has been loaded. */
|
|
23
|
+
isReady: boolean;
|
|
24
|
+
/** Languages from the config. */
|
|
25
|
+
languages: LanguageOption[];
|
|
26
|
+
/** Themes from the config. */
|
|
27
|
+
themes: Theme[];
|
|
28
|
+
/** themes without the dark ones (config order). */
|
|
29
|
+
lightThemes: Theme[];
|
|
30
|
+
/** the dark themes of `themes` (config.darkThemes). */
|
|
31
|
+
darkThemes: Theme[];
|
|
32
|
+
/** Translate a key. */
|
|
33
|
+
t: TranslateFunction;
|
|
34
|
+
/** Switch language (loads the locale file, sets lang/dir, saves to localStorage). */
|
|
35
|
+
changeLanguage: (languageCode: string) => Promise<void>;
|
|
36
|
+
/** Switch theme (sets data-theme, saves to localStorage). */
|
|
37
|
+
changeTheme: (theme: Theme) => void;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** What is stored in the React context: only the config. Live values come from signals. */
|
|
41
|
+
export interface UiContextState {
|
|
42
|
+
config: UiConfig;
|
|
43
|
+
}
|
package/src/layout.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
// shared-lib-web/layout
|
|
2
|
+
// OPTIONAL app shell. The main entry ("shared-lib-web") has every component, control and service;
|
|
3
|
+
// this entry only adds ready-made layouts. A project picks one way:
|
|
4
|
+
//
|
|
5
|
+
// 1. Single layout: <AppLayout headerEnd={<UserMenu />}>{page}</AppLayout> (+ AuthLayout for login)
|
|
6
|
+
// or <AsideLayout sidebarUser={<UserMenu isInSidebar />}>{page}</AsideLayout> (no header, no mega menu)
|
|
7
|
+
// 2. Individual parts: <Header />, <Sidebar />, <SidebarNav />, <SidebarCollapseButton />, <MegaMenuBar />, <MegaMenuPanel />, <RailFlyout />, <RailTooltip />
|
|
8
|
+
// inside the project's own layout
|
|
9
|
+
// 3. None: the project builds its whole layout itself with the main entry
|
|
10
|
+
// (AppBrand, UserMenu, LanguageSwitcher, ThemeSwitcher, PageLink ...)
|
|
11
|
+
//
|
|
12
|
+
// import { AppLayout, AuthLayout } from "shared-lib-web/layout";
|
|
13
|
+
|
|
14
|
+
export { AppLayout, type AppLayoutProps } from "./layouts/app-layout.tsx";
|
|
15
|
+
export { AsideLayout, type AsideLayoutProps } from "./layouts/aside-layout.tsx";
|
|
16
|
+
export { AuthLayout, type AuthLayoutProps } from "./layouts/auth-layout.tsx";
|
|
17
|
+
export { Header, type HeaderProps } from "./layouts/header.tsx";
|
|
18
|
+
export {
|
|
19
|
+
Sidebar,
|
|
20
|
+
SidebarCollapseButton,
|
|
21
|
+
SidebarNav,
|
|
22
|
+
type SidebarCollapseButtonProps,
|
|
23
|
+
type SidebarNavProps,
|
|
24
|
+
type SidebarProps,
|
|
25
|
+
} from "./layouts/sidebar.tsx";
|
|
26
|
+
export { MegaMenuBar, MegaMenuPanel } from "./layouts/mega-menu.tsx";
|
|
27
|
+
export { RailFlyout } from "./layouts/rail-flyout.tsx";
|
|
28
|
+
export { RailTooltip } from "./layouts/rail-tooltip.tsx";
|
|
29
|
+
export { DRAWER_ID } from "./layouts/layout-constants.ts";
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
// app-layout.tsx
|
|
2
|
+
// The single, ready-made layout (optional — a project may build its own from Header, Sidebar, SidebarNav,
|
|
3
|
+
// MegaMenuBar ... or use none of them). Built with the DaisyUI drawer:
|
|
4
|
+
// menuMode "sidebar": sidebar always visible on desktop (collapsible to an icon rail)
|
|
5
|
+
// menuMode "megamenu": header mega menu on desktop
|
|
6
|
+
// Small screens (both modes): the sidebar slides in from the menu button.
|
|
7
|
+
//
|
|
8
|
+
// <AppLayout headerEnd={<UserMenu ... />}>{pageElement}</AppLayout>
|
|
9
|
+
// <AppLayout sidebarUser={<UserMenu isInSidebar ... />}>{pageElement}</AppLayout> user at the bottom of the side menu
|
|
10
|
+
//
|
|
11
|
+
// Parts can be turned off or replaced:
|
|
12
|
+
// <AppLayout showSidebar={false}> header + page only
|
|
13
|
+
// <AppLayout header={<MyHeader />}> own header, library sidebar
|
|
14
|
+
// <AppLayout sidebar={<MySidebar />} footer={<MyFooter />}>
|
|
15
|
+
|
|
16
|
+
import { useSignals } from "@preact/signals-react/runtime";
|
|
17
|
+
import { Suspense, type ReactNode } from "react";
|
|
18
|
+
import { translate } from "../i18n/translator.ts";
|
|
19
|
+
import { ScrollToTop } from "../components/scroll-to-top.tsx";
|
|
20
|
+
import { SkeletonPage } from "../skeleton/skeleton-page.tsx";
|
|
21
|
+
import { handleDrawerToggleChange } from "../state/sidebar-service.ts";
|
|
22
|
+
import { isMenuVisibleSignal, isSidebarCollapsedSignal, isSidebarOpenSignal, navigationModeSignal, uiConfigSignal } from "../state/signals.ts";
|
|
23
|
+
import { joinClassNames } from "../types/class-names.ts";
|
|
24
|
+
import { Header } from "./header.tsx";
|
|
25
|
+
import { DRAWER_ID } from "./layout-constants.ts";
|
|
26
|
+
import { RailFlyout } from "./rail-flyout.tsx";
|
|
27
|
+
import { RailTooltip } from "./rail-tooltip.tsx";
|
|
28
|
+
import { Sidebar } from "./sidebar.tsx";
|
|
29
|
+
|
|
30
|
+
export interface AppLayoutProps {
|
|
31
|
+
/** The page content (the app picks it from the ?page query parameter). */
|
|
32
|
+
children?: ReactNode;
|
|
33
|
+
/** Extra content in the header, for example <UserMenu />. */
|
|
34
|
+
headerEnd?: ReactNode;
|
|
35
|
+
/** Content at the bottom of the sidebar. */
|
|
36
|
+
sidebarFooter?: ReactNode;
|
|
37
|
+
/** User block at the bottom of the sidebar (above the collapse button), for example <UserMenu isInSidebar ... />. */
|
|
38
|
+
sidebarUser?: ReactNode;
|
|
39
|
+
/** Show the header. Default true. */
|
|
40
|
+
showHeader?: boolean;
|
|
41
|
+
/** Show the menu (sidebar / drawer / mega menu bar). Default: isMenuVisibleSignal (config.layout.showMenu, setMenuVisible()). */
|
|
42
|
+
showSidebar?: boolean;
|
|
43
|
+
/** Own header instead of the library Header. */
|
|
44
|
+
header?: ReactNode;
|
|
45
|
+
/** Own sidebar content instead of the library Sidebar (it still slides in on small screens). */
|
|
46
|
+
sidebar?: ReactNode;
|
|
47
|
+
/** Content below the page, for example a footer bar. */
|
|
48
|
+
footer?: ReactNode;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function AppLayout(props: AppLayoutProps) {
|
|
52
|
+
useSignals();
|
|
53
|
+
const { children, headerEnd, sidebarFooter, sidebarUser, showHeader = true, header, sidebar, footer } = props;
|
|
54
|
+
const isMenuVisible = isMenuVisibleSignal.value;
|
|
55
|
+
const showSidebar = props.showSidebar ?? isMenuVisible;
|
|
56
|
+
|
|
57
|
+
const config = uiConfigSignal.value;
|
|
58
|
+
const isSidebarOpen = isSidebarOpenSignal.value;
|
|
59
|
+
const isMegaMenu = navigationModeSignal.value === "megamenu";
|
|
60
|
+
const showScrollToTop = config?.layout?.showScrollToTop ?? true;
|
|
61
|
+
const closeText = translate("ui.close");
|
|
62
|
+
const pageFallback = <SkeletonPage />;
|
|
63
|
+
const isDesktopSidebar = showSidebar && !isMegaMenu; // same rule as isDesktopSidebarSignal, plus the showSidebar prop
|
|
64
|
+
const drawerClassList = ["drawer", isDesktopSidebar ? "lg:drawer-open" : ""];
|
|
65
|
+
const libraryHeader = <Header endContent={headerEnd} showMenuButtons={showSidebar} />;
|
|
66
|
+
const headerElement = header ?? libraryHeader;
|
|
67
|
+
const librarySidebar = <Sidebar footer={sidebarFooter} user={sidebarUser} />;
|
|
68
|
+
const sidebarElement = sidebar ?? librarySidebar;
|
|
69
|
+
const drawerClassName = joinClassNames(drawerClassList);
|
|
70
|
+
// Scroll-to-top sits on the start side: on desktop it moves past the sidebar (rail 5rem, open 18rem).
|
|
71
|
+
const desktopScrollClass = isSidebarCollapsedSignal.value ? "start-6 lg:start-26" : "start-6 lg:start-78";
|
|
72
|
+
const scrollPositionClassName = isDesktopSidebar ? desktopScrollClass : "start-6";
|
|
73
|
+
|
|
74
|
+
return (
|
|
75
|
+
<div className={drawerClassName}>
|
|
76
|
+
<input
|
|
77
|
+
id={DRAWER_ID}
|
|
78
|
+
type="checkbox"
|
|
79
|
+
className="drawer-toggle"
|
|
80
|
+
checked={isSidebarOpen}
|
|
81
|
+
onChange={handleDrawerToggleChange}
|
|
82
|
+
/>
|
|
83
|
+
<div className="drawer-content flex min-h-screen min-w-0 flex-col bg-base-200">
|
|
84
|
+
{showHeader ? headerElement : null}
|
|
85
|
+
<main className="flex-1 space-y-4 p-4 lg:p-6">
|
|
86
|
+
<Suspense fallback={pageFallback}>
|
|
87
|
+
{children}
|
|
88
|
+
</Suspense>
|
|
89
|
+
</main>
|
|
90
|
+
{footer}
|
|
91
|
+
</div>
|
|
92
|
+
{showSidebar ? (
|
|
93
|
+
<div className="drawer-side z-40">
|
|
94
|
+
<label htmlFor={DRAWER_ID} aria-label={closeText} className="drawer-overlay" />
|
|
95
|
+
{sidebarElement}
|
|
96
|
+
</div>
|
|
97
|
+
) : null}
|
|
98
|
+
{isDesktopSidebar ? <RailFlyout /> : null}
|
|
99
|
+
{isDesktopSidebar ? <RailTooltip /> : null}
|
|
100
|
+
{showScrollToTop ? <ScrollToTop positionClassName={scrollPositionClassName} /> : null}
|
|
101
|
+
</div>
|
|
102
|
+
);
|
|
103
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// article-layout.tsx
|
|
2
|
+
// Page header area: title, filters and actions at the top of a page.
|
|
3
|
+
|
|
4
|
+
import type { ReactNode } from "react";
|
|
5
|
+
import { joinClassNames } from "../types/class-names.ts";
|
|
6
|
+
|
|
7
|
+
export interface SectionLayoutProps {
|
|
8
|
+
children?: ReactNode;
|
|
9
|
+
className?: string;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export function ArticleLayout(props: SectionLayoutProps) {
|
|
13
|
+
const classList = ["rounded-box bg-base-100 p-4 shadow-sm", props.className];
|
|
14
|
+
const className = joinClassNames(classList);
|
|
15
|
+
return <article className={className}>{props.children}</article>;
|
|
16
|
+
}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
// aside-layout.tsx
|
|
2
|
+
// AsideLayout: a ready-made layout WITHOUT a top header — only the side menu and the page.
|
|
3
|
+
// - Desktop: the sidebar can be collapsed to an icon rail (button at the bottom), tooltips on the rail.
|
|
4
|
+
// - Small screens: the sidebar is always the collapsed icon rail (no drawer, no menu button).
|
|
5
|
+
// - No mega menu: the navigation mode setting is ignored and hidden in the settings dialog.
|
|
6
|
+
// - The user sits at the bottom of the sidebar (showSettings adds a settings button there, off by default).
|
|
7
|
+
//
|
|
8
|
+
// <AsideLayout sidebarUser={<UserMenu isInSidebar ... />}>{pageElement}</AsideLayout>
|
|
9
|
+
|
|
10
|
+
import { useSignals } from "@preact/signals-react/runtime";
|
|
11
|
+
import { Suspense, useLayoutEffect, type ReactNode } from "react";
|
|
12
|
+
import { ScrollToTop } from "../components/scroll-to-top.tsx";
|
|
13
|
+
import { SettingsMenu } from "../components/settings-menu.tsx";
|
|
14
|
+
import { RUN_ONCE } from "../providers/provider-effects.ts";
|
|
15
|
+
import { SkeletonPage } from "../skeleton/skeleton-page.tsx";
|
|
16
|
+
import {
|
|
17
|
+
isAsideLayoutSignal,
|
|
18
|
+
isMenuVisibleSignal,
|
|
19
|
+
isRailEverywhereSignal,
|
|
20
|
+
isSidebarCollapsedSignal,
|
|
21
|
+
isSmallScreenSignal,
|
|
22
|
+
uiConfigSignal,
|
|
23
|
+
} from "../state/signals.ts";
|
|
24
|
+
import { RailFlyout } from "./rail-flyout.tsx";
|
|
25
|
+
import { RailTooltip } from "./rail-tooltip.tsx";
|
|
26
|
+
import { Sidebar } from "./sidebar.tsx";
|
|
27
|
+
|
|
28
|
+
export interface AsideLayoutProps {
|
|
29
|
+
/** The page content (the app picks it from the ?page query parameter). */
|
|
30
|
+
children?: ReactNode;
|
|
31
|
+
/** User block at the bottom of the sidebar, for example <UserMenu isInSidebar ... />. */
|
|
32
|
+
sidebarUser?: ReactNode;
|
|
33
|
+
/** Content at the bottom of the sidebar (hidden on the rail). */
|
|
34
|
+
sidebarFooter?: ReactNode;
|
|
35
|
+
/** Settings button (language, theme) at the bottom of the sidebar. Default false. */
|
|
36
|
+
showSettings?: boolean;
|
|
37
|
+
/** Show the side menu. Default: isMenuVisibleSignal (config.layout.showMenu, setMenuVisible()). */
|
|
38
|
+
showSidebar?: boolean;
|
|
39
|
+
/** Own sidebar content instead of the library Sidebar. */
|
|
40
|
+
sidebar?: ReactNode;
|
|
41
|
+
/** Content below the page, for example a footer bar. */
|
|
42
|
+
footer?: ReactNode;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/** Media query for screens below the lg breakpoint (1024px). */
|
|
46
|
+
const SMALL_SCREEN_QUERY = "(max-width: 1023.98px)";
|
|
47
|
+
|
|
48
|
+
let smallScreenQuery: MediaQueryList | null = null;
|
|
49
|
+
|
|
50
|
+
function updateSmallScreen(): void {
|
|
51
|
+
isSmallScreenSignal.value = smallScreenQuery?.matches ?? false;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/** Starts following the screen size (isSmallScreenSignal). Safe to call more than once. */
|
|
55
|
+
export function watchSmallScreen(): void {
|
|
56
|
+
const hasMatchMedia = typeof window !== "undefined" && typeof window.matchMedia === "function";
|
|
57
|
+
if (!hasMatchMedia || smallScreenQuery) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
smallScreenQuery = window.matchMedia(SMALL_SCREEN_QUERY);
|
|
61
|
+
smallScreenQuery.addEventListener("change", updateSmallScreen);
|
|
62
|
+
updateSmallScreen();
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/** Stops following the screen size. */
|
|
66
|
+
export function unwatchSmallScreen(): void {
|
|
67
|
+
smallScreenQuery?.removeEventListener("change", updateSmallScreen);
|
|
68
|
+
smallScreenQuery = null;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/** Leaves the aside mode when the AsideLayout goes away (for example when the app switches layouts). */
|
|
72
|
+
export function endAsideLayout(): void {
|
|
73
|
+
isAsideLayoutSignal.value = false;
|
|
74
|
+
unwatchSmallScreen();
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
/** Turns the aside mode on while the AsideLayout is on screen. Returns the clean-up. */
|
|
78
|
+
export function startAsideLayout(): () => void {
|
|
79
|
+
watchSmallScreen();
|
|
80
|
+
isAsideLayoutSignal.value = true;
|
|
81
|
+
return endAsideLayout;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function AsideLayout(props: AsideLayoutProps) {
|
|
85
|
+
useSignals();
|
|
86
|
+
useLayoutEffect(startAsideLayout, RUN_ONCE);
|
|
87
|
+
const { children, sidebarUser, sidebarFooter, showSettings = false, sidebar, footer } = props;
|
|
88
|
+
const isMenuVisible = isMenuVisibleSignal.value;
|
|
89
|
+
const showSidebar = props.showSidebar ?? isMenuVisible;
|
|
90
|
+
const config = uiConfigSignal.value;
|
|
91
|
+
const showScrollToTop = config?.layout?.showScrollToTop ?? true;
|
|
92
|
+
const pageFallback = <SkeletonPage />;
|
|
93
|
+
// Scroll-to-top sits on the start side, so it moves past the sidebar (rail 5rem, open 18rem).
|
|
94
|
+
const isNarrowSidebar = isRailEverywhereSignal.value || isSidebarCollapsedSignal.value;
|
|
95
|
+
const sidebarScrollClass = isNarrowSidebar ? "start-26" : "start-78";
|
|
96
|
+
const scrollPositionClassName = showSidebar ? sidebarScrollClass : "start-6";
|
|
97
|
+
const settingsElement = showSettings ? <SettingsMenu isInSidebar /> : undefined;
|
|
98
|
+
const librarySidebar = <Sidebar footer={sidebarFooter} user={sidebarUser} tools={settingsElement} />;
|
|
99
|
+
const sidebarElement = sidebar ?? librarySidebar;
|
|
100
|
+
|
|
101
|
+
return (
|
|
102
|
+
<div className="flex min-h-screen bg-base-200">
|
|
103
|
+
{/* sticky makes its own stacking layer: z-40 keeps the sidebar (and the user menu opening from it) above the page. */}
|
|
104
|
+
{showSidebar ? <div className="sticky top-0 z-40 h-screen shrink-0">{sidebarElement}</div> : null}
|
|
105
|
+
<div className="flex min-h-screen min-w-0 flex-1 flex-col">
|
|
106
|
+
<main className="flex-1 space-y-4 p-4 lg:p-6">
|
|
107
|
+
<Suspense fallback={pageFallback}>
|
|
108
|
+
{children}
|
|
109
|
+
</Suspense>
|
|
110
|
+
</main>
|
|
111
|
+
{footer}
|
|
112
|
+
</div>
|
|
113
|
+
{showSidebar ? <RailFlyout /> : null}
|
|
114
|
+
{showSidebar ? <RailTooltip /> : null}
|
|
115
|
+
{showScrollToTop ? <ScrollToTop positionClassName={scrollPositionClassName} /> : null}
|
|
116
|
+
</div>
|
|
117
|
+
);
|
|
118
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// auth-layout.tsx
|
|
2
|
+
// Centered card layout for login, register and forgot-password pages.
|
|
3
|
+
//
|
|
4
|
+
// <AuthLayout>
|
|
5
|
+
// <LoginPage />
|
|
6
|
+
// </AuthLayout>
|
|
7
|
+
|
|
8
|
+
import { Suspense, type ReactNode } from "react";
|
|
9
|
+
import { AppBrand } from "../components/app-brand.tsx";
|
|
10
|
+
import { LanguageSwitcher } from "../components/language-switcher.tsx";
|
|
11
|
+
import { ThemeSwitcher } from "../components/theme-switcher.tsx";
|
|
12
|
+
import { useUi } from "../context/use-ui.ts";
|
|
13
|
+
import { SkeletonAuthForm } from "../skeleton/skeleton-auth-form.tsx";
|
|
14
|
+
|
|
15
|
+
export interface AuthLayoutProps {
|
|
16
|
+
/** The auth page, for example <LoginPage />. */
|
|
17
|
+
children?: ReactNode;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export function AuthLayout(props: AuthLayoutProps) {
|
|
21
|
+
const { children } = props;
|
|
22
|
+
useUi();
|
|
23
|
+
const pageFallback = <SkeletonAuthForm />;
|
|
24
|
+
|
|
25
|
+
return (
|
|
26
|
+
<div className="flex min-h-screen flex-col bg-base-200">
|
|
27
|
+
<header className="flex justify-end gap-1 p-3">
|
|
28
|
+
<LanguageSwitcher />
|
|
29
|
+
<ThemeSwitcher />
|
|
30
|
+
</header>
|
|
31
|
+
<main className="flex flex-1 items-center justify-center p-4">
|
|
32
|
+
<div className="card w-full max-w-md bg-base-100 shadow-xl">
|
|
33
|
+
<div className="card-body gap-4">
|
|
34
|
+
<AppBrand className="justify-center" />
|
|
35
|
+
<Suspense fallback={pageFallback}>{children}</Suspense>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
</main>
|
|
39
|
+
</div>
|
|
40
|
+
);
|
|
41
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// content-layout.tsx
|
|
2
|
+
// Main content card of a page, for example a form or a details view.
|
|
3
|
+
|
|
4
|
+
import { joinClassNames } from "../types/class-names.ts";
|
|
5
|
+
import type { SectionLayoutProps } from "./article-layout.tsx";
|
|
6
|
+
|
|
7
|
+
export function ContentLayout(props: SectionLayoutProps) {
|
|
8
|
+
const classList = ["rounded-box bg-base-100 p-4 shadow-sm", props.className];
|
|
9
|
+
const className = joinClassNames(classList);
|
|
10
|
+
return <section className={className}>{props.children}</section>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// float-layout.tsx
|
|
2
|
+
// Floating action buttons fixed to the bottom corner (bottom-left in RTL).
|
|
3
|
+
|
|
4
|
+
import { joinClassNames } from "../types/class-names.ts";
|
|
5
|
+
import type { SectionLayoutProps } from "./article-layout.tsx";
|
|
6
|
+
|
|
7
|
+
export function FloatLayout(props: SectionLayoutProps) {
|
|
8
|
+
const classList = ["fixed bottom-6 end-6 z-20 flex gap-2", props.className];
|
|
9
|
+
const className = joinClassNames(classList);
|
|
10
|
+
return <div className={className}>{props.children}</div>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// grid-layout.tsx
|
|
2
|
+
// Container for a table or grid. Scrolls sideways on small screens.
|
|
3
|
+
|
|
4
|
+
import { joinClassNames } from "../types/class-names.ts";
|
|
5
|
+
import type { SectionLayoutProps } from "./article-layout.tsx";
|
|
6
|
+
|
|
7
|
+
export function GridLayout(props: SectionLayoutProps) {
|
|
8
|
+
const classList = ["overflow-x-auto rounded-box bg-base-100 shadow-sm", props.className];
|
|
9
|
+
const className = joinClassNames(classList);
|
|
10
|
+
return <section className={className}>{props.children}</section>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
// head-layout.tsx
|
|
2
|
+
// Sticky page header: one-line title on the start side, action buttons (Submit, Cancel, ...) on the end side.
|
|
3
|
+
// It stays fixed at the top of the page while the page scrolls, just under the app header.
|
|
4
|
+
// Its bar is h-16 (4rem), the same height as the logo box of the Sidebar and the app Header, so the borders line up.
|
|
5
|
+
//
|
|
6
|
+
// <HeadLayout
|
|
7
|
+
// title={t("user.editTitle")}
|
|
8
|
+
// actions={<>
|
|
9
|
+
// <TypeButton action="ghost" icon="X" label={t("user.cancel")} onPress={handleUserCancel} />
|
|
10
|
+
// <TypeButton type="submit" form="user-form" icon="Save" label={t("user.save")} />
|
|
11
|
+
// </>}
|
|
12
|
+
// />
|
|
13
|
+
// <form id="user-form" onSubmit={onSubmit}>...</form>
|
|
14
|
+
//
|
|
15
|
+
// A submit button in the header sits outside the <form>, so give the form an id and pass it as `form` to TypeButton.
|
|
16
|
+
|
|
17
|
+
import { useSignals } from "@preact/signals-react/runtime";
|
|
18
|
+
import type { ReactNode } from "react";
|
|
19
|
+
import { isAsideLayoutSignal } from "../state/signals.ts";
|
|
20
|
+
import { joinClassNames } from "../types/class-names.ts";
|
|
21
|
+
|
|
22
|
+
export interface HeadLayoutProps {
|
|
23
|
+
/** Page title (already translated), shown on the start side. */
|
|
24
|
+
title: ReactNode;
|
|
25
|
+
/** Buttons on the end side, for example Cancel and Submit. */
|
|
26
|
+
actions?: ReactNode;
|
|
27
|
+
/** Optional extra row under the title and actions (filters, tabs, ...). */
|
|
28
|
+
children?: ReactNode;
|
|
29
|
+
/** Sticks just under the 4rem app header (top-16). Set false when the page has no app header (top-0). Default true (false in an AsideLayout). */
|
|
30
|
+
isBelowHeader?: boolean;
|
|
31
|
+
/** Stretches over the page padding of <main> (p-4 lg:p-6) so the bar touches both edges. Default true. */
|
|
32
|
+
isFullWidth?: boolean;
|
|
33
|
+
className?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
const FULL_WIDTH_CLASS = "-mx-4 -mt-4 border-b border-base-300 px-4 lg:-mx-6 lg:-mt-6 lg:px-6";
|
|
37
|
+
const CARD_CLASS = "rounded-box px-4 shadow-sm";
|
|
38
|
+
|
|
39
|
+
export function HeadLayout(props: HeadLayoutProps) {
|
|
40
|
+
useSignals();
|
|
41
|
+
const { title, actions, children, isFullWidth = true, className } = props;
|
|
42
|
+
const isAsideLayout = isAsideLayoutSignal.value;
|
|
43
|
+
const isBelowHeader = props.isBelowHeader ?? !isAsideLayout;
|
|
44
|
+
const topClass = isBelowHeader ? "top-16" : "top-0";
|
|
45
|
+
const shapeClass = isFullWidth ? FULL_WIDTH_CLASS : CARD_CLASS;
|
|
46
|
+
// min-h-16 on the box (border included) = the 4rem logo box, so both bottom borders sit on one line.
|
|
47
|
+
const classList = ["sticky z-20 flex min-h-16 flex-col justify-center bg-base-100/95 backdrop-blur", topClass, shapeClass, className];
|
|
48
|
+
const headerClassName = joinClassNames(classList);
|
|
49
|
+
const actionsElement = actions ? <div className="flex shrink-0 flex-wrap items-center gap-2">{actions}</div> : null;
|
|
50
|
+
const extraElement = children ? <div className="pb-3">{children}</div> : null;
|
|
51
|
+
|
|
52
|
+
return (
|
|
53
|
+
<header className={headerClassName} data-head-layout>
|
|
54
|
+
<div className="flex flex-wrap items-center justify-between gap-2 py-2">
|
|
55
|
+
<h1 className="min-w-0 flex-1 truncate text-xl font-bold text-primary">{title}</h1>
|
|
56
|
+
{actionsElement}
|
|
57
|
+
</div>
|
|
58
|
+
{extraElement}
|
|
59
|
+
</header>
|
|
60
|
+
);
|
|
61
|
+
}
|