lib.example-shared-ui
Shared UI examples demonstrating reusable ContractSpec component composition.
@lssm-tech/lib.example-shared-uibun add @lssm-tech/lib.example-shared-uiManifest declarations describe the current workspace; they do not verify registry publication or runtime execution.
Package guide
Shared React components and hooks for ContractSpec example apps. Provides the common layout, editors, and overlays used across all examples.
What It Provides
- Layer: lib.
- Consumers: example apps.
- Related ContractSpec packages include
@lssm-tech/lib.contracts-spec,@lssm-tech/lib.design-system,@lssm-tech/lib.surface-runtime,@lssm-tech/lib.ui-kit-web,@lssm-tech/tool.bun,@lssm-tech/tool.typescript. - Related ContractSpec packages include
@lssm-tech/lib.contracts-spec,@lssm-tech/lib.design-system,@lssm-tech/lib.surface-runtime,@lssm-tech/lib.ui-kit-web,@lssm-tech/tool.bun,@lssm-tech/tool.typescript.
Installation
npm install @lssm-tech/lib.example-shared-ui
or
bun add @lssm-tech/lib.example-shared-ui
Usage
Import the root entrypoint from @lssm-tech/lib.example-shared-ui, or choose a documented subpath when you only need one part of the package surface. Use NestedCommandShell for embedded example previews that need command search and sectional navigation without mounting the app-level design-system AppShell/sidebar provider.
Architecture
src/bundles/contains bundle definitions and composition entrypoints.src/EvolutionDashboard.tsxis part of the package's public or composition surface.src/EvolutionSidebar.tsxis part of the package's public or composition surface.src/hooks/contains custom hooks for host applications.src/index.tsis the root public barrel and package entrypoint.src/lib/contains package-local helper utilities and adapters.src/LocalDataIndicator.tsxis part of the package's public or composition surface.src/NestedCommandShell.tsxprovides an embedded, nested-safe command/navigation shell for examples that must not mount the app-levelAppShellsidebar.
Public Entry Points
- Export
.resolves through./src/index.ts. - Export
./bundlesresolves through./src/bundles/index.ts. - Export
./bundles/ExampleTemplateBundleresolves through./src/bundles/ExampleTemplateBundle.ts. - Export
./EvolutionDashboardresolves through./src/EvolutionDashboard.tsx. - Export
./EvolutionSidebarresolves through./src/EvolutionSidebar.tsx. - Export
./hooksresolves through./src/hooks/index.ts. - Export
./hooks/useBehaviorTrackingresolves through./src/hooks/useBehaviorTracking.ts. - Export
./hooks/useEvolutionresolves through./src/hooks/useEvolution.ts. - Export
./hooks/useRegistryTemplatesresolves through./src/hooks/useRegistryTemplates.ts. - Export
./hooks/useSpecContentresolves through./src/hooks/useSpecContent.ts. - The package publishes 30 total export subpaths; keep docs aligned with
package.json.
Public Shell Contract
TemplateShell is the reusable, nested-safe preview shell for example packages. It renders only content-scoped header, main, and optional aside regions, so embedded previews can sit inside host apps such as ExampleWebPreview or web-landing without creating another app-level AppShell, SidebarProvider, fixed application sidebar, or global navigation frame.
Import it from either the root package or the documented subpath:
import { TemplateShell } from '@lssm-tech/lib.example-shared-ui';
// or
import { TemplateShell } from '@lssm-tech/lib.example-shared-ui/TemplateShell';Public props:
titleand optionaldescriptionfill the content-scoped preview header.actionsrenders header actions without taking ownership of host navigation.sidebarrenders a bounded in-card aside beside the preview content.showRuntimeIndicatortoggles the local-data indicator for sandboxes that already provide equivalent status chrome.showSaveActionandsavePropscontrol the optional Studio save affordance.childrenrender inside the preview main region.
Use SpecDrivenTemplateShell when a preview needs a surface-runtime bundle plan, but keep the same containment rule: shared example shells own preview content only, not app-level navigation.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run test— bun test --pass-with-no-testsbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun run prebuild— contractspec-bun-build prebuild
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed.
- Add changesets and apply pending fixes.
- Contracts context, bundle exports, surface-runtime docs.
Notes
- Low blast radius — only example apps depend on this package.
TemplateShellis the shared layout for all examples; structural changes affect every example app.
Relationships
Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.
6 declarations
@lssm-tech/lib.contracts-specworkspace:^
Read the package manual ↗@lssm-tech/lib.design-systemworkspace:^
Read the package manual ↗@lssm-tech/lib.ui-kit-webworkspace:^
Read the package manual ↗@tanstack/react-query^5.103.1
reactcatalog:
@lssm-tech/lib.presentation-runtime-coreworkspace:^
Read the package manual ↗
Declared capabilities
Shared UI examples demonstrating reusable ContractSpec component composition.
Scripts
publish:pkgbun publish --tolerate-republish --ignore-scripts --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanrimraf dist .turbolintbun lint:fixlint:fixnode ../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../scripts/biome.cjs check --write .lint:checknode ../../scripts/biome.cjs check .testbun test --pass-with-no-testsprebuildcontractspec-bun-build prebuildtypechecktsgo --noEmit