@smarthome.exchange/catalog

🎛️ Web component catalog for the smarthome.exchange product UI.

This package contains the Dees/Lit component layer: design tokens, primitive controls, the landing page, console shell, and console demo components. It is intentionally UI-first and mostly stateless; live home state should come from @smarthome.exchange/api and shared shapes from @smarthome.exchange/interfaces.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @smarthome.exchange/catalog

Use The Components

Importing the package registers the custom elements exported by the catalog:

import '@smarthome.exchange/catalog';

document.body.innerHTML = `
  <shx-card heading="Living Room">
    <shx-badge kind="success" shape="pill">online</shx-badge>
    <shx-button kind="primary">Run evening scene</shx-button>
  </shx-card>
`;

Render the product surfaces directly:

<shx-landing-page></shx-landing-page>
<shx-console-shell></shx-console-shell>

Public Surface

| Export | Purpose | | --- | --- | | shxBaseStyles, shxElementStyles | Shared design tokens and element base styles. | | shx-badge / ShxBadge | Status labels with variants, dot mode, and pill shape. | | shx-button / ShxButton | Product buttons with kind, size, and block layout options. | | shx-card / ShxCard | Content container with heading, action slot, flush mode, and elevated mode. | | shx-tile / ShxTile | Console tile container with fill, flush, no-scroll, and action slot support. | | shx-icon / ShxIcon | Icon wrapper for catalog/product iconography. | | shx-console-icon / ShxConsoleIcon | Inline icon set used by the console preview components. | | shx-console-shell / ShxConsoleShell | Console surface for the local home runtime UI. | | shx-landing-page / ShxLandingPage | Marketing/developer landing page component. |

Console subcomponents are exported for composition and catalog previewing: sidebar, topbar, statusbar, timeline, floor plan, activity stream, approvals, agent list, quick scenes, and the current view components. shx-console-shell accepts .model, .snapshotResponse, .snapshot, or .provider, in that precedence order. Snapshot responses use the canonical IReq_GetHomeSnapshot['response'] availability; a raw snapshot has no freshness envelope and is therefore rendered as stale and non-live. Snapshot device ownership is shown only when metadata.ownerId identifies a known agent; missing or unknown ownership remains explicit in the UI.

Approval buttons emit shx-approval-decision with { approvalId, decision }, and navigation emits shx-view-change with { view }. The same interactions, plus all other console controls, emit the discriminated shx-console-action event. Its action is add-block, approval-decision, ask-assistant, navigate, new-rule, notifications, open-settings, refresh-activity, or run-scene; navigation, approval, and scene actions include their ID as targetId, and approval actions also include decision. All three events bubble and cross shadow boundaries (bubbles: true, composed: true) so host applications can connect them to runtime APIs. Schedule, timeline, floor-plan geometry, insights, and quick scenes remain demo-backed until dedicated runtime contracts exist. The shell only mounts schedule, timeline, and quick-scene controls for its explicit demo model, so fabricated demo IDs cannot be invoked from snapshot or custom shells.

Additional demo data exports are available for catalog previews, including agents, devices, approvals, household data, rooms, blocks, and activity stream examples.

Primitive Attributes

| Element | Useful attributes and slots | | --- | --- | | shx-badge | kind, dot, shape="pill". | | shx-button | kind, size, block. | | shx-card | heading, flush, elevated, slot="action". | | shx-tile | heading, fill, flush, no-scroll, elevated, slot="action". |

Development Preview

The html/ entry wires the catalog into @design.estate/dees-wcctools so components can be previewed locally by the surrounding build/watch tooling.

pnpm build
pnpm watch
pnpm test

pnpm test builds the package and runs its focused browser tests.

Design Notes

• Public components use @design.estate/dees-element; the HTML development catalog uses dees-domtools and the dev-only dees-wcctools entry.
• Components are registered as custom elements and can be used from plain HTML, TypeScript, or higher-level app shells.
• Demo data is for catalog previews. Durable domain types belong in @smarthome.exchange/interfaces.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.