@olenbetong/appframe-ds 1.3.6 → 1.3.8

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.
Files changed (179) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +6 -6
  3. package/scripts/copyAssets.mjs +27 -27
  4. package/src/AfLookup/Lookup.css +130 -129
  5. package/src/AfLookup/Lookup.tsx +186 -186
  6. package/src/AfLookup/LookupCombobox.css +72 -78
  7. package/src/AfLookup/LookupCombobox.tsx +237 -237
  8. package/src/AfLookup/LookupEdit.tsx +130 -130
  9. package/src/AfLookup/LookupGrid.css +7 -12
  10. package/src/AfLookup/LookupGrid.tsx +124 -124
  11. package/src/AfLookup/index.ts +5 -5
  12. package/src/autocomplete/Autocomplete.css +256 -256
  13. package/src/autocomplete/Autocomplete.tsx +320 -320
  14. package/src/autocomplete/AutocompleteFrame.tsx +168 -168
  15. package/src/autocomplete/Combobox.tsx +286 -286
  16. package/src/autocomplete/index.ts +4 -4
  17. package/src/autocomplete/types.ts +204 -204
  18. package/src/autocomplete/utils.ts +183 -183
  19. package/src/binding/BoundNumericTextField.tsx +102 -102
  20. package/src/binding/BoundTextField.tsx +49 -49
  21. package/src/binding/CancelButton.tsx +30 -30
  22. package/src/binding/CancelIconButton.tsx +30 -30
  23. package/src/binding/DataEditToolbar.css +23 -23
  24. package/src/binding/DataEditToolbar.tsx +84 -84
  25. package/src/binding/DeleteButton.tsx +35 -35
  26. package/src/binding/DeleteIconButton.tsx +35 -35
  27. package/src/binding/RefreshButton.tsx +31 -31
  28. package/src/binding/RefreshIconButton.tsx +33 -33
  29. package/src/binding/RefreshRowIconButton.tsx +33 -33
  30. package/src/binding/SaveButton.tsx +37 -37
  31. package/src/binding/SaveIconButton.tsx +38 -38
  32. package/src/container/Container.tsx +50 -49
  33. package/src/container/index.ts +1 -1
  34. package/src/cutoff/CutOffPicker.css +12 -12
  35. package/src/cutoff/CutOffPicker.tsx +165 -165
  36. package/src/cutoff/context.tsx +194 -194
  37. package/src/cutoff/dsCutOffDates.ts +21 -21
  38. package/src/cutoff/index.ts +4 -4
  39. package/src/cutoff/utils.test.ts +59 -59
  40. package/src/cutoff/utils.ts +276 -276
  41. package/src/filter/ChipListInput.tsx +79 -79
  42. package/src/filter/FieldFilterPanel.css +150 -150
  43. package/src/filter/FieldFilterPanel.tsx +309 -309
  44. package/src/filter/FilterBuilder.css +152 -152
  45. package/src/filter/FilterBuilder.test.tsx +153 -153
  46. package/src/filter/FilterBuilder.tsx +435 -435
  47. package/src/filter/FilterEditor.css +231 -231
  48. package/src/filter/FilterEditor.test.tsx +285 -285
  49. package/src/filter/FilterEditor.tsx +75 -75
  50. package/src/filter/FilterGroupEditor.tsx +160 -160
  51. package/src/filter/FilterNameDialog.css +22 -22
  52. package/src/filter/FilterNameDialog.tsx +81 -81
  53. package/src/filter/FilterRow.tsx +117 -117
  54. package/src/filter/FilterShareDialog.css +28 -28
  55. package/src/filter/FilterShareDialog.tsx +201 -201
  56. package/src/filter/FilterStringField.tsx +78 -78
  57. package/src/filter/FilterValueEditor.tsx +239 -239
  58. package/src/filter/SavedFilterTree.css +107 -107
  59. package/src/filter/SavedFilterTree.test.tsx +94 -94
  60. package/src/filter/SavedFilterTree.tsx +218 -218
  61. package/src/filter/fieldFilter.test.ts +158 -158
  62. package/src/filter/fieldFilter.ts +139 -139
  63. package/src/filter/index.ts +27 -27
  64. package/src/filter/types.ts +38 -38
  65. package/src/filter/useDistinctValues.test.ts +102 -102
  66. package/src/filter/useDistinctValues.ts +230 -230
  67. package/src/global.d.ts +11 -11
  68. package/src/grid/AfGridColumnsPanel.tsx +118 -118
  69. package/src/grid/AfGridContext.tsx +51 -51
  70. package/src/grid/AfGridError.tsx +46 -46
  71. package/src/grid/AfHeaderFilterCell.tsx +147 -147
  72. package/src/grid/AfHeaderFilterPanel.tsx +111 -111
  73. package/src/grid/GridEditLookup.css +12 -12
  74. package/src/grid/GridEditLookup.tsx +121 -121
  75. package/src/grid/Toolbar.tsx +233 -233
  76. package/src/grid/editing.ts +100 -100
  77. package/src/grid/filter.ts +78 -78
  78. package/src/grid/formatters.ts +48 -48
  79. package/src/grid/index.css +245 -245
  80. package/src/grid/index.tsx +503 -503
  81. package/src/grid/license.ts +48 -48
  82. package/src/grid/localization.ts +369 -369
  83. package/src/grid/slots/index.tsx +334 -334
  84. package/src/grid/slots/slots.css +64 -64
  85. package/src/grid/slots/slots.test.tsx +39 -39
  86. package/src/grid/theme.tsx +138 -138
  87. package/src/grid/useAfColumns.tsx +371 -371
  88. package/src/grid/useAfCurrentIndex.ts +63 -63
  89. package/src/grid/useAfData.ts +20 -20
  90. package/src/grid/useAfFilter.ts +160 -160
  91. package/src/grid/useAfFilterFields.ts +55 -55
  92. package/src/grid/useAfGridApi.ts +71 -71
  93. package/src/grid/useAfKeyBindings.ts +36 -36
  94. package/src/grid/useAfNewItemRow.ts +258 -258
  95. package/src/grid/useAfPagination.ts +53 -53
  96. package/src/grid/useAfPersistedState.ts +230 -230
  97. package/src/grid/useAfRowEditModel.ts +145 -145
  98. package/src/grid/useAfRowGrouping.ts +47 -47
  99. package/src/grid/useAfServerAggregation.test.ts +68 -68
  100. package/src/grid/useAfServerAggregation.ts +158 -158
  101. package/src/grid/useAfSortModel.ts +84 -84
  102. package/src/i18n.ts +13 -13
  103. package/src/index.ts +14 -14
  104. package/src/input/InputAdornments.css +84 -84
  105. package/src/input/InputAdornments.tsx +102 -102
  106. package/src/input/index.ts +1 -1
  107. package/src/layout/AppMenu.tsx +74 -74
  108. package/src/layout/AppMenuDrawer.css +70 -70
  109. package/src/layout/AppMenuDrawer.tsx +122 -122
  110. package/src/layout/ErrorBoundary.tsx +162 -162
  111. package/src/layout/PageContainer.css +48 -48
  112. package/src/layout/PageContainer.tsx +41 -41
  113. package/src/layout/ResponsiveDialog.css +86 -86
  114. package/src/layout/ResponsiveDialog.tsx +55 -55
  115. package/src/layout/index.tsx +69 -69
  116. package/src/link/Link.tsx +23 -23
  117. package/src/link/index.ts +1 -1
  118. package/src/mdi/Mdi.css +138 -138
  119. package/src/mdi/Mdi.test.tsx +91 -91
  120. package/src/mdi/Mdi.tsx +141 -141
  121. package/src/mdi/MdiConfirmCloseDialog.tsx +47 -47
  122. package/src/mdi/MdiContext.tsx +59 -59
  123. package/src/mdi/MdiDocumentContext.tsx +60 -60
  124. package/src/mdi/MdiPanel.tsx +61 -61
  125. package/src/mdi/MdiRestore.test.tsx +86 -86
  126. package/src/mdi/MdiTab.tsx +30 -30
  127. package/src/mdi/controller.test.ts +382 -382
  128. package/src/mdi/controller.ts +656 -656
  129. package/src/mdi/dockviewHost.ts +132 -132
  130. package/src/mdi/fakeHost.ts +200 -200
  131. package/src/mdi/host.ts +44 -44
  132. package/src/mdi/ids.test.ts +20 -20
  133. package/src/mdi/ids.ts +18 -18
  134. package/src/mdi/index.ts +31 -31
  135. package/src/mdi/layoutRestore.test.ts +156 -156
  136. package/src/mdi/layoutRestore.ts +311 -311
  137. package/src/mdi/layoutSpec.test.ts +143 -143
  138. package/src/mdi/layoutSpec.ts +214 -214
  139. package/src/mdi/layoutStore.test.ts +93 -93
  140. package/src/mdi/layoutStore.ts +99 -99
  141. package/src/mdi/memorySettingsStore.ts +21 -21
  142. package/src/mdi/registry.ts +34 -34
  143. package/src/mdi/testTypes.ts +37 -37
  144. package/src/mdi/theme.ts +22 -22
  145. package/src/mdi/types.ts +214 -214
  146. package/src/page/Page.css +53 -53
  147. package/src/page/PageBlock.css +64 -64
  148. package/src/page/PageBlock.tsx +93 -92
  149. package/src/page/PageHeader.css +88 -88
  150. package/src/page/PageHeader.tsx +115 -115
  151. package/src/page/PageTitle.css +5 -5
  152. package/src/page/PageTitle.tsx +21 -21
  153. package/src/page/index.ts +4 -4
  154. package/src/paper/Paper.tsx +52 -52
  155. package/src/progress/LinearProgress.css +93 -93
  156. package/src/progress/LinearProgress.tsx +104 -104
  157. package/src/progress/index.ts +1 -1
  158. package/src/report-downloader/ReportDownloader.css +67 -67
  159. package/src/report-downloader/components/StatusItem.tsx +87 -87
  160. package/src/report-downloader/components/StatusList.tsx +28 -28
  161. package/src/report-downloader/index.ts +41 -41
  162. package/src/report-downloader/status.tsx +92 -92
  163. package/src/sortable/DropIndicator.css +51 -51
  164. package/src/sortable/DropIndicator.tsx +27 -27
  165. package/src/sortable/SortableItemList.css +21 -21
  166. package/src/sortable/SortableItemList.tsx +264 -264
  167. package/src/sortable/index.ts +8 -8
  168. package/src/sortable/reorderSortOrder.ts +126 -126
  169. package/src/sortable/sortOrder.ts +101 -101
  170. package/src/sortable/types.ts +9 -9
  171. package/src/sortable/useSortableContainer.ts +53 -53
  172. package/src/sortable/useSortableItem.ts +95 -95
  173. package/src/sortable/useSortableList.ts +117 -117
  174. package/src/test/happy-dom-document-class.ts +24 -24
  175. package/src/test/setup.ts +12 -12
  176. package/src/theme/useDsColorScheme.ts +53 -53
  177. package/tsconfig.build.json +9 -9
  178. package/tsconfig.json +8 -8
  179. package/vitest.config.ts +10 -10
