update documentation

2024-04-20 23:18:09 +02:00 · 2024-04-20 23:18:09 +02:00 · de1532627d
commit de1532627d
parent 618b6c5ba0
5 changed files with 151 additions and 33 deletions
--- a/npmextra.json
+++ b/npmextra.json
@ -2,17 +2,36 @@
  "gitzone": {
    "projectType": "npm",
    "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
      "gitscope": "design.estate",
      "gitrepo": "dees-domtools",
-      "description": "tools to simplify complex css structures",
+      "description": "A package providing tools to simplify complex CSS structures and web development tasks, featuring TypeScript support and integration with various web technologies.",
      "npmPackagename": "@design.estate/dees-domtools",
      "license": "MIT",
-      "projectDomain": "design.estate"
+      "projectDomain": "design.estate",
+      "keywords": [
+        "CSS tools",
+        "web development",
+        "TypeScript support",
+        "CSS structure simplification",
+        "web components",
+        "theme management",
+        "DOM manipulation",
+        "responsive design",
+        "design system",
+        "lit element",
+        "keyboard event handling",
+        "state management",
+        "routing",
+        "performance optimization"
+      ]
    }
  },
  "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"
  }
 }
--- a/package.json
+++ b/package.json
@ -2,7 +2,7 @@
  "name": "@design.estate/dees-domtools",
  "version": "2.0.57",
  "private": false,
-  "description": "tools to simplify complex css structures",
+  "description": "A package providing tools to simplify complex CSS structures and web development tasks, featuring TypeScript support and integration with various web technologies.",
  "main": "dist_ts/index.js",
  "typings": "dist_ts/index.d.ts",
  "type": "module",
@ -54,5 +54,21 @@
  ],
  "browserslist": [
    "last 1 chrome versions"
+  ],
+  "keywords": [
+    "CSS tools",
+    "web development",
+    "TypeScript support",
+    "CSS structure simplification",
+    "web components",
+    "theme management",
+    "DOM manipulation",
+    "responsive design",
+    "design system",
+    "lit element",
+    "keyboard event handling",
+    "state management",
+    "routing",
+    "performance optimization"
  ]
-}
+}
--- a/readme.hints.md
+++ b/readme.hints.md
@ -0,0 +1 @@
+ 
--- a/readme.md
+++ b/readme.md
@ -1,37 +1,116 @@
-# @designestate/dees-domtools
+# @design.estate/dees-domtools
 tools to simplify complex css structures

-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@designestate/dees-domtools)
-* [gitlab.com (source)](https://gitlab.com/designestate/dees-domtools)
-* [github.com (source mirror)](https://github.com/designestate/dees-domtools)
-* [docs (typedoc)](https://designestate.gitlab.io/dees-domtools/)
+## Install

-## Status for master
+To install `@design.estate/dees-domtools`, simply use npm:

-Status Category | Status Badge
-- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/designestate/dees-domtools/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/designestate/dees-domtools/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@designestate/dees-domtools)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/designestate/dees-domtools)](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-domtools)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@designestate/dees-domtools)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@designestate/dees-domtools)](https://lossless.cloud)
+```bash
+npm install --save @design.estate/dees-domtools
+```
+
+Ensure your project supports TypeScript and ESM syntax for the best development experience.

 ## Usage

-Use TypeScript for best in class intellisense
+This documentation aims to give you comprehensive guidance on how to utilize `@design.estate/dees-domtools` in your web projects to simplify complex CSS structures. Whether you're building a sophisticated web application or need a more manageable way to handle your CSS, this toolkit offers a variety of features designed to enhance and streamline your workflow. Throughout this guide, we'll cover the installation process, key features, examples, and best practices when working with `@design.estate/dees-domtools`.

-## Contribution
+Before diving into the examples, please ensure that you've completed the installation step as described above.

-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). :)
+### Key Features

-For further information read the linked docs at the top of this readme.
+- **CSS Simplification**: Tools and utilities designed to abstract and simplify the handling of complex CSS structures.
+- **Responsive Design Helpers**: Tools for managing responsive designs more easily, with utilities for breakpoints, and adaptable grids.
+- **Element Utilities**: Simplified interactions with DOM elements, including dynamic style manipulations and more.
+- **Theme Management**: Simplify the process of theme toggling (dark mode/light mode) in your applications.
+- **Keyboard Event Handling**: Utilities for managing keyboard events, facilitating better interaction handling.
+- **External Resources Management**: Easily manage external CSS and JavaScript resources within your project.

-## Legal
-> MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+### Getting Started
+
+To get started with `@design.estate/dees-domtools`, you first need to import the modules you intend to use in your project. Here's a simple example to illustrate how to import and use the package:
+
+```typescript
+import { DomTools, elementBasic, breakpoints, css } from '@design.estate/dees-domtools';
+
+// Setting up DomTools for your application
+const domToolsInstance = await DomTools.setupDomTools();
+
+// Example: Using elementBasic utilities
+elementBasic.setup();
+```
+
+### Simplifying CSS with CSS Utilities
+
+The package offers a variety of CSS utilities that simplify the handling of complex CSS structures. Here's how you can use them in your project:
+
+```typescript
+import { css } from '@design.estate/dees-domtools';
+
+// Example: Creating a CSS grid with a specified number of columns and gap size
+const gridStyles = css.cssGridColumns(3, 10); // 3 columns with a 10px gap
+```
+
+### Managing Responsive Design
+
+Responsive design is critical for modern web development. `@design.estate/dees-domtools` provides utilities to make it easier to manage responsive designs and breakpoints.
+
+```typescript
+import { breakpoints } from '@design.estate/dees-domtools';
+
+// Example: Applying styles for different viewport sizes
+const tabletStyles = breakpoints.cssForTablet(myCssStyles);
+const phoneStyles = breakpoints.cssForPhone(myCssStyles);
+```
+
+### Theme Management
+
+Managing themes (such as toggling between dark and light mode) is simplified with the built-in theme management tools.
+
+```typescript
+// Toggle between light and dark themes
+domToolsInstance.themeManager.toggleDarkBright();
+```
+
+### Handling Keyboard Events
+
+Keyboard event handling is made easy with the utilities provided by the toolkit. This can be particularly useful for adding keyboard navigation and shortcuts.
+
+```typescript
+import { Keyboard } from '@design.estate/dees-domtools';
+
+// Initialize keyboard handling
+const keyboard = new Keyboard(document.body);
+
+// Bind an event to a specific key combination
+keyboard.on([Keyboard.Key.Ctrl, Keyboard.Key.S]).subscribe(() => {
+  console.log('Ctrl+S was pressed');
+});
+```
+
+### Best Practices
+
+- **Organize Your CSS**: Use the provided CSS utilities to structure your styles in a way that makes them easy to maintain and scale.
+- **Embrace Responsiveness**: Leverage the responsive design helpers to ensure your application looks great on any device.
+- **Consistent Theme Handling**: Utilize the theme management tools to provide a seamless experience for your users, allowing them to choose their preferred theme.
+
+By integrating `@design.estate/dees-domtools` into your project, you can leverage a comprehensive suite of utilities designed to simplify complex CSS structures and enhance your web development workflow.
+
+## 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.
--- a/tsconfig.json
+++ b/tsconfig.json
@ -6,6 +6,9 @@
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "esModuleInterop": true,
-    "verbatimModuleSyntax": true,
-  }
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }