@ojiepermana/angular-theme 22.0.27

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 (42) hide show
  1. package/fesm2022/ojiepermana-angular-theme-layout-services.mjs +364 -0
  2. package/fesm2022/ojiepermana-angular-theme-layout-services.mjs.map +1 -0
  3. package/fesm2022/ojiepermana-angular-theme-layout-types.mjs +32 -0
  4. package/fesm2022/ojiepermana-angular-theme-layout-types.mjs.map +1 -0
  5. package/fesm2022/ojiepermana-angular-theme-layout.mjs +574 -0
  6. package/fesm2022/ojiepermana-angular-theme-layout.mjs.map +1 -0
  7. package/fesm2022/ojiepermana-angular-theme-page.mjs +510 -0
  8. package/fesm2022/ojiepermana-angular-theme-page.mjs.map +1 -0
  9. package/fesm2022/ojiepermana-angular-theme-styles.mjs +244 -0
  10. package/fesm2022/ojiepermana-angular-theme-styles.mjs.map +1 -0
  11. package/fesm2022/ojiepermana-angular-theme.mjs +11 -0
  12. package/fesm2022/ojiepermana-angular-theme.mjs.map +1 -0
  13. package/layout/README.md +471 -0
  14. package/package.json +60 -0
  15. package/page/README.md +239 -0
  16. package/styles/README.md +28 -0
  17. package/styles/css/index.css +9 -0
  18. package/styles/css/seasonal/base/components.css +129 -0
  19. package/styles/css/seasonal/base/package.css +6 -0
  20. package/styles/css/seasonal/base/tailwind.css +144 -0
  21. package/styles/css/seasonal/base/theme.css +287 -0
  22. package/styles/css/seasonal/base/tokens.css +152 -0
  23. package/styles/css/seasonal/ied/package.css +4 -0
  24. package/styles/css/seasonal/ied/theme.css +78 -0
  25. package/styles/css/seasonal/imlek/components.css +87 -0
  26. package/styles/css/seasonal/imlek/package.css +6 -0
  27. package/styles/css/seasonal/imlek/tailwind.css +144 -0
  28. package/styles/css/seasonal/imlek/theme.css +95 -0
  29. package/styles/css/seasonal/imlek/tokens.css +152 -0
  30. package/styles/css/seasonal/index.css +6 -0
  31. package/styles/css/seasonal/natal/package.css +4 -0
  32. package/styles/css/seasonal/natal/theme.css +78 -0
  33. package/styles/css/seasonal/new-year/package.css +4 -0
  34. package/styles/css/seasonal/new-year/theme.css +78 -0
  35. package/styles/css/seasonal/ramadhan/package.css +4 -0
  36. package/styles/css/seasonal/ramadhan/theme.css +78 -0
  37. package/types/ojiepermana-angular-theme-layout-services.d.ts +120 -0
  38. package/types/ojiepermana-angular-theme-layout-types.d.ts +33 -0
  39. package/types/ojiepermana-angular-theme-layout.d.ts +117 -0
  40. package/types/ojiepermana-angular-theme-page.d.ts +168 -0
  41. package/types/ojiepermana-angular-theme-styles.d.ts +89 -0
  42. package/types/ojiepermana-angular-theme.d.ts +2 -0
