Compare commits

..

6 Commits

Author SHA1 Message Date
9c85ad8b43 v2.1.6
Some checks failed
Default (tags) / security (push) Failing after 1s
Default (tags) / test (push) Failing after 1s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-01-27 13:57:49 +00:00
fe2f80ed7f fix(docs, deps, tests): update README with expanded usage docs and examples; bump devDependencies and dees-domtools; fix test import path 2026-01-27 13:57:49 +00:00
766858d2f1 v2.1.5
Some checks failed
Default (tags) / security (push) Failing after 18s
Default (tags) / test (push) Failing after 14s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-01-04 15:43:31 +00:00
3f2ecbc7fa fix(build): bump @design.estate/dees-domtools to ^2.3.7 and remove experimentalDecorators and useDefineForClassFields from tsconfig.json 2026-01-04 15:43:31 +00:00
7892be0707 v2.1.4
Some checks failed
Default (tags) / security (push) Failing after 20s
Default (tags) / test (push) Failing after 15s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-01-04 14:38:54 +00:00
adbf910993 fix(build): update dev and runtime dependencies, export additional lit directives, switch test export to default, convert class properties to accessors, and update npmextra configuration 2026-01-04 14:38:54 +00:00
10 changed files with 2095 additions and 5122 deletions

View File

@@ -1,5 +1,29 @@
# Changelog
## 2026-01-27 - 2.1.6 - fix(docs, deps, tests)
update README with expanded usage docs and examples; bump devDependencies and dees-domtools; fix test import path
- Bumped devDependencies: @git.zone/tsbuild -> ^4.1.2, @git.zone/tsbundle -> ^2.8.3, @git.zone/tstest -> ^3.1.8, @types/node -> ^25.0.10
- Bumped dependency @design.estate/dees-domtools -> ^2.3.8
- README rewritten/expanded: more complete usage examples, theme management (cssManager) docs, directives reference, lifecycle helpers, install and issue reporting guidance
- Test fix: updated import to use @git.zone/tstest/tapbundle instead of @push.rocks/tapbundle
## 2026-01-04 - 2.1.5 - fix(build)
bump @design.estate/dees-domtools to ^2.3.7 and remove experimentalDecorators and useDefineForClassFields from tsconfig.json
- Bumped @design.estate/dees-domtools from ^2.3.6 to ^2.3.7.
- Removed "experimentalDecorators" and "useDefineForClassFields" compiler options from tsconfig.json.
## 2026-01-04 - 2.1.4 - fix(build)
update dev and runtime dependencies, export additional lit directives, switch test export to default, convert class properties to accessors, and update npmextra configuration
- Bump devDependencies: @git.zone/tsbuild -> ^4.0.2, @git.zone/tsbundle -> ^2.6.3, @git.zone/tstest -> ^3.1.4, @types/node -> ^25.0.3
- Bump runtime deps: @design.estate/dees-domtools -> ^2.3.6, lit -> ^3.3.2
- Change test script to run tstest in verbose mode and export default tap.start() in test entry
- Convert DeesElement properties to use 'accessor' syntax and make domtools non-optional in type
- Add exports for lit directives keyed and repeat in directives index
- Update packageManager to pnpm@10.27.0 and adjust npmextra.json: rename keys, add release registries and accessLevel
## 2025-11-16 - 2.1.3 - fix(CssManager)
Make CssManager a singleton and export the shared instance via getSingleton; update tests and dependencies

View File

