@crystaltech/hsms-shared-ui 0.6.9-alpha-1 → 0.6.9-alpha-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/README.md +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -310,7 +310,7 @@ Prevent initial white screen and show brand instantly while Vite/PWA initializes
|
|
|
310
310
|
|
|
311
311
|
LocalStorage keys used
|
|
312
312
|
- Theme: `theme.mode`, `theme.themeColor`
|
|
313
|
-
- Branding: `organization_name
|
|
313
|
+
- Branding: `organization_name`
|
|
314
314
|
|
|
315
315
|
PWA and CSP
|
|
316
316
|
- Vite PWA: ESM import gets precached; CDN IIFE is external and fetched network-first.
|
|
@@ -329,7 +329,7 @@ Example host page: see `examples/host.html`.
|
|
|
329
329
|
- Vite apps: add `import '@crystaltech/hsms-shared-ui/preMountSplash'` at the top of your entry file.
|
|
330
330
|
- Microfrontend/legacy: include the pinned CDN IIFE script in your host HTML.
|
|
331
331
|
- Ensure branding/theme keys are available early:
|
|
332
|
-
- `localStorage.organization_name`, `localStorage.
|
|
332
|
+
- `localStorage.organization_name`, `localStorage.theme`.
|
|
333
333
|
- Optional manual init and custom root:
|
|
334
334
|
- `initPreMountSplash({ rootId: 'portal-root' })`.
|
|
335
335
|
- Signal readiness after your app mounts:
|
|
@@ -357,7 +357,7 @@ IIFE host example:
|
|
|
357
357
|
// or: window.dispatchEvent(new Event('app-ready'));
|
|
358
358
|
// optional: set branding early so it shows on splash
|
|
359
359
|
localStorage.setItem('organization_name', 'HSMS');
|
|
360
|
-
|
|
360
|
+
// removed: organization_logo_full_url usage
|
|
361
361
|
localStorage.setItem('theme', JSON.stringify({ mode: 'light', themeColor: '#2c5282' }));
|
|
362
362
|
</script>
|
|
363
363
|
```
|
|
@@ -366,7 +366,7 @@ IIFE host example:
|
|
|
366
366
|
- Pin version across all microfrontends and hosts: `@crystaltech/hsms-shared-ui@0.6.6-alpha-0.4`.
|
|
367
367
|
- Choose one integration per app: ESM import (Vite) or IIFE CDN (host HTML) — avoid double init.
|
|
368
368
|
- Standardize the mount root id (e.g., `portal-root`) and pass `{ rootId }` consistently.
|
|
369
|
-
- Seed brand/theme early at login/bootstrap: `organization_name`, `
|
|
369
|
+
- Seed brand/theme early at login/bootstrap: `organization_name`, `theme`.
|
|
370
370
|
- Signal readiness on mount: call `markAppReady()` or dispatch `new Event('app-ready')`.
|
|
371
371
|
- CSP: allow the injected `<style>` and brand logo source in `style-src`/`img-src`.
|
|
372
372
|
- Performance: include the IIFE script before heavy bundles; avoid blocking inline scripts before splash.
|
|
@@ -378,7 +378,7 @@ IIFE host example:
|
|
|
378
378
|
1) Install: `pnpm add @crystaltech/hsms-shared-ui@0.6.6-alpha-0.4`
|
|
379
379
|
2) At top of `src/main.tsx` (or `src/index.ts`): `import '@crystaltech/hsms-shared-ui/preMountSplash'`
|
|
380
380
|
3) After your app mounts: `import { markAppReady } from '@crystaltech/hsms-shared-ui/preMountSplash'; markAppReady();`
|
|
381
|
-
4) Optional: set early brand/theme keys: `localStorage.setItem('organization_name', 'HSMS')
|
|
381
|
+
4) Optional: set early brand/theme keys: `localStorage.setItem('organization_name', 'HSMS');`
|
|
382
382
|
|
|
383
383
|
React (Vite) example — recommended wiring
|
|
384
384
|
```tsx
|