@stack.gallery/catalog

UI component catalog for Stack.Gallery: the sg-* web components the Stack.Gallery registry UI is built from, written with @design.estate/dees-element (lit).

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 @stack.gallery/catalog

The elements extend the DeesElement of @design.estate/dees-element 4; use the same @design.estate/dees-element major (4.x) in the application that renders them.

Usage

Importing the package registers every element and exports the element classes and the demo pages:

import '@stack.gallery/catalog';
<sg-dashboard-view></sg-dashboard-view>
Tag Class
sg-stat-card SgStatCard
sg-protocol-badge SgProtocolBadge
sg-install-snippet SgInstallSnippet
sg-login-view SgLoginView
sg-dashboard-view SgDashboardView
sg-organizations-list-view SgOrganizationsListView
sg-organization-detail-view SgOrganizationDetailView
sg-repository-detail-view SgRepositoryDetailView
sg-packages-list-view SgPackagesListView
sg-package-detail-view SgPackageDetailView
sg-tokens-view SgTokensView
sg-settings-view SgSettingsView
sg-admin-providers-view SgAdminProvidersView
sg-admin-provider-form-view SgAdminProviderFormView
sg-public-layout SgPublicLayout
sg-public-search-view SgPublicSearchView

Each element takes its data as properties and reports user actions as DOM events; the prop shapes are in ts_web/interfaces.ts, and every element's demo shows a complete example.

A production bundle of the package is shipped as dist_bundle/bundle.js, with the license texts of every bundled package in dist_bundle/bundle.js.third-party-notices.json and .txt.

Development

pnpm install
pnpm build          # dist_ts_web/ and dist_bundle/
pnpm test
pnpm run watch      # demo catalogue: wcctools dev, http://localhost:3002/wcctools/

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 hello@task.vc.

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.

S
Description
No description provided
wcc
Readme
382 KiB
Languages
TypeScript 99.8%
HTML 0.2%