diff --git a/npmextra.json b/npmextra.json index cfe91d3..9c88781 100644 --- a/npmextra.json +++ b/npmextra.json @@ -2,17 +2,32 @@ "gitzone": { "projectType": "npm", "module": { - "githost": "gitlab.com", + "githost": "code.foss.global", "gitscope": "designestate", "gitrepo": "dees-element", - "description": "a custom element class extending lit element class", + "description": "A library for creating custom elements extending the lit element class with additional functionalities.", "npmPackagename": "@designestate/dees-element", "license": "MIT", - "projectDomain": "design.estate" + "projectDomain": "design.estate", + "keywords": [ + "custom elements", + "lit", + "TypeScript", + "CSS manager", + "themes", + "decorators", + "async directive", + "web components", + "reactive programming", + "DOM manipulation" + ] } }, "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" } } \ No newline at end of file diff --git a/package.json b/package.json index d0b0ba6..e369a8c 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@design.estate/dees-element", "version": "2.0.34", "private": false, - "description": "a custom element class extending lit element class", + "description": "A library for creating custom elements extending the lit element class with additional functionalities.", "main": "dist_ts/index.js", "typings": "dist_ts/index.d.ts", "type": "module", @@ -40,5 +40,17 @@ "cli.js", "npmextra.json", "readme.md" + ], + "keywords": [ + "custom elements", + "lit", + "TypeScript", + "CSS manager", + "themes", + "decorators", + "async directive", + "web components", + "reactive programming", + "DOM manipulation" ] -} +} \ No newline at end of file diff --git a/readme.hints.md b/readme.hints.md new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/readme.hints.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/readme.md b/readme.md index ff3ee14..eda8a75 100644 --- a/readme.md +++ b/readme.md @@ -1,37 +1,167 @@ -# @designestate/dees-element +# @design.estate/dees-element a custom element class extending lit element class -## Availabililty and Links -* [npmjs.org (npm package)](https://www.npmjs.com/package/@designestate/dees-element) -* [gitlab.com (source)](https://gitlab.com/designestate/dees-element) -* [github.com (source mirror)](https://github.com/designestate/dees-element) -* [docs (typedoc)](https://designestate.gitlab.io/dees-element/) +## Install -## Status for master +To install `@design.estate/dees-element`, you need to run the following command using npm: -Status Category | Status Badge --- | -- -GitLab Pipelines | [![pipeline status](https://gitlab.com/designestate/dees-element/badges/master/pipeline.svg)](https://lossless.cloud) -GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/designestate/dees-element/badges/master/coverage.svg)](https://lossless.cloud) -npm | [![npm downloads per month](https://badgen.net/npm/dy/@designestate/dees-element)](https://lossless.cloud) -Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/designestate/dees-element)](https://lossless.cloud) -TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud) -node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) -Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud) -PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@designestate/dees-element)](https://lossless.cloud) -PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@designestate/dees-element)](https://lossless.cloud) -BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@designestate/dees-element)](https://lossless.cloud) +```bash +npm install @design.estate/dees-element +``` + +Ensure you have TypeScript and the necessary compilers configured in your development environment since this package uses ESM syntax and TypeScript. ## Usage -Use TypeScript for best in class intellisense +This section provides a comprehensive exploration into the usage of `@design.estate/dees-element`, offering examples to illustrate its capabilities in creating custom elements by extending the lit element class. All examples assume the use of ESM syntax and TypeScript, aligning with modern best practices in web development. -## Contribution +`@design.estate/dees-element` serves as a robust foundation for building custom web components, leveraging the power of the Lit library for reactive updates and efficient rendering management. This guide takes you through the process of creating, styling, and interacting with your custom elements. -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). :) +### Getting Started -For further information read the linked docs at the top of this readme. +Firstly, ensure you have installed the package as described in the installation section. Once installed, you can start creating custom elements. Let's begin with a simple example: -## 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) +#### Define a Custom Element + +Create a file named `MyElement.ts`: + +```typescript +import { DeesElement, customElement, html, css, cssManager } from '@design.estate/dees-element'; + +@customElement('my-element') +class MyElement extends DeesElement { + render() { + return html`