update documentation
This commit is contained in:
parent
51382611cf
commit
57bbca6b28
@ -2,17 +2,32 @@
|
||||
"gitzone": {
|
||||
"projectType": "wcc",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "designestate",
|
||||
"gitrepo": "dees-wcctools",
|
||||
"description": "wcc tools for creating element catalogues",
|
||||
"description": "A set of web component tools for creating element catalogues, enabling the structured development and documentation of custom elements and pages.",
|
||||
"npmPackagename": "@designestate/dees-wcctools",
|
||||
"license": "MIT",
|
||||
"projectDomain": "design.estate"
|
||||
"projectDomain": "design.estate",
|
||||
"keywords": [
|
||||
"web components",
|
||||
"element catalogues",
|
||||
"custom elements",
|
||||
"documentation",
|
||||
"typescript",
|
||||
"lit",
|
||||
"component development",
|
||||
"design system",
|
||||
"element testing",
|
||||
"page development"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**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.\n\n### Trademarks\n\nThis 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 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, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
|
||||
}
|
||||
}
|
||||
16
package.json
16
package.json
@ -2,7 +2,7 @@
|
||||
"name": "@design.estate/dees-wcctools",
|
||||
"version": "1.0.87",
|
||||
"private": false,
|
||||
"description": "wcc tools for creating element catalogues",
|
||||
"description": "A set of web component tools for creating element catalogues, enabling the structured development and documentation of custom elements and pages.",
|
||||
"main": "dist_ts_web/index.js",
|
||||
"typings": "dist_ts_web/index.d.ts",
|
||||
"type": "module",
|
||||
@ -42,5 +42,17 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 Chrome versions"
|
||||
],
|
||||
"keywords": [
|
||||
"web components",
|
||||
"element catalogues",
|
||||
"custom elements",
|
||||
"documentation",
|
||||
"typescript",
|
||||
"lit",
|
||||
"component development",
|
||||
"design system",
|
||||
"element testing",
|
||||
"page development"
|
||||
]
|
||||
}
|
||||
}
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
134
readme.md
134
readme.md
@ -1,39 +1,117 @@
|
||||
# @designestate/dees-wcctools
|
||||
# @design.estate/dees-wcctools
|
||||
wcc tools for creating element catalogues
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@designestate/dees-wcctools)
|
||||
* [gitlab.com (source)](https://gitlab.com/designestate/dees-wcctools)
|
||||
* [github.com (source mirror)](https://github.com/designestate/dees-wcctools)
|
||||
* [docs (typedoc)](https://designestate.gitlab.io/dees-wcctools/)
|
||||
## Install
|
||||
To install `@design.estate/dees-wcctools`, you can use npm:
|
||||
|
||||
## Status for master
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
```bash
|
||||
npm install @design.estate/dees-wcctools --save
|
||||
```
|
||||
|
||||
## Usage
|
||||
The `@design.estate/dees-wcctools` package provides a set of tools for creating element catalogues using Web Components. It leverages LitElement for creating custom elements and provides a structured way to showcase and test these elements in various environments and themes.
|
||||
|
||||
## Contribution
|
||||
### Setting Up
|
||||
First, ensure that your project is set up to use TypeScript and ESM syntax. This guide assumes you have a basic understanding of TypeScript and modern JavaScript development practices.
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
Start by importing the necessary tools from `@design.estate/dees-wcctools` in your main TypeScript file.
|
||||
|
||||
## Contribution
|
||||
```typescript
|
||||
import { setupWccTools } from '@design.estate/dees-wcctools';
|
||||
```
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
### Defining Custom Elements
|
||||
Define your custom elements using LitElement. Here's a simple example of an element:
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```typescript
|
||||
import { LitElement, html, customElement } from 'lit';
|
||||
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
@customElement('my-element')
|
||||
class MyElement extends LitElement {
|
||||
render() {
|
||||
return html`<p>Hello, world!</p>`;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Bootstrapping the WCCTools Dashboard
|
||||
To showcase your elements, `@design.estate/dees-wcctools` provides a handy way to bootstrap a dashboard where your elements can be registered and displayed.
|
||||
|
||||
Create a bootstrap function in your main file or a separate module:
|
||||
|
||||
```typescript
|
||||
async function bootstrapWCCTools() {
|
||||
// Define your elements here
|
||||
const elements = {
|
||||
'my-element': MyElement, // Assuming MyElement is imported
|
||||
};
|
||||
|
||||
// Optionally, define pages as functions returning Lit HTML Templates
|
||||
const pages = {
|
||||
home: () => html`<h1>Welcome to My Element Catalogue</h1>`,
|
||||
};
|
||||
|
||||
// Setup the WCCTools dashboard
|
||||
setupWccTools(elements, pages);
|
||||
}
|
||||
```
|
||||
|
||||
Call this function to initialize your catalogue:
|
||||
|
||||
```typescript
|
||||
bootstrapWCCTools();
|
||||
```
|
||||
|
||||
### Configurations and Customizations
|
||||
The `setupWccTools` function accepts two arguments: `elements` and `pages`.
|
||||
|
||||
- `elements`: An object where keys are element tags (e.g., 'my-element') and values are the corresponding class definitions.
|
||||
- `pages`: An optional object where keys are page identifiers and values are functions returning Lit HTML templates.
|
||||
|
||||
### Testing Elements
|
||||
Once the dashboard is set up, navigate to your project in a web browser. You'll see a sidebar listing all registered elements and pages. Clicking on an element name will display it in the main view, allowing you to interact with it and see it in action.
|
||||
|
||||
### Theme and Environment Testing
|
||||
The dashboard also provides options for testing your elements in different environments (e.g., desktop, tablet) and themes (light or dark). This helps ensure that your elements are versatile and adaptable to varying conditions.
|
||||
|
||||
### Expanding Your Catalogue
|
||||
To add more elements to your catalogue, simply extend the `elements` object and rerun `bootstrapWCCTools()`. This modular approach makes it easy to maintain and expand your element catalogue.
|
||||
|
||||
### Leveraging TypeScript
|
||||
Using TypeScript allows you to enforce typing and build more reliable web components. Define properties with decorators, and use TypeScript's features to enhance your component development process.
|
||||
|
||||
```typescript
|
||||
import { LitElement, property, html, customElement } from 'lit';
|
||||
|
||||
@customElement('typed-element')
|
||||
class TypedElement extends LitElement {
|
||||
@property({type: String})
|
||||
name: string = 'World';
|
||||
|
||||
render() {
|
||||
return html`<p>Hello, ${this.name}!</p>`;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Conclusion
|
||||
`@design.estate/dees-wcctools` provides a powerful, flexible platform for developing, showcasing, and testing web components. By leveraging modern development practices like TypeScript and LitElement, you can build a robust catalogue of reusable web components ready for any project.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**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 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, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require 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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user