@@ -1,5 +1,5 @@
{
"gitzone": {
"@git.zone/cli": {
"projectType": "npm",
"module": {
"githost": "code.foss.global",
@@ -21,13 +21,19 @@
"reactive programming",
"DOM manipulation"
]
},
"release": {
"registries": [
"https://verdaccio.lossless.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdoc": {
"@git.zone/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"
},
"@ship.zone/szci": {
"npmGlobalTools": []
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "@design.estate/dees-element",
"version": "2.1.3",
"version": "2.1.6",
"private": false,
"description": "A library for creating custom elements extending the lit element class with additional functionalities.",
"main": "dist_ts/index.js",
@@ -9,22 +9,21 @@
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/ --web)",
"test": "(tstest test/ --verbose)",
"build": "(tsbuild tsfolders --web --allowimplicitany && tsbundle npm)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.7.1",
"@git.zone/tsbundle": "^2.5.1",
"@git.zone/tstest": "^2.7.0",
"@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^22.14.1"
"@git.zone/tsbuild": "^4.1.2",
"@git.zone/tsbundle": "^2.8.3",
"@git.zone/tstest": "^3.1.8",
"@types/node": "^25.0.10"
},
"dependencies": {
"@design.estate/dees-domtools": "^2.3.3",
"@design.estate/dees-domtools": "^2.3.8",
"@push.rocks/isounique": "^1.0.5",
"@push.rocks/smartrx": "^3.0.10",
"lit": "^3.3.1"
"lit": "^3.3.2"
},
"browserslist": [
"last 1 chrome versions"
@@ -53,5 +52,5 @@
"reactive programming",
"DOM manipulation"
],
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
"packageManager": "pnpm@10.27.0"
}

6868
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

270
readme.md
View File

@@ -1,167 +1,281 @@
# @design.estate/dees-element
a custom element class extending lit element class
A powerful custom element base class that extends Lit's `LitElement` with integrated theming, responsive CSS utilities, RxJS-powered directives, and DOM tooling — so you can build web components that look great and stay reactive out of the box.
## Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://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/](https://code.foss.global/) account to submit Pull Requests directly.
## Install
To install `@design.estate/dees-element`, you need to run the following command using npm:
```bash
npm install @design.estate/dees-element
# or
pnpm 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.
This package ships as ESM and is written in TypeScript. Make sure your project targets ES2022+ with a modern module resolution strategy (e.g. `NodeNext`).
## Usage
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.
Everything you need is exported from the main entry point:
`@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.
```typescript
import {
DeesElement,
customElement,
property,
state,
html,
css,
cssManager,
directives,
} from '@design.estate/dees-element';
```
### Getting Started
### 🧱 Creating a Custom Element
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:
#### Define a Custom Element
Create a file named `MyElement.ts`:
Extend `DeesElement` and apply the `@customElement` decorator:
```typescript
import { DeesElement, customElement, html, css, cssManager } from '@design.estate/dees-element';
@customElement('my-element')
class MyElement extends DeesElement {
render() {
return html`<div>My Custom Element</div>`;
}
}
```
This code snippet defines a custom element `<my-element>` that renders a simple div. `DeesElement` extends the LitElement class, bringing in all of its reactive rendering capabilities along with additional features that `@design.estate/dees-element` offers.
#### Styling the Element
To style the element, utilize the static `styles` property:
```typescript
@customElement('my-styled-element')
class MyStyledElement extends DeesElement {
@customElement('my-button')
class MyButton extends DeesElement {
static styles = [
cssManager.defaultStyles,
css`
div {
color: blue;
padding: 16px;
border: 1px solid blue;
.btn {
padding: 8px 16px;
border-radius: 4px;
background: ${cssManager.bdTheme('#0060df', '#3a8fff')};
color: ${cssManager.bdTheme('#fff', '#fff')};
border: none;
cursor: pointer;
}
`,
];
render() {
return html`<div>A Styled Custom Element</div>`;
return html`<button class="btn"><slot></slot></button>`;
}
}
```
The `css` template tag allows you to define CSS styles scoped to your custom element.
That single `bdTheme()` call generates a CSS variable that automatically flips between the bright and dark values when the user's theme changes — no manual toggling needed.
#### Leveraging the `cssManager` for Theme Management
### 🎨 Theme Management with `cssManager`
`@design.estate/dees-element` introduces a powerful `CssManager` class that facilitates dynamic theming and responsive designs:
The singleton `cssManager` is the central hub for theming and responsive layout:
| Method | Purpose |
|---|---|
| `cssManager.defaultStyles` | Base styles for consistent element rendering |
| `cssManager.bdTheme(bright, dark)` | Returns a `CSSResult` that auto-switches between bright/dark values |
| `cssManager.cssForDesktop(css)` | Media-query wrapper for desktop breakpoints |
| `cssManager.cssForNotebook(css)` | Media-query wrapper for notebook breakpoints |
| `cssManager.cssForTablet(css)` | Media-query wrapper for tablet breakpoints |
| `cssManager.cssForPhablet(css)` | Media-query wrapper for phablet breakpoints |
| `cssManager.cssForPhone(css)` | Media-query wrapper for phone breakpoints |
| `cssManager.cssGridColumns(cols, gap)` | Generates CSS grid column widths |
Example — responsive + themed styles:
```typescript
import { cssManager, DeesElement, customElement, html, css } from '@design.estate/dees-element';
@customElement('themed-element')
class ThemedElement extends DeesElement {
@customElement('my-card')
class MyCard extends DeesElement {
static styles = [
cssManager.defaultStyles,
css`
:host {
display: block;
background-color: var(--theme-background-color, #fff);
padding: 16px;
background: ${cssManager.bdTheme('#ffffff', '#1e1e1e')};
color: ${cssManager.bdTheme('#111', '#eee')};
border-radius: 8px;
}
`,
cssManager.cssForPhone(css`
:host { padding: 8px; }
`),
];
constructor() {
super();
cssManager.bdTheme('#fff', '#000'); // Define themes
}
render() {
return html`<div>A Themed Custom Element</div>`;
return html`<slot></slot>`;
}
}
```
The `CssManager` allows easy management of themes, breakpoints, and more, ensuring your custom elements remain consistent and responsive across different devices and themes.
### ⚡ Reactive Properties & State
### Reactive Properties and State Management
To make your elements interactive and data-driven, `@design.estate/dees-element` offers a seamless approach to managing properties and internal state:
Use the standard Lit decorators, re-exported for convenience:
```typescript
@customElement('interactive-element')
class InteractiveElement extends DeesElement {
@property({ type: String }) labelText = 'Click me';
import { DeesElement, customElement, property, state, html } from '@design.estate/dees-element';
@state() private count = 0;
@customElement('my-counter')
class MyCounter extends DeesElement {
@property({ type: String })
accessor label = 'Count';
@state()
accessor count = 0;
render() {
return html`
<button @click="${this.incrementCount}">${this.labelText}: ${this.count}</button>
<button @click=${() => this.count++}>
${this.label}: ${this.count}
</button>
`;
}
incrementCount() {
this.count++;
}
}
```
Here, `@property` and `@state` decorators are used to reactively update your custom element whenever the internal state or properties change.
> **Note:** This library uses the TC39 standard decorators with the `accessor` keyword for decorated class properties.
### Advanced Scenarios: Directives and Async Data
### 🔄 Theme Change Callbacks
`@design.estate/dees-element` supports Lit's directives for handling asynchronous data, complex rendering conditions, and more. Here's an example using the `resolve` directive to render content asynchronously:
`DeesElement` tracks the current theme via the `goBright` property and exposes an optional `themeChanged` callback:
```typescript
import { resolve } from '@design.estate/dees-element';
@customElement('theme-aware')
class ThemeAware extends DeesElement {
protected themeChanged(goBright: boolean) {
console.log(goBright ? 'Switched to bright' : 'Switched to dark');
}
@customElement('async-element')
class AsyncElement extends DeesElement {
private fetchData() {
return new Promise((resolve) => {
setTimeout(() => resolve('Data Loaded'), 2000);
render() {
return html`<p>Current theme: ${this.goBright ? 'bright' : 'dark'}</p>`;
}
}
```
### 🚀 Lifecycle Helpers
`DeesElement` adds lifecycle utilities on top of LitElement:
```typescript
@customElement('my-widget')
class MyWidget extends DeesElement {
constructor() {
super();
// Runs once after the element is connected to the DOM
this.registerStartupFunction(async () => {
console.log('Widget connected!');
});
// Runs when the element is disconnected — perfect for cleanup
this.registerGarbageFunction(() => {
console.log('Widget removed');
});
}
render() {
return html`${resolve(this.fetchData())}`;
return html`<p>Hello World</p>`;
}
}
```
This example demonstrates how to render async data efficiently, ensuring your custom elements can handle dynamic content and states gracefully.
Additionally, `this.elementDomReady` is a promise that resolves after `firstUpdated`, which is handy when you need to wait for the initial render:
### Conclusion
```typescript
await this.elementDomReady;
// The element's shadow DOM is now fully rendered
```
`@design.estate/dees-element` enriches the development experience for building custom elements by extending the capabilities of LitElement. Through thoughtful design choices, such as enhanced theming with `CssManager` and the incorporation of useful plugins and decorators, it facilitates a seamless and powerful approach to developing custom web components.
### 📡 Directives
The `directives` namespace includes powerful template helpers, accessible via `directives.*`:
#### `resolve` — Render a Promise
```typescript
import { html, directives } from '@design.estate/dees-element';
render() {
return html`${directives.resolve(this.fetchData())}`;
}
```
#### `resolveExec` — Resolve a lazy async function
```typescript
render() {
return html`${directives.resolveExec(() => this.loadContent())}`;
}
```
#### `subscribe` — Render an RxJS Observable
```typescript
import { html, directives } from '@design.estate/dees-element';
render() {
return html`<span>${directives.subscribe(this.count$)}</span>`;
}
```
#### `subscribeWithTemplate` — Observable + template transform
```typescript
render() {
return html`
${directives.subscribeWithTemplate(
this.items$,
(items) => html`<ul>${items.map(i => html`<li>${i}</li>`)}</ul>`
)}
`;
}
```
#### Re-exported Lit directives
The directives namespace also re-exports these commonly used Lit directives:
- `until` — render a placeholder while a promise resolves
- `asyncAppend` — append values from an async iterable
- `keyed` — force re-creation of a template when a key changes
- `repeat` — efficiently render lists with identity tracking
### 📦 Full Export Reference
| Export | Description |
|---|---|
| `DeesElement` | Base class for custom elements |
| `CssManager` | CSS/theme management class |
| `cssManager` | Singleton `CssManager` instance |
| `customElement` | Class decorator to register elements |
| `property` | Reactive property decorator |
| `state` | Internal state decorator |
| `query`, `queryAll`, `queryAsync` | Shadow DOM query decorators |
| `html` | Lit html template tag |
| `css` | Lit css template tag |
| `unsafeCSS` | Create `CSSResult` from a string |
| `unsafeHTML` | Render raw HTML in templates |
| `render` | Lit render function |
| `static` / `unsafeStatic` | Static html template helpers |
| `domtools` | DOM tooling utilities |
| `directives` | All directives (resolve, subscribe, etc.) |
| `rxjs` (type) | RxJS type re-export |
## 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.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./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 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.
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
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.
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.

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as deesElement from '../ts/index.js';
tap.test('should create a static element', async () => {
@@ -21,4 +21,4 @@ tap.test('should create a static element', async () => {
}
});
tap.start();
export default tap.start();

View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@design.estate/dees-element',
version: '2.1.3',
version: '2.1.6',
description: 'A library for creating custom elements extending the lit element class with additional functionalities.'
}

View File

@@ -3,13 +3,13 @@ import * as plugins from './plugins.js';
export class DeesElement extends plugins.lit.LitElement {
// INSTANCE
@plugins.lit.property({ type: Boolean })
public goBright: boolean = false;
public accessor goBright: boolean = false;
// domtools
public domtoolsPromise: Promise<plugins.domtools.DomTools>;
@plugins.lit.property()
domtools?: plugins.domtools.DomTools;
public accessor domtools: plugins.domtools.DomTools;
public rxSubscriptions: plugins.smartrx.rxjs.Subscription[] = [];
private themeSubscription: plugins.smartrx.rxjs.Subscription;

View File

@@ -7,3 +7,5 @@ export { subscribeWithTemplate } from './classes.subscribewithtemplate.js';
export { until } from 'lit/directives/until.js';
export { asyncAppend } from 'lit/directives/async-append.js';
export { keyed } from 'lit/directives/keyed.js';
export { repeat } from 'lit/directives/repeat.js';

View File

@@ -1,7 +1,5 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",