@@ -1,92 +1,93 @@
1
- import "./PageBlock.css";
2
-
3
- import clsx from "clsx";
4
- import type React from "react";
5
-
6
- export const pageBlockWidths = ["text", "md", "lg", "xl", "2xl"] as const;
7
-
8
- export type PageBlockWidth = (typeof pageBlockWidths)[number];
9
-
10
- export type PageBlockProps = React.HTMLAttributes<HTMLElement> & {
11
- /**
12
- * Where a width-constrained block sits in the space available to it.
13
- *
14
- * `center` is the MUI `Container` behaviour. `start` keeps the content against the leading
15
- * edge, which is what the old `PageContainer` did (it forced `margin-left: 0`) and what an app
16
- * with a docked navigation drawer usually wants — centering leaves the content floating away
17
- * from the menu it belongs to.
18
- *
19
- * Has no effect without a `width`, since the block already fills its parent.
20
- * @default "center"
21
- */
22
- align?: "center" | "start";
23
- /**
24
- * Overrides the rendered element (e.g. `"main"`, `"header"`, `"footer"`)
25
- * @default "div"
26
- */
27
- as?: React.ElementType;
28
- children?: React.ReactNode;
29
- /**
30
- * Fills the remaining space of the parent `Page`. Combine with
31
- * `overflow="auto"` inside `<Page layout="app">` to make the block the
32
- * scroll container.
33
- * @default false
34
- */
35
- grow?: boolean;
36
- /**
37
- * Adds a standardised responsive inline padding
38
- * @default false
39
- */
40
- gutters?: boolean;
41
- /**
42
- * Overflow behaviour of the block. Only relevant inside
43
- * `<Page layout="app">`, where scrolling is delegated down the tree.
44
- */
45
- overflow?: "auto" | "hidden";
46
- /**
47
- * Predefined max-width. Content is horizontally centered.
48
- *
49
- * - `text`: 36rem (576px) — recommended line-length for running text
50
- * - `md`: 48rem (768px)
51
- * - `lg`: 64rem (1024px)
52
- * - `xl`: 80rem (1280px)
53
- * - `2xl`: 90rem (1440px)
54
- *
55
- * @default max-width: 100%
56
- */
57
- width?: PageBlockWidth;
58
- };
59
-
60
- /**
61
- * Layout block for defining max-width, gutters and horizontal centering.
62
- * Replaces the deprecated `PageContainer` (`maxWidth` mapping: `xs`/`sm` →
63
- * `text`, `md` → `md`, `lg` → `lg`, `xl` → `xl`, `false` → no `width`).
64
- */
65
- export function PageBlock({
66
- align,
67
- as: Component = "div",
68
- children,
69
- className,
70
- grow,
71
- gutters,
72
- overflow,
73
- width,
74
- ...props
75
- }: PageBlockProps) {
76
- return (
77
- <Component
78
- className={clsx(
79
- "ObPageBlock-root",
80
- width && `ObPageBlock-${width}`,
81
- align === "start" && "ObPageBlock-alignStart",
82
- gutters && "ObPageBlock-gutters",
83
- grow && "ObPageBlock-grow",
84
- overflow && `ObPageBlock-overflow${overflow === "auto" ? "Auto" : "Hidden"}`,
85
- className,
86
- )}
87
- {...props}
88
- >
89
- {children}
90
- </Component>
91
- );
92
- }
1
+ import "./PageBlock.css";
2
+
3
+ import clsx from "clsx";
4
+ import type React from "react";
5
+
6
+ export const pageBlockWidths = ["text", "md", "lg", "xl", "2xl"] as const;
7
+
8
+ export type PageBlockWidth = (typeof pageBlockWidths)[number];
9
+
10
+ export type PageBlockProps = React.HTMLAttributes<HTMLElement> & {
11
+ /**
12
+ * Where a width-constrained block sits in the space available to it.
13
+ *
14
+ * `center` is the MUI `Container` behaviour. `start` keeps the content against the leading
15
+ * edge, which is what the old `PageContainer` did (it forced `margin-left: 0`) and what an app
16
+ * with a docked navigation drawer usually wants — centering leaves the content floating away
17
+ * from the menu it belongs to.
18
+ *
19
+ * Has no effect without a `width`, since the block already fills its parent.
20
+ * @default "center"
21
+ */
22
+ align?: "center" | "start";
23
+ /**
24
+ * Overrides the rendered element (e.g. `"main"`, `"header"`, `"footer"`)
25
+ * @default "div"
26
+ */
27
+ as?: React.ElementType;
28
+ children?: React.ReactNode;
29
+ /**
30
+ * Fills the remaining space of the parent `Page`. Combine with
31
+ * `overflow="auto"` inside `<Page layout="app">` to make the block the
32
+ * scroll container.
33
+ * @default false
34
+ */
35
+ grow?: boolean;
36
+ /**
37
+ * Adds a standardised responsive inline padding
38
+ * @default false
39
+ */
40
+ gutters?: boolean;
41
+ /**
42
+ * Overflow behaviour of the block. Only relevant inside
43
+ * `<Page layout="app">`, where scrolling is delegated down the tree.
44
+ */
45
+ overflow?: "auto" | "hidden";
46
+ /**
47
+ * Predefined max-width. Content is horizontally centered. Pixel widths are at the 2026
48
+ * site's 14px root font size; the rem values follow the browser's font size setting.
49
+ *
50
+ * - `text`: 41rem (574px) — recommended line-length for running text
51
+ * - `md`: 55rem (770px)
52
+ * - `lg`: 73rem (1022px)
53
+ * - `xl`: 110rem (1540px)
54
+ * - `2xl`: deprecated, the same as `xl`
55
+ *
56
+ * @default max-width: 100%
57
+ */
58
+ width?: PageBlockWidth;
59
+ };
60
+
61
+ /**
62
+ * Layout block for defining max-width, gutters and horizontal centering.
63
+ * Replaces the deprecated `PageContainer` (`maxWidth` mapping: `xs`/`sm` →
64
+ * `text`, `md` → `md`, `lg` → `lg`, `xl` → `xl`, `false` → no `width`).
65
+ */
66
+ export function PageBlock({
67
+ align,
68
+ as: Component = "div",
69
+ children,
70
+ className,
71
+ grow,
72
+ gutters,
73
+ overflow,
74
+ width,
75
+ ...props
76
+ }: PageBlockProps) {
77
+ return (
78
+ <Component
79
+ className={clsx(
80
+ "ObPageBlock-root",
81
+ width && `ObPageBlock-${width}`,
82
+ align === "start" && "ObPageBlock-alignStart",
83
+ gutters && "ObPageBlock-gutters",
84
+ grow && "ObPageBlock-grow",
85
+ overflow && `ObPageBlock-overflow${overflow === "auto" ? "Auto" : "Hidden"}`,
86
+ className,
87
+ )}
88
+ {...props}
89
+ >
90
+ {children}
91
+ </Component>
92
+ );
93
+ }
@@ -1,88 +1,88 @@
1
- .ObPageHeader-root {
2
- flex: 0 0 auto;
3
- }
4
-
5
- /* --- appbar variant --- */
6
-
7
- .ObPageHeader-appbar {
8
- background-color: var(--ds-color-brand-base-default, #0062ba);
9
- color: var(--ds-color-brand-base-contrast-default, #fff);
10
- }
11
-
12
- .ObPageHeader-appbar .ObPageHeader-bar {
13
- display: flex;
14
- align-items: center;
15
- gap: 0.5rem;
16
- min-height: var(--ob-page-appbar-height, 3.5rem);
17
- padding-inline: 0.5rem 1rem;
18
- }
19
-
20
- .ObPageHeader-title {
21
- flex: 1 1 auto;
22
- margin: 0;
23
- font-size: var(--ds-font-size-lg, 1.25rem);
24
- font-weight: 500;
25
- overflow: hidden;
26
- text-overflow: ellipsis;
27
- white-space: nowrap;
28
- }
29
-
30
- .ObPageHeader-actions {
31
- display: flex;
32
- align-items: center;
33
- gap: 0.5rem;
34
- margin-left: auto;
35
- }
36
-
37
- .ObPageHeader-title + .ObPageHeader-actions {
38
- margin-left: 0;
39
- }
40
-
41
- .ObPageHeader-toggle {
42
- display: flex;
43
- align-items: center;
44
- justify-content: center;
45
- background: transparent;
46
- border: none;
47
- color: inherit;
48
- cursor: pointer;
49
- border-radius: 50%;
50
- height: 2.75rem;
51
- width: 2.75rem;
52
- font-size: 1.5rem;
53
- flex-shrink: 0;
54
- }
55
-
56
- .ObPageHeader-toggle:hover {
57
- background-color: rgb(255 255 255 / 0.12);
58
- }
59
-
60
- /* --- plain variant --- */
61
-
62
- .ObPageHeader-plainInner {
63
- display: flex;
64
- align-items: center;
65
- gap: 0.5rem;
66
- }
67
-
68
- .ObPageHeader-plainTitle {
69
- margin: 0;
70
- font-size: var(--ds-font-size-xl, 1.5rem);
71
- font-weight: 500;
72
- }
73
-
74
- /*
75
- * Reserved slot for the app-launcher and user profile menu in the future
76
- * sidebar-free site layout. Hidden under the current sidebar layout; the
77
- * activation mechanism is decided together with the new website template.
78
- */
79
- .ObPageHeader-end {
80
- display: none;
81
- }
82
-
83
- @media print {
84
- .ObPageHeader-appbar .ObPageHeader-bar,
85
- .ObPageHeader-toggle {
86
- display: none !important;
87
- }
88
- }
1
+ .ObPageHeader-root {
2
+ flex: 0 0 auto;
3
+ }
4
+
5
+ /* --- appbar variant --- */
6
+
7
+ .ObPageHeader-appbar {
8
+ background-color: var(--ds-color-brand-base-default, #0062ba);
9
+ color: var(--ds-color-brand-base-contrast-default, #fff);
10
+ }
11
+
12
+ .ObPageHeader-appbar .ObPageHeader-bar {
13
+ display: flex;
14
+ align-items: center;
15
+ gap: 0.5rem;
16
+ min-height: var(--ob-page-appbar-height, 3.5rem);
17
+ padding-inline: 0.5rem 1rem;
18
+ }
19
+
20
+ .ObPageHeader-title {
21
+ flex: 1 1 auto;
22
+ margin: 0;
23
+ font-size: var(--ds-font-size-lg, 1.25rem);
24
+ font-weight: 500;
25
+ overflow: hidden;
26
+ text-overflow: ellipsis;
27
+ white-space: nowrap;
28
+ }
29
+
30
+ .ObPageHeader-actions {
31
+ display: flex;
32
+ align-items: center;
33
+ gap: 0.5rem;
34
+ margin-left: auto;
35
+ }
36
+
37
+ .ObPageHeader-title + .ObPageHeader-actions {
38
+ margin-left: 0;
39
+ }
40
+
41
+ .ObPageHeader-toggle {
42
+ display: flex;
43
+ align-items: center;
44
+ justify-content: center;
45
+ background: transparent;
46
+ border: none;
47
+ color: inherit;
48
+ cursor: pointer;
49
+ border-radius: 50%;
50
+ height: 2.75rem;
51
+ width: 2.75rem;
52
+ font-size: 1.5rem;
53
+ flex-shrink: 0;
54
+ }
55
+
56
+ .ObPageHeader-toggle:hover {
57
+ background-color: rgb(255 255 255 / 0.12);
58
+ }
59
+
60
+ /* --- plain variant --- */
61
+
62
+ .ObPageHeader-plainInner {
63
+ display: flex;
64
+ align-items: center;
65
+ gap: 0.5rem;
66
+ }
67
+
68
+ .ObPageHeader-plainTitle {
69
+ margin: 0;
70
+ font-size: var(--ds-font-size-xl, 1.5rem);
71
+ font-weight: 500;
72
+ }
73
+
74
+ /*
75
+ * Reserved slot for the app-launcher and user profile menu in the future
76
+ * sidebar-free site layout. Hidden under the current sidebar layout; the
77
+ * activation mechanism is decided together with the new website template.
78
+ */
79
+ .ObPageHeader-end {
80
+ display: none;
81
+ }
82
+
83
+ @media print {
84
+ .ObPageHeader-appbar .ObPageHeader-bar,
85
+ .ObPageHeader-toggle {
86
+ display: none !important;
87
+ }
88
+ }
@@ -1,115 +1,115 @@
1
- import "./PageHeader.css";
2
-
3
- import clsx from "clsx";
4
- import type React from "react";
5
-
6
- import { type AppMenuProps } from "../layout/AppMenu.js";
7
- import { AppMenuDrawer, useAppMenuDrawer } from "../layout/AppMenuDrawer.js";
8
- import { PageBlock, type PageBlockWidth } from "./PageBlock.js";
9
- import { getLocalizedString } from "../i18n.js";
10
-
11
- export type PageHeaderVariant = "appbar" | "plain";
12
-
13
- export type PageHeaderProps = Omit<React.HTMLAttributes<HTMLElement>, "title"> & {
14
- /**
15
- * Actions displayed at the end of the header (buttons, search, etc.)
16
- */
17
- actions?: React.ReactNode;
18
- /**
19
- * Props passed to the `AppMenu` wrapping the `menu` content
20
- */
21
- AppMenuProps?: AppMenuProps;
22
- children?: React.ReactNode;
23
- /**
24
- * App menu (navigation) content. When provided, the `appbar` variant
25
- * renders a menu toggle button and a drawer hosting the menu — docked on
26
- * desktop (≥1200px), overlay on smaller screens.
27
- */
28
- menu?: React.ReactNode;
29
- /**
30
- * Application title
31
- */
32
- title?: React.ReactNode;
33
- /**
34
- * Adds a standardised responsive inline padding to the header content.
35
- * See `Page.Block`.
36
- * @default false
37
- */
38
- gutters?: boolean;
39
- /**
40
- * Constrains and centers the header content to a predefined max-width,
41
- * so it can align with a `Page.Block` of the same width. See `Page.Block`.
42
- */
43
- width?: PageBlockWidth;
44
- /**
45
- * - `"appbar"` (default): a top app bar with menu toggle, title and
46
- * actions. For apps that have an app menu.
47
- * - `"plain"`: no app bar chrome — for simple apps without an app menu
48
- * (e.g. report-issue). Renders the title as a regular heading block.
49
- *
50
- * Both variants reserve an end-slot (`.ObPageHeader-end`) that will host
51
- * the app-launcher and user profile menu in the future sidebar-free site
52
- * layout. It is hidden under the current sidebar layout.
53
- * @default "appbar"
54
- */
55
- variant?: PageHeaderVariant;
56
- };
57
-
58
- /**
59
- * Page header for use inside `Page`. See the `variant` prop for the two
60
- * supported header styles.
61
- */
62
- export function PageHeader({
63
- actions,
64
- AppMenuProps,
65
- children,
66
- className,
67
- gutters,
68
- menu,
69
- title,
70
- variant = "appbar",
71
- width,
72
- ...props
73
- }: PageHeaderProps) {
74
- let { open, isMobile, toggle, close } = useAppMenuDrawer();
75
-
76
- if (variant === "plain") {
77
- return (
78
- <header className={clsx("ObPageHeader-root", "ObPageHeader-plain", className)} {...props}>
79
- <PageBlock className="ObPageHeader-plainInner" width={width} gutters={gutters}>
80
- {title && <h1 className="ObPageHeader-plainTitle">{title}</h1>}
81
- {actions && <div className="ObPageHeader-actions">{actions}</div>}
82
- {children}
83
- <div className="ObPageHeader-end" />
84
- </PageBlock>
85
- </header>
86
- );
87
- }
88
-
89
- return (
90
- <header className={clsx("ObPageHeader-root", "ObPageHeader-appbar", className)} {...props}>
91
- <PageBlock className="ObPageHeader-bar" width={width} gutters={gutters}>
92
- {menu && (
93
- <button
94
- type="button"
95
- className="ObPageHeader-toggle"
96
- onClick={toggle}
97
- aria-label={getLocalizedString("Toggle menu")}
98
- aria-expanded={open}
99
- >
100
- ☰
101
- </button>
102
- )}
103
- {title && <h1 className="ObPageHeader-title">{title}</h1>}
104
- {actions && <div className="ObPageHeader-actions">{actions}</div>}
105
- <div className="ObPageHeader-end" />
106
- </PageBlock>
107
- {children}
108
- {menu && (
109
- <AppMenuDrawer AppMenuProps={AppMenuProps} isMobile={isMobile} onClose={close} open={open}>
110
- {menu}
111
- </AppMenuDrawer>
112
- )}
113
- </header>
114
- );
115
- }
1
+ import "./PageHeader.css";
2
+
3
+ import clsx from "clsx";
4
+ import type React from "react";
5
+
6
+ import { type AppMenuProps } from "../layout/AppMenu.js";
7
+ import { AppMenuDrawer, useAppMenuDrawer } from "../layout/AppMenuDrawer.js";
8
+ import { PageBlock, type PageBlockWidth } from "./PageBlock.js";
9
+ import { getLocalizedString } from "../i18n.js";
10
+
11
+ export type PageHeaderVariant = "appbar" | "plain";
12
+
13
+ export type PageHeaderProps = Omit<React.HTMLAttributes<HTMLElement>, "title"> & {
14
+ /**
15
+ * Actions displayed at the end of the header (buttons, search, etc.)
16
+ */
17
+ actions?: React.ReactNode;
18
+ /**
19
+ * Props passed to the `AppMenu` wrapping the `menu` content
20
+ */
21
+ AppMenuProps?: AppMenuProps;
22
+ children?: React.ReactNode;
23
+ /**
24
+ * App menu (navigation) content. When provided, the `appbar` variant
25
+ * renders a menu toggle button and a drawer hosting the menu — docked on
26
+ * desktop (≥1200px), overlay on smaller screens.
27
+ */
28
+ menu?: React.ReactNode;
29
+ /**
30
+ * Application title
31
+ */
32
+ title?: React.ReactNode;
33
+ /**
34
+ * Adds a standardised responsive inline padding to the header content.
35
+ * See `Page.Block`.
36
+ * @default false
37
+ */
38
+ gutters?: boolean;
39
+ /**
40
+ * Constrains and centers the header content to a predefined max-width,
41
+ * so it can align with a `Page.Block` of the same width. See `Page.Block`.
42
+ */
43
+ width?: PageBlockWidth;
44
+ /**
45
+ * - `"appbar"` (default): a top app bar with menu toggle, title and
46
+ * actions. For apps that have an app menu.
47
+ * - `"plain"`: no app bar chrome — for simple apps without an app menu
48
+ * (e.g. report-issue). Renders the title as a regular heading block.
49
+ *
50
+ * Both variants reserve an end-slot (`.ObPageHeader-end`) that will host
51
+ * the app-launcher and user profile menu in the future sidebar-free site
52
+ * layout. It is hidden under the current sidebar layout.
53
+ * @default "appbar"
54
+ */
55
+ variant?: PageHeaderVariant;
56
+ };
57
+
58
+ /**
59
+ * Page header for use inside `Page`. See the `variant` prop for the two
60
+ * supported header styles.
61
+ */
62
+ export function PageHeader({
63
+ actions,
64
+ AppMenuProps,
65
+ children,
66
+ className,
67
+ gutters,
68
+ menu,
69
+ title,
70
+ variant = "appbar",
71
+ width,
72
+ ...props
73
+ }: PageHeaderProps) {
74
+ let { open, isMobile, toggle, close } = useAppMenuDrawer();
75
+
76
+ if (variant === "plain") {
77
+ return (
78
+ <header className={clsx("ObPageHeader-root", "ObPageHeader-plain", className)} {...props}>
79
+ <PageBlock className="ObPageHeader-plainInner" width={width} gutters={gutters}>
80
+ {title && <h1 className="ObPageHeader-plainTitle">{title}</h1>}
81
+ {actions && <div className="ObPageHeader-actions">{actions}</div>}
82
+ {children}
83
+ <div className="ObPageHeader-end" />
84
+ </PageBlock>
85
+ </header>
86
+ );
87
+ }
88
+
89
+ return (
90
+ <header className={clsx("ObPageHeader-root", "ObPageHeader-appbar", className)} {...props}>
91
+ <PageBlock className="ObPageHeader-bar" width={width} gutters={gutters}>
92
+ {menu && (
93
+ <button
94
+ type="button"
95
+ className="ObPageHeader-toggle"
96
+ onClick={toggle}
97
+ aria-label={getLocalizedString("Toggle menu")}
98
+ aria-expanded={open}
99
+ >
100
+ ☰
101
+ </button>
102
+ )}
103
+ {title && <h1 className="ObPageHeader-title">{title}</h1>}
104
+ {actions && <div className="ObPageHeader-actions">{actions}</div>}
105
+ <div className="ObPageHeader-end" />
106
+ </PageBlock>
107
+ {children}
108
+ {menu && (
109
+ <AppMenuDrawer AppMenuProps={AppMenuProps} isMobile={isMobile} onClose={close} open={open}>
110
+ {menu}
111
+ </AppMenuDrawer>
112
+ )}
113
+ </header>
114
+ );
115
+ }
@@ -1,5 +1,5 @@
1
- @layer ds {
2
- .ObPageTitle-root {
3
- margin-block: 0 var(--ds-size-4);
4
- }
5
- }
1
+ @layer ds {
2
+ .ObPageTitle-root {
3
+ margin-block: 0 var(--ds-size-4);
4
+ }
5
+ }
@@ -1,21 +1,21 @@
1
- import "./PageTitle.css";
2
-
3
- import { Heading, type HeadingProps } from "@digdir/designsystemet-react";
4
- import clsx from "clsx";
5
-
6
- export type PageTitleProps = Omit<HeadingProps, "level"> & {
7
- /** Heading level; the page's title is an `h1` unless the page already has one. */
8
- level?: HeadingProps["level"];
9
- };
10
-
11
- /**
12
- * The title at the top of a page's content: a Designsystemet `Heading`, `h1`, medium size.
13
- *
14
- * Equivalent of `PageTitle` in `@olenbetong/appframe-mui`, which portalled the title into
15
- * the app bar on small screens. On the 2026 templates the site draws the toolbar and the app
16
- * title lives there as breadcrumbs, so the page title is simply the first heading of the
17
- * content.
18
- */
19
- export function PageTitle({ className, level = 1, "data-size": size = "md", ...props }: PageTitleProps) {
20
- return <Heading level={level} data-size={size} className={clsx("ObPageTitle-root", className)} {...props} />;
21
- }
1
+ import "./PageTitle.css";
2
+
3
+ import { Heading, type HeadingProps } from "@digdir/designsystemet-react";
4
+ import clsx from "clsx";
5
+
6
+ export type PageTitleProps = Omit<HeadingProps, "level"> & {
7
+ /** Heading level; the page's title is an `h1` unless the page already has one. */
8
+ level?: HeadingProps["level"];
9
+ };
10
+
11
+ /**
12
+ * The title at the top of a page's content: a Designsystemet `Heading`, `h1`, medium size.
13
+ *
14
+ * Equivalent of `PageTitle` in `@olenbetong/appframe-mui`, which portalled the title into
15
+ * the app bar on small screens. On the 2026 templates the site draws the toolbar and the app
16
+ * title lives there as breadcrumbs, so the page title is simply the first heading of the
17
+ * content.
18
+ */
19
+ export function PageTitle({ className, level = 1, "data-size": size = "md", ...props }: PageTitleProps) {
20
+ return <Heading level={level} data-size={size} className={clsx("ObPageTitle-root", className)} {...props} />;
21
+ }
package/src/page/index.ts CHANGED
@@ -1,4 +1,4 @@
1
- export * from "./Page.js";
2
- export * from "./PageBlock.js";
3
- export * from "./PageHeader.js";
4
- export * from "./PageTitle.js";
1
+ export * from "./Page.js";
2
+ export * from "./PageBlock.js";
3
+ export * from "./PageHeader.js";
4
+ export * from "./PageTitle.js";