@@ -0,0 +1,471 @@
1
+ # @ojiepermana/angular-theme/layout
2
+
3
+ Primitive layout projection untuk menyusun shell UI dengan satu root `Layout`, satu variant layout (`vertical`, `horizontal`, `empty`, atau `fluid`), slot `layout-nav`, dan area `LayoutContent` yang menjadi scroll container utama.
4
+
5
+ README ini mendokumentasikan seluruh API publik yang diekspor oleh package agar consumer bisa memahami kontrak komponen, type, service, dan perilaku layout tanpa perlu membaca source code.
6
+
7
+ ## Entry points
8
+
9
+ `@ojiepermana/angular-theme/layout` adalah root entry point yang mengekspor seluruh primitive utama, `LayoutService`, seluruh type, constants, dan guards.
10
+
11
+ ```ts
12
+ import {
13
+ LayoutService,
14
+ LayoutComponent,
15
+ LayoutContentComponent,
16
+ LayoutEmptyComponent,
17
+ LayoutFluidComponent,
18
+ LayoutHorizontalComponent,
19
+ LayoutNavigationComponent,
20
+ LayoutVerticalComponent,
21
+ type LayoutStyle,
22
+ type LayoutSurface,
23
+ type LayoutType,
24
+ type LayoutWidth,
25
+ } from '@ojiepermana/angular-theme/layout';
26
+ ```
27
+
28
+ Secondary entry point tetap tersedia bila consumer ingin import yang lebih eksplisit.
29
+
30
+ ```ts
31
+ import { LayoutService } from '@ojiepermana/angular-theme/layout/services';
32
+ import {
33
+ LAYOUT_DEFAULT_STYLE,
34
+ LAYOUT_DEFAULT_SURFACE,
35
+ LAYOUT_DEFAULT_TYPE,
36
+ LAYOUT_DEFAULT_WIDTH,
37
+ LAYOUT_APPEARANCE_STORAGE_KEY,
38
+ LAYOUT_STYLES,
39
+ LAYOUT_SURFACE_STORAGE_KEY,
40
+ LAYOUT_STYLE_STORAGE_KEY,
41
+ LAYOUT_SURFACES,
42
+ LAYOUT_TYPES,
43
+ LAYOUT_TYPE_STORAGE_KEY,
44
+ LAYOUT_WIDTHS,
45
+ LAYOUT_WIDTH_STORAGE_KEY,
46
+ isUiLayoutSurface,
47
+ isUiLayoutStyle,
48
+ isUiLayoutType,
49
+ isUiLayoutWidth,
50
+ type LayoutContextValue,
51
+ type LayoutStyle,
52
+ type LayoutSurface,
53
+ type LayoutType,
54
+ type LayoutWidth,
55
+ } from '@ojiepermana/angular-theme/layout/types';
56
+ ```
57
+
58
+ Catatan:
59
+
60
+ - Root entry point dan secondary entry point mengekspor symbol yang sama. Gunakan secondary entry point jika consumer ingin dependency path yang lebih eksplisit untuk `services` atau `types`.
61
+ - Untuk kasus halaman yang membaca preferensi persisted, source of truth tetap berada di `LayoutService`.
62
+
63
+ ## Mental model
64
+
65
+ Struktur yang direkomendasikan adalah sebagai berikut.
66
+
67
+ ```html
68
+ <Layout>
69
+ <LayoutVertical | layout-horizontal | layout-empty | layout-fluid>
70
+ <LayoutNavigation>...</LayoutNavigation>
71
+ <LayoutContent>...</LayoutContent>
72
+ </layout-vertical | layout-horizontal | layout-empty | layout-fluid>
73
+ </Layout>
74
+ ```
75
+
76
+ Aturan penggunaannya:
77
+
78
+ - Gunakan tepat satu variant layout di dalam `Layout`.
79
+ - Untuk layout `vertical` dan `horizontal`, urutan child yang umum adalah `layout-nav` lalu `LayoutContent`.
80
+ - Untuk layout `empty`, biasanya cukup `LayoutContent`.
81
+ - Untuk layout `fluid`, child dapat berupa konten page tunggal yang ingin dipusatkan terhadap frame.
82
+ - `LayoutContent` adalah area yang memiliki `overflow-auto`, jadi konten utama sebaiknya ditempatkan di sana.
83
+ - Pada mode `vertical`, lebar nav mengikuti kontennya sendiri (`w-max`), bukan dipaksa oleh root layout.
84
+
85
+ ## Quick start
86
+
87
+ ### Vertical
88
+
89
+ ```html
90
+ <Layout surface="grid" appearance="border-rail" width="full">
91
+ <LayoutVertical>
92
+ <LayoutNavigation ariaLabel="Primary navigation">
93
+ <aside class="flex h-full w-56 flex-col gap-4 bg-card/80 p-4">Navigation</aside>
94
+ </LayoutNavigation>
95
+
96
+ <LayoutContent class="bg-background/80 p-6"> Content </LayoutContent>
97
+ </LayoutVertical>
98
+ </Layout>
99
+ ```
100
+
101
+ ### Horizontal
102
+
103
+ ```html
104
+ <Layout surface="line-horizontal" appearance="flat" width="wide">
105
+ <LayoutHorizontal>
106
+ <LayoutNavigation ariaLabel="Top navigation">
107
+ <header class="flex h-full items-center px-4">Navigation</header>
108
+ </LayoutNavigation>
109
+
110
+ <LayoutContent class="p-6">Content</LayoutContent>
111
+ </LayoutHorizontal>
112
+ </Layout>
113
+ ```
114
+
115
+ ### Empty
116
+
117
+ ```html
118
+ <Layout surface="flat" appearance="flat" width="container">
119
+ <LayoutEmpty>
120
+ <LayoutContent class="py-8"> Content </LayoutContent>
121
+ </LayoutEmpty>
122
+ </Layout>
123
+ ```
124
+
125
+ ### Fluid
126
+
127
+ ```html
128
+ <Layout surface="grid" appearance="border-rail" width="fluid">
129
+ <LayoutFluid>
130
+ <section class="w-full max-w-xl border border-border bg-card/90 p-6">Content</section>
131
+ </LayoutFluid>
132
+ </Layout>
133
+ ```
134
+
135
+ ## Pola page-level yang direkomendasikan
136
+
137
+ Untuk halaman yang memiliki default sendiri tetapi tetap harus tunduk pada nilai local storage yang sudah tersimpan, pakai `LayoutService.registerDefaults(...)` sekali di level page, lalu bind root `Layout` ke signal service.
138
+
139
+ ```ts
140
+ import { ChangeDetectionStrategy, Component, inject } from '@angular/core';
141
+ import {
142
+ LayoutService,
143
+ LayoutComponent,
144
+ LayoutContentComponent,
145
+ LayoutHorizontalComponent,
146
+ LayoutNavigationComponent,
147
+ } from '@ojiepermana/angular-theme/layout';
148
+
149
+ @Component({
150
+ selector: 'demo-board',
151
+ changeDetection: ChangeDetectionStrategy.OnPush,
152
+ imports: [LayoutComponent, LayoutHorizontalComponent, LayoutNavigationComponent, LayoutContentComponent],
153
+ template: `
154
+ <Layout [surface]="layout.surface()" [appearance]="layout.appearance()" [width]="layout.width()">
155
+ <LayoutHorizontal>
156
+ <LayoutNavigation ariaLabel="Board navigation">...</LayoutNavigation>
157
+ <LayoutContent>...</LayoutContent>
158
+ </LayoutHorizontal>
159
+ </Layout>
160
+ `,
161
+ })
162
+ export class DemoBoardComponent {
163
+ protected readonly layout = inject(LayoutService).registerDefaults({
164
+ surface: 'grid',
165
+ appearance: 'border-rail',
166
+ type: 'horizontal',
167
+ width: 'container',
168
+ });
169
+ }
170
+ ```
171
+
172
+ Dengan pola ini:
173
+
174
+ - consumer cukup mendeklarasikan default sekali
175
+ - nilai valid yang sudah ada di local storage tidak akan ditimpa
176
+ - `layout.type()` bisa langsung dipakai untuk memilih variant `vertical`, `horizontal`, atau `empty`
177
+ - root `Layout` selalu merender nilai final dari service, bukan hanya fallback dari template
178
+
179
+ ## API reference
180
+
181
+ ### `LayoutComponent`
182
+
183
+ Root wrapper yang mengatur background surface, appearance frame, width mode, dan sinkronisasi fallback state ke `LayoutService`.
184
+
185
+ Selector: `Layout`
186
+
187
+ Inputs:
188
+
189
+ | Input | Type | Default | Deskripsi |
190
+ | -------------- | --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
191
+ | `surface` | `LayoutSurface` | `'flat'` | Menentukan fallback background root layout. Jika local storage `layout-surface` berisi nilai valid, nilai storage yang dipakai. |
192
+ | `appearance` | `LayoutStyle or null` | `null` | API template utama untuk menentukan fallback appearance frame. Jika input ini kosong, primitive mencoba alias `layout-style`, lalu fallback efektif akhirnya `flat`. |
193
+ | `layout-style` | `LayoutStyle or null` | `null` | Alias kompatibilitas untuk template lama. Tetap dibaca sebagai fallback, tetapi API yang direkomendasikan adalah `appearance`. |
194
+ | `width` | `LayoutWidth` | `'full'` | Menentukan fallback padding outer dan perilaku container frame. Jika local storage `layout-width` berisi nilai valid, nilai storage yang dipakai. |
195
+ | `class` | `string` | `''` | Menambahkan class pada host `Layout`. |
196
+
197
+ Behavior:
198
+
199
+ - Jika consumer memberi input manual `surface`, `appearance`, atau `width`, nilai itu dipakai sebagai override in-memory untuk instance aktif tanpa menulis `localStorage`.
200
+ - Jika input manual kosong, primitive mendaftarkan default `surface`, `appearance`, dan `width` ke `LayoutService` hanya saat local storage belum memiliki nilai valid.
201
+ - Nilai visual final selalu dibaca kembali dari `LayoutService`, sehingga child primitive tetap membaca state yang sama selama instance aktif.
202
+ - Menambahkan atribut host `data-surface`, `data-layout-appearance`, `data-layout-style`, `data-layout-width`, dan `data-layout-type`.
203
+ - Root tidak menyediakan input `type`. Type aktif dikendalikan oleh variant layout yang dirender sebagai override in-memory, atau oleh consumer melalui `LayoutService.registerDefaults({ type })` sebelum template mengevaluasi `layout.type()`.
204
+ - Selalu merender frame border.
205
+ - Jika `appearance="border-rail"`, root menambah rail dekoratif di empat sudut frame, rail inset horizontal, dan rail vertikal sekunder di luar sisi kiri-kanan frame sehingga frame terlihat seperti memiliki double rail.
206
+ - Jika `width="container"`, frame dipusatkan mulai breakpoint `lg` dengan container behavior.
207
+ - Jika `width="fluid"` dan variant aktif adalah `LayoutFluid`, frame akan shrink mengikuti tinggi dan lebar konten lalu dipusatkan terhadap viewport.
208
+
209
+ ### `LayoutVerticalComponent`
210
+
211
+ Variant layout untuk shell dua kolom: nav di kiri, content di kanan.
212
+
213
+ Selector: `LayoutVertical`
214
+
215
+ Inputs:
216
+
217
+ | Input | Type | Default | Deskripsi |
218
+ | ------- | -------- | ------- | --------------------------------------------- |
219
+ | `class` | `string` | `''` | Menambahkan class pada host `LayoutVertical`. |
220
+
221
+ Behavior:
222
+
223
+ - Mengatur `LayoutService.type` menjadi `'vertical'` hanya untuk state aktif dan tidak menulis `localStorage`.
224
+ - Menggunakan grid `grid-cols-[auto_minmax(0,1fr)]`.
225
+ - Dalam mode `border-rail`, host dibuat `overflow-visible` agar rail nav/frame dapat mengekstensi keluar area frame.
226
+
227
+ ### `LayoutHorizontalComponent`
228
+
229
+ Variant layout untuk shell bertumpuk vertikal: nav di atas, content mengisi sisa tinggi.
230
+
231
+ Selector: `LayoutHorizontal`
232
+
233
+ Inputs:
234
+
235
+ | Input | Type | Default | Deskripsi |
236
+ | ------- | -------- | ------- | ----------------------------------------------- |
237
+ | `class` | `string` | `''` | Menambahkan class pada host `LayoutHorizontal`. |
238
+
239
+ Behavior:
240
+
241
+ - Mengatur `LayoutService.type` menjadi `'horizontal'` hanya untuk state aktif dan tidak menulis `localStorage`.
242
+ - Menggunakan flex column untuk menyusun nav dan content.
243
+ - Tidak merender rail nav vertikal khusus.
244
+
245
+ ### `LayoutEmptyComponent`
246
+
247
+ Variant layout tanpa nav, dipakai untuk halaman yang hanya memiliki satu area konten.
248
+
249
+ Selector: `LayoutEmpty`
250
+
251
+ Inputs:
252
+
253
+ | Input | Type | Default | Deskripsi |
254
+ | ------- | -------- | ------- | ------------------------------------------ |
255
+ | `class` | `string` | `''` | Menambahkan class pada host `LayoutEmpty`. |
256
+
257
+ Behavior:
258
+
259
+ - Mengatur `LayoutService.type` menjadi `'empty'` hanya untuk state aktif dan tidak menulis `localStorage`.
260
+ - Menyediakan wrapper penuh untuk satu area konten.
261
+ - `layout-nav` akan tersembunyi jika tetap dirender di mode ini.
262
+
263
+ ### `LayoutNavigationComponent`
264
+
265
+ Wrapper untuk slot navigasi.
266
+
267
+ Selector: `layout-nav`
268
+
269
+ Inputs:
270
+
271
+ | Input | Type | Default | Deskripsi |
272
+ | ----------- | -------- | --------------------- | ------------------------------------------------ |
273
+ | `ariaLabel` | `string` | `'Layout navigation'` | Label aksesibilitas untuk landmark `navigation`. |
274
+ | `class` | `string` | `''` | Menambahkan class pada host `layout-nav`. |
275
+
276
+ Behavior:
277
+
278
+ - Host selalu memiliki `role="navigation"`.
279
+ - Menambahkan atribut host `data-layout-type`, `data-layout-appearance`, dan `data-layout-style`.
280
+ - Pada layout `horizontal`, nav menggunakan tinggi tetap `h-12`.
281
+ - Pada layout `vertical`, nav menggunakan `w-max max-w-full`, sehingga lebar nav mengikuti isi child.
282
+ - Pada layout `vertical` dengan `appearance="border-rail"`, komponen ini merender rail vertikal di sisi kanan nav, termasuk ekstensinya ke atas dan bawah viewport.
283
+ - Pada layout `empty`, nav disembunyikan.
284
+
285
+ Catatan penggunaan:
286
+
287
+ - Untuk mode `border-rail`, jangan tambahkan `border-r` manual pada konten nav bila yang diinginkan adalah rail bawaan primitive.
288
+ - Styling visual isi nav sebaiknya ditempatkan pada elemen child di dalam `layout-nav`, bukan dengan mengandalkan border host.
289
+
290
+ ### `LayoutContentComponent`
291
+
292
+ Wrapper untuk area konten utama yang scrollable.
293
+
294
+ Selector: `LayoutContent`
295
+
296
+ Inputs:
297
+
298
+ | Input | Type | Default | Deskripsi |
299
+ | ------- | -------- | ------- | -------------------------------------------- |
300
+ | `class` | `string` | `''` | Menambahkan class pada host `LayoutContent`. |
301
+
302
+ Behavior:
303
+
304
+ - Selalu menggunakan `overflow-auto`.
305
+ - Pada layout `horizontal`, konten memakai `flex-1` agar mengisi sisa tinggi setelah nav.
306
+ - Pada layout `vertical`, konten mengisi tinggi penuh kolom kanan.
307
+ - Pada layout `empty`, konten memakai `h-full w-full`.
308
+ - Jika `LayoutService.width()` adalah `'container'`, konten juga dipusatkan mulai `lg` dengan `lg:container lg:mx-auto`.
309
+
310
+ ## Surface API
311
+
312
+ Nilai `surface` yang tersedia berasal dari `LAYOUT_SURFACES`.
313
+
314
+ | Nilai | Efek visual |
315
+ | ------------------- | -------------------------------------------------------------------------- |
316
+ | `'flat'` | Background polos `bg-background`. |
317
+ | `'grid'` | Pola grid tipis dua arah. |
318
+ | `'honeycome'` | Pola radial rapat. Nama API dieja `honeycome` agar sesuai export saat ini. |
319
+ | `'line-vertical'` | Garis vertikal berulang. |
320
+ | `'line-horizontal'` | Garis horizontal berulang. |
321
+
322
+ ## Appearance API
323
+
324
+ Nilai `appearance` yang tersedia berasal dari `LAYOUT_STYLES`.
325
+
326
+ | Nilai | Efek visual |
327
+ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
328
+ | `'flat'` | Frame tetap memiliki border 1px tanpa rail luar. |
329
+ | `'border-rail'` | Frame memiliki border lebih tebal, rail dekoratif pada sudut frame, rail inset horizontal, serta rail vertikal sekunder di luar sisi kiri-kanan untuk efek double rail; untuk layout vertical, nav juga mendapat rail kanan yang mengekstensi ke atas dan bawah viewport. |
330
+
331
+ Gunakan `appearance` di template Angular. Alias `layout-style` tetap tersedia untuk kompatibilitas template lama. Nilai persisted untuk appearance disimpan dengan key local storage `layout-appearance`.
332
+
333
+ ## Width API
334
+
335
+ Nilai `width` yang tersedia berasal dari `LAYOUT_WIDTHS`.
336
+
337
+ | Nilai | Perilaku |
338
+ | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
339
+ | `'full'` | Root menggunakan padding `p-4`, frame dan content tetap full width. |
340
+ | `'wide'` | Di bawah `lg` tampil seperti `full`, mulai `lg` memakai padding `p-12` di root. |
341
+ | `'container'` | Di bawah `lg` tampil seperti `full`, mulai `lg` root memakai `py-16` tanpa padding horizontal, lalu frame/content dipusatkan dengan container behavior. |
342
+ | `'fluid'` | Dipakai untuk `LayoutFluid`: root dan rail menjadi kanvas centering, frame shrink mengikuti ukuran konten, lalu tetap dibatasi `max-width` dan `max-height` viewport. |
343
+
344
+ Ringkasnya:
345
+
346
+ - `wide` dan `container` sengaja collapse ke tampilan `full` di bawah breakpoint `lg`.
347
+ - Perbedaan utama `container` muncul mulai `lg`, saat frame dan content tidak lagi full bleed secara horizontal.
348
+ - `fluid` ditujukan untuk halaman tunggal seperti auth, splash, atau status page yang membutuhkan frame auto-centered di kedua sumbu.
349
+
350
+ ## `LayoutService`
351
+
352
+ Service state kecil untuk menyimpan konteks layout aktif dan persistence ke local storage.
353
+
354
+ Import:
355
+
356
+ ```ts
357
+ import { LayoutService } from '@ojiepermana/angular-theme/layout/services';
358
+ ```
359
+
360
+ Readonly signals:
361
+
362
+ | Properti | Type | Deskripsi |
363
+ | ------------ | ----------------------- | --------------------------------------------------- |
364
+ | `surface` | `Signal<LayoutSurface>` | Surface layout aktif. |
365
+ | `type` | `Signal<LayoutType>` | Type layout aktif. |
366
+ | `appearance` | `Signal<LayoutStyle>` | Appearance layout aktif. |
367
+ | `style` | `Signal<LayoutStyle>` | Alias kompatibilitas untuk appearance layout aktif. |
368
+ | `width` | `Signal<LayoutWidth>` | Width mode aktif. |
369
+
370
+ Methods:
371
+
372
+ | Method | Signature | Deskripsi |
373
+ | --------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
374
+ | `registerSurface` | `(surface: LayoutSurface) => void` | Mendaftarkan fallback `layout-surface` ke local storage hanya jika storage belum memiliki nilai valid. Jika sudah ada nilai valid, service tetap memakai nilai yang tersimpan. |
375
+ | `registerType` | `(type: LayoutType) => void` | Mendaftarkan fallback `layout-type` ke local storage hanya jika storage belum memiliki nilai valid. Jika sudah ada nilai valid, service tetap memakai nilai yang tersimpan. |
376
+ | `registerAppearance` | `(appearance: LayoutStyle) => void` | Mendaftarkan fallback `layout-appearance` ke local storage hanya jika storage belum memiliki nilai valid. Jika sudah ada nilai valid, service tetap memakai nilai yang tersimpan. |
377
+ | `registerStyle` | `(style: LayoutStyle) => void` | Alias kompatibilitas untuk `registerAppearance(...)`. |
378
+ | `registerWidth` | `(width: LayoutWidth) => void` | Mendaftarkan fallback `layout-width` ke local storage hanya jika storage belum memiliki nilai valid. Jika sudah ada nilai valid, service tetap memakai nilai yang tersimpan. |
379
+ | `registerDefaults` | `(defaults: { surface?, appearance?, type?, width? }) => this` | Mendaftarkan beberapa fallback sekaligus. Ini adalah API yang direkomendasikan untuk page-level default karena consumer cukup memanggil satu method dan tetap menghormati nilai storage yang sudah valid. |
380
+ | `setSurface` | `(surface: LayoutSurface, options?: { persist?: boolean }) => void` | Menulis surface ke signal. Secara default juga menulis `localStorage`, tetapi consumer dapat memakai `persist: false` untuk override sementara. |
381
+ | `setType` | `(type: LayoutType, options?: { persist?: boolean }) => void` | Menulis type ke signal. Secara default juga menulis `localStorage`, tetapi consumer dapat memakai `persist: false` untuk override sementara. |
382
+ | `setAppearance` | `(appearance: LayoutStyle, options?: { persist?: boolean }) => void` | Menulis appearance ke signal. Secara default juga menulis `layout-appearance`, tetapi consumer dapat memakai `persist: false` untuk override sementara. |
383
+ | `setStyle` | `(style: LayoutStyle, options?: { persist?: boolean }) => void` | Alias kompatibilitas untuk `setAppearance(...)`, termasuk opsi `persist`. |
384
+ | `setWidth` | `(width: LayoutWidth, options?: { persist?: boolean }) => void` | Menulis width ke signal. Secara default juga menulis `localStorage`, tetapi consumer dapat memakai `persist: false` untuk override sementara. |
385
+ | `getStoredSurface` | `() => LayoutSurface` | Membaca surface yang valid dari storage atau default. |
386
+ | `getStoredType` | `() => LayoutType` | Membaca type yang valid dari storage atau default. |
387
+ | `getStoredAppearance` | `() => LayoutStyle` | Membaca appearance yang valid dari storage atau default. |
388
+ | `getStoredStyle` | `() => LayoutStyle` | Alias kompatibilitas untuk `getStoredAppearance()`. |
389
+ | `getStoredWidth` | `() => LayoutWidth` | Membaca width yang valid dari storage atau default. |
390
+
391
+ Persistence behavior:
392
+
393
+ - Storage key: `layout-surface`, `layout-type`, `layout-appearance`, dan `layout-width`.
394
+ - Default value: `flat`, `vertical`, `flat`, dan `full`.
395
+ - `registerDefaults(...)` adalah API yang direkomendasikan untuk menetapkan default per halaman tanpa menimpa nilai valid yang sudah tersimpan sebelumnya.
396
+ - Manual template input pada `Layout` dan variant layout yang dirender consumer hanya mengubah state aktif; keduanya tidak lagi menulis `localStorage`.
397
+ - Method `registerSurface(...)`, `registerType(...)`, `registerAppearance(...)`, dan `registerWidth(...)` tetap tersedia bila consumer memang perlu registrasi yang lebih granular.
398
+ - Legacy storage key `layout-style` masih dibaca untuk kompatibilitas dan akan dibersihkan ketika appearance ditulis ulang ke `layout-appearance`.
399
+ - Aman untuk SSR karena hanya mengakses `localStorage` saat runtime browser tersedia.
400
+
401
+ Contoh penggunaan:
402
+
403
+ ```ts
404
+ import { ChangeDetectionStrategy, Component, inject } from '@angular/core';
405
+ import { LayoutService } from '@ojiepermana/angular-theme/layout/services';
406
+
407
+ @Component({
408
+ selector: 'demo-layout-toggle',
409
+ changeDetection: ChangeDetectionStrategy.OnPush,
410
+ template: `
411
+ <button type="button" (click)="layout.setAppearance('flat')">Flat</button>
412
+ <button type="button" (click)="layout.setAppearance('border-rail')">Border rail</button>
413
+ `,
414
+ })
415
+ export class DemoLayoutToggleComponent {
416
+ readonly layout = inject(LayoutService);
417
+ }
418
+ ```
419
+
420
+ ## Types, constants, dan guards
421
+
422
+ Seluruh symbol berikut diekspor dari `@ojiepermana/angular-theme/layout/types`.
423
+
424
+ ### Types
425
+
426
+ | Symbol | Nilai |
427
+ | -------------------- | --------------------------------------------------------------------------------------------------------- |
428
+ | `LayoutType` | `vertical`, `horizontal`, `empty`, `fluid` |
429
+ | `LayoutSurface` | `flat`, `grid`, `honeycome`, `line-vertical`, `line-horizontal` |
430
+ | `LayoutStyle` | `flat`, `border-rail` |
431
+ | `LayoutWidth` | `full`, `wide`, `container`, `fluid` |
432
+ | `LayoutContextValue` | Objekt berbentuk `{ surface, type, appearance, style, width }` yang masing-masing berupa readonly signal. |
433
+
434
+ ### Constants
435
+
436
+ | Symbol | Nilai |
437
+ | ------------------------------- | ------------------------------------------------------------------- |
438
+ | `LAYOUT_TYPES` | `['vertical', 'horizontal', 'empty', 'fluid']` |
439
+ | `LAYOUT_SURFACES` | `['flat', 'grid', 'honeycome', 'line-vertical', 'line-horizontal']` |
440
+ | `LAYOUT_STYLES` | `['flat', 'border-rail']` |
441
+ | `LAYOUT_WIDTHS` | `['full', 'wide', 'container', 'fluid']` |
442
+ | `LAYOUT_DEFAULT_SURFACE` | `'flat'` |
443
+ | `LAYOUT_DEFAULT_TYPE` | `'vertical'` |
444
+ | `LAYOUT_DEFAULT_STYLE` | `'flat'` |
445
+ | `LAYOUT_DEFAULT_WIDTH` | `'full'` |
446
+ | `LAYOUT_SURFACE_STORAGE_KEY` | `'layout-surface'` |
447
+ | `LAYOUT_APPEARANCE_STORAGE_KEY` | `'layout-appearance'` |
448
+ | `LAYOUT_TYPE_STORAGE_KEY` | `'layout-type'` |
449
+ | `LAYOUT_STYLE_STORAGE_KEY` | `'layout-style'` `(legacy compatibility key)` |
450
+ | `LAYOUT_WIDTH_STORAGE_KEY` | `'layout-width'` |
451
+
452
+ ### Guards
453
+
454
+ - `isUiLayoutSurface(value: string | null): value is LayoutSurface`
455
+ Memvalidasi string terhadap daftar surface yang didukung.
456
+ - `isUiLayoutType(value: string | null): value is LayoutType`
457
+ Memvalidasi string terhadap daftar type yang didukung.
458
+ - `isUiLayoutStyle(value: string | null): value is LayoutStyle`
459
+ Memvalidasi string terhadap daftar style yang didukung.
460
+ - `isUiLayoutWidth(value: string | null): value is LayoutWidth`
461
+ Memvalidasi string terhadap daftar width yang didukung.
462
+
463
+ ## Consumer guidance
464
+
465
+ - Gunakan `appearance` di template. `layout-style` dipertahankan hanya untuk kompatibilitas.
466
+ - Untuk halaman yang punya default layout sendiri, utamakan `inject(LayoutService).registerDefaults({...})` sekali di level page daripada memanggil empat method `register...` terpisah.
467
+ - Jika halaman harus merender variant berdasarkan preferensi yang tersimpan, pakai `layout.type()` sebagai sumber branching dan bind root `Layout` ke `layout.surface()`, `layout.appearance()`, dan `layout.width()`.
468
+ - Tempatkan scroll page utama di `LayoutContent`, bukan di root `Layout`.
469
+ - Untuk `vertical + border-rail`, biarkan primitive yang merender rail kanan nav; hindari border manual yang menduplikasi garis itu.
470
+ - Semua primitive menerima input `class`, jadi styling tambahan paling aman diberikan lewat class host atau child content.
471
+ - Jika consumer perlu membaca state layout aktif dari komponen lain, inject `LayoutService` dan baca signal readonly-nya.
package/package.json ADDED
@@ -0,0 +1,60 @@
1
+ {
2
+ "name": "@ojiepermana/angular-theme",
3
+ "version": "22.0.27",
4
+ "repository": {
5
+ "type": "git",
6
+ "url": "git+https://github.com/edsis/angular.git"
7
+ },
8
+ "homepage": "https://github.com/edsis/angular#readme",
9
+ "bugs": {
10
+ "url": "https://github.com/edsis/angular/issues"
11
+ },
12
+ "peerDependencies": {
13
+ "@angular/common": ">=22.0.0",
14
+ "@angular/core": ">=22.0.0",
15
+ "@angular/router": ">=22.0.0",
16
+ "@ojiepermana/angular-navigation": "^22.0.27",
17
+ "@ojiepermana/angular-component": "^22.0.27",
18
+ "rxjs": ">=7.8.0"
19
+ },
20
+ "dependencies": {
21
+ "tslib": "^2.8.1"
22
+ },
23
+ "publishConfig": {
24
+ "access": "public",
25
+ "registry": "https://registry.npmjs.org/"
26
+ },
27
+ "sideEffects": false,
28
+ "module": "fesm2022/ojiepermana-angular-theme.mjs",
29
+ "typings": "types/ojiepermana-angular-theme.d.ts",
30
+ "exports": {
31
+ "./package.json": {
32
+ "default": "./package.json"
33
+ },
34
+ ".": {
35
+ "types": "./types/ojiepermana-angular-theme.d.ts",
36
+ "default": "./fesm2022/ojiepermana-angular-theme.mjs"
37
+ },
38
+ "./layout": {
39
+ "types": "./types/ojiepermana-angular-theme-layout.d.ts",
40
+ "default": "./fesm2022/ojiepermana-angular-theme-layout.mjs"
41
+ },
42
+ "./layout/services": {
43
+ "types": "./types/ojiepermana-angular-theme-layout-services.d.ts",
44
+ "default": "./fesm2022/ojiepermana-angular-theme-layout-services.mjs"
45
+ },
46
+ "./layout/types": {
47
+ "types": "./types/ojiepermana-angular-theme-layout-types.d.ts",
48
+ "default": "./fesm2022/ojiepermana-angular-theme-layout-types.mjs"
49
+ },
50
+ "./page": {
51
+ "types": "./types/ojiepermana-angular-theme-page.d.ts",
52
+ "default": "./fesm2022/ojiepermana-angular-theme-page.mjs"
53
+ },
54
+ "./styles": {
55
+ "types": "./types/ojiepermana-angular-theme-styles.d.ts",
56
+ "default": "./fesm2022/ojiepermana-angular-theme-styles.mjs"
57
+ }
58
+ },
59
+ "type": "module"
60
+ }