Compare commits

...

91 Commits

Author SHA1 Message Date
f7bc113b6c 1.0.91
Some checks failed
Default (tags) / security (push) Failing after 52s
Default (tags) / test (push) Failing after 27s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-06-16 13:18:55 +00:00
05934132a7 feat(demo): add DeesDemoWrapper component for enhanced demo element handling 2025-06-16 13:18:13 +00:00
6bdb8c78b7 fix(properties): enhance element detection in properties panel with recursive search and retry mechanism 2025-06-16 13:10:12 +00:00
fca47b87fb Refactor code structure for improved readability and maintainability 2025-06-16 12:30:12 +00:00
595620af4b 1.0.90 2024-05-07 01:38:47 +02:00
8c3a116943 fix(core): update 2024-05-07 01:38:46 +02:00
269b90c64c 1.0.89 2024-05-07 01:38:11 +02:00
6d74bdfb51 fix(core): update 2024-05-07 01:38:11 +02:00
6aa1e9bc2a 1.0.88 2024-05-07 01:32:45 +02:00
3f83bb9fba fix(core): update 2024-05-07 01:32:45 +02:00
57bbca6b28 update documentation 2024-04-20 23:19:59 +02:00
51382611cf 1.0.87 2024-01-17 13:36:37 +01:00
3094c0b815 fix(core): update 2024-01-17 13:36:37 +01:00
f5273b6b82 1.0.86 2024-01-17 13:34:34 +01:00
9c51d93418 fix(core): update 2024-01-17 13:34:33 +01:00
5a769ef7e2 1.0.85 2023-12-10 16:30:18 +01:00
8f71d1afde fix(core): update 2023-12-10 16:30:17 +01:00
6f7dace5da 1.0.84 2023-12-10 16:22:01 +01:00
4008a5ab62 fix(core): update 2023-12-10 16:22:01 +01:00
13f1d4698f 1.0.83 2023-12-10 16:21:09 +01:00
d93e183db1 fix(core): update 2023-12-10 16:21:08 +01:00
bff3b1f567 1.0.82 2023-12-10 16:20:32 +01:00
39fb873aec fix(core): update 2023-12-10 16:20:31 +01:00
a2f2605241 1.0.81 2023-10-08 13:11:01 +02:00
8dfb876988 fix(core): update 2023-10-08 13:11:00 +02:00
5db7fc9a3b 1.0.80 2023-10-05 14:26:47 +02:00
690b85f057 fix(core): update 2023-10-05 14:26:46 +02:00
eea091cb56 1.0.79 2023-10-05 14:25:40 +02:00
8d725ef303 fix(core): update 2023-10-05 14:25:39 +02:00
4aa2708f24 1.0.78 2023-08-07 18:54:39 +02:00
d1848f31a7 fix(core): update 2023-08-07 18:54:39 +02:00
5aba0a7fa5 1.0.77 2023-08-07 18:20:17 +02:00
134774b870 fix(core): update 2023-08-07 18:20:17 +02:00
43897f0fb5 1.0.76 2023-01-07 14:14:12 +01:00
2e57176dcc fix(core): update 2023-01-07 14:14:12 +01:00
d1fe66f1ba 1.0.75 2023-01-07 14:05:26 +01:00
8ea7c53154 fix(core): update 2023-01-07 14:05:25 +01:00
ea0858fd27 1.0.74 2022-04-14 16:56:04 +02:00
03c00919df fix(core): update 2022-04-14 16:56:04 +02:00
6917145b58 1.0.73 2022-03-24 18:30:55 +01:00
2e2ad98ed8 fix(core): update 2022-03-24 18:30:54 +01:00
68375a5e58 1.0.72 2022-03-24 17:08:26 +01:00
5876225b39 fix(core): update 2022-03-24 17:08:25 +01:00
342ac96429 1.0.71 2022-03-24 16:14:12 +01:00
85a472fe1c fix(core): update 2022-03-24 16:14:12 +01:00
4fecae83dc 1.0.70 2022-03-24 15:53:03 +01:00
b7a666ac66 fix(core): update 2022-03-24 15:53:02 +01:00
e559ed072c 1.0.69 2022-03-24 15:39:18 +01:00
c44d9e7365 fix(core): update 2022-03-24 15:39:17 +01:00
53f53be991 1.0.68 2022-03-04 10:24:04 +01:00
9dec6e25b5 fix(core): update 2022-03-04 10:24:03 +01:00
03fa323eb9 1.0.67 2022-03-02 20:01:15 +01:00
e0344bb513 fix(core): update 2022-03-02 20:01:14 +01:00
a6f583b8c4 1.0.66 2021-11-26 19:18:14 +01:00
60e173b7be fix(core): update 2021-11-26 19:18:14 +01:00
d51027d4be 1.0.65 2021-11-26 19:16:09 +01:00
2efa465930 fix(core): update 2021-11-26 19:16:09 +01:00
19081caacd 1.0.64 2021-11-26 19:05:05 +01:00
c42e8b8bef fix(core): update 2021-11-26 19:05:04 +01:00
750e8cef32 1.0.63 2021-11-26 18:52:44 +01:00
c0d057949d fix(core): update 2021-11-26 18:52:44 +01:00
82a5283edd 1.0.62 2021-11-26 18:27:29 +01:00
abb20def4b fix(core): update 2021-11-26 18:27:29 +01:00
dd71751864 1.0.61 2021-11-26 17:53:05 +01:00
c4562c797e fix(core): update 2021-11-26 17:53:04 +01:00
643317811b 1.0.60 2021-11-26 17:47:09 +01:00
3667070094 fix(core): update 2021-11-26 17:47:08 +01:00
a86ef5bfce 1.0.59 2021-09-27 14:45:06 +02:00
77d058f403 fix(core): update 2021-09-27 14:45:05 +02:00
1639a57bd1 1.0.58 2021-09-27 13:30:03 +02:00
b546d1a2c5 fix(core): update 2021-09-27 13:30:02 +02:00
5639c152a2 1.0.57 2021-04-02 09:55:15 +00:00
05a093f080 fix(core): update 2021-04-02 09:55:15 +00:00
08156b2d47 1.0.56 2021-04-01 19:11:24 +00:00
0b119c481c fix(core): update 2021-04-01 19:11:23 +00:00
bf4ef900f8 1.0.55 2021-04-01 19:09:57 +00:00
a812a12c10 fix(core): update 2021-04-01 19:09:57 +00:00
71e885f3e4 1.0.54 2020-12-09 18:35:49 +00:00
57bc2b76bc fix(core): update 2020-12-09 18:35:49 +00:00
f21a20b652 1.0.53 2020-12-09 18:32:12 +00:00
91b9c424d8 fix(core): update 2020-12-09 18:32:11 +00:00
5cf4752ad9 1.0.52 2020-12-07 04:20:30 +00:00
5f347153fc fix(core): update 2020-12-07 04:20:29 +00:00
e1aebc7db8 1.0.51 2020-12-07 04:07:32 +00:00
97b88d965c fix(core): update 2020-12-07 04:07:32 +00:00
37d343da03 1.0.50 2020-12-07 04:07:03 +00:00
47cb726716 fix(core): update 2020-12-07 04:07:03 +00:00
4220131bc4 1.0.49 2020-11-30 00:50:48 +00:00
edee4fa446 fix(core): update 2020-11-30 00:50:47 +00:00
c2a0fd26e2 1.0.48 2020-11-30 00:45:42 +00:00
693c8ca3f0 fix(core): update 2020-11-30 00:45:41 +00:00
33 changed files with 7720 additions and 11060 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,137 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
} }
] ]
} }

View File

@ -1,5 +1,5 @@
<!--gitzone element--> <!--gitzone element-->
<!-- made by Lossless GmbH --> <!-- made by Task Venture Capital GmbH -->
<!-- checkout https://maintainedby.lossless.com for awesome OpenSource projects --> <!-- checkout https://maintainedby.lossless.com for awesome OpenSource projects -->
<html lang="en"> <html lang="en">
<head> <head>
@ -10,6 +10,10 @@
/> />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!--Lets load standard fonts-->
<link rel="preconnect" href="https://assetbroker.lossless.one/" crossorigin>
<link rel="stylesheet" href="https://assetbroker.lossless.one/fonts/fonts.css">
<style> <style>
body { body {
margin: 0px; margin: 0px;
@ -17,7 +21,7 @@
} }
</style> </style>
<script src="./index.ts"></script> <script type="module" src="/bundle.js"></script>
</head> </head>
<body> <body>
</body> </body>

View File

@ -1,10 +1,10 @@
// dees tools // dees tools
import * as deesWccTools from '../ts_web'; import * as deesWccTools from '../ts_web/index.js';
import * as deesDomTools from '@designestate/dees-domtools'; import * as deesDomTools from '@design.estate/dees-domtools';
// elements and pages // elements and pages
import * as elements from '../test/elements'; import * as elements from '../test/elements/index.js';
import * as pages from '../test/pages'; import * as pages from '../test/pages/index.js';
deesWccTools.setupWccTools(elements as any, pages); deesWccTools.setupWccTools(elements as any, pages);
deesDomTools.elementBasic.setup(); deesDomTools.elementBasic.setup();

View File

@ -2,17 +2,32 @@
"gitzone": { "gitzone": {
"projectType": "wcc", "projectType": "wcc",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "designestate", "gitscope": "designestate",
"gitrepo": "dees-wcctools", "gitrepo": "dees-wcctools",
"shortDescription": "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", "npmPackagename": "@designestate/dees-wcctools",
"license": "MIT", "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": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "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"
} }
} }

10567
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,34 +1,34 @@
{ {
"name": "@designestate/dees-wcctools", "name": "@design.estate/dees-wcctools",
"version": "1.0.47", "version": "1.0.91",
"private": false, "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", "exports": {
"typings": "dist_ts_web/index.d.ts", ".": "./dist_ts_web/index.js",
"./demoTools": "./dist_ts_demotools"
},
"type": "module",
"scripts": { "scripts": {
"test": "(npm run build)", "test": "(npm run build)",
"build": "(tsbuild custom ts_web --web && tsbundle element)", "build": "(tsbuild tsfolders --allowimplicitany && tsbundle element)",
"watch": "tswatch element" "watch": "tswatch element",
"buildDocs": "tsdoc"
}, },
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "UNLICENSED", "license": "UNLICENSED",
"dependencies": { "dependencies": {
"@designestate/dees-domtools": "^1.0.74", "@design.estate/dees-domtools": "^2.0.57",
"@designestate/dees-element": "^1.0.6", "@design.estate/dees-element": "^2.0.34",
"@gitzone/tsrun": "^1.2.12", "@push.rocks/smartdelay": "^3.0.5",
"@pushrocks/smartdelay": "^2.0.10", "lit": "^3.1.3"
"@pushrocks/smartexpress": "^3.0.97",
"lit-element": "^2.4.0",
"lit-html": "^1.3.0",
"typescript": "^4.1.2"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@api.global/typedserver": "^3.0.29",
"@gitzone/tsbundle": "^1.0.78", "@git.zone/tsbuild": "^2.1.72",
"@gitzone/tswatch": "^1.0.50", "@git.zone/tsbundle": "^2.0.15",
"@pushrocks/projectinfo": "^4.0.5", "@git.zone/tsrun": "^1.2.44",
"tslint": "^6.1.3", "@git.zone/tswatch": "^2.0.23",
"tslint-config-prettier": "^1.17.0" "@push.rocks/projectinfo": "^5.0.2"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -44,5 +44,18 @@
], ],
"browserslist": [ "browserslist": [
"last 1 Chrome versions" "last 1 Chrome versions"
] ],
"keywords": [
"web components",
"element catalogues",
"custom elements",
"documentation",
"typescript",
"lit",
"component development",
"design system",
"element testing",
"page development"
],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
} }

6691
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

51
readme.hints.md Normal file
View File

@ -0,0 +1,51 @@
# Project Hints and Findings
## Properties Panel Element Detection Issue (Fixed)
### Problem
The properties panel had timing issues detecting rendered elements because:
1. Elements are rendered asynchronously via lit's `render()` function in the dashboard component
2. The properties panel tried to find elements immediately without waiting for render completion
3. Element search only looked at direct children of the viewport, missing nested elements or those inside shadow DOM
### Solution Implemented
1. Added a 100ms initial delay to allow render completion
2. Implemented recursive element search that:
- Searches through nested children up to 5 levels deep
- Checks shadow roots of elements
- Handles complex DOM structures
3. Added retry mechanism with up to 5 attempts (200ms between retries)
4. Improved error messages to show retry count
### Code Flow
1. Dashboard renders element demo into viewport using `render(anonItem.demo(), viewport)`
2. Properties panel waits, then searches recursively for the element instance
3. If not found, retries with delays to handle async rendering
4. Once found, extracts and displays element properties
## Demo Tools
### DeesDemoWrapper Component
A utility component for wrapping demo elements with post-render functionality.
**Usage:**
```typescript
import { DeesDemoWrapper } from '@design.estate/dees-wcctools/demoTools';
// In your demo function:
demo: () => html`
<dees-demowrapper .runAfterRender=${(element) => {
// Do something with the rendered element
element.setAttribute('data-demo', 'true');
console.log('Element rendered:', element);
}}>
<my-custom-element></my-custom-element>
</dees-demowrapper>
`
```
**Features:**
- Wraps demo elements without affecting layout (uses `display: contents`)
- Provides access to the rendered element instance after mounting
- Supports async operations in runAfterRender callback
- Automatically handles timing to ensure element is fully rendered

134
readme.md
View File

@ -1,41 +1,117 @@
# @designestate/dees-wcctools # @design.estate/dees-wcctools
wcc tools for creating element catalogues wcc tools for creating element catalogues
## Availabililty and Links ## Install
* [npmjs.org (npm package)](https://www.npmjs.com/package/@designestate/dees-wcctools) To install `@design.estate/dees-wcctools`, you can use npm:
* [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/)
## Status for master ```bash
npm install @design.estate/dees-wcctools --save
Status Category | Status Badge ```
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/designestate/dees-wcctools/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/designestate/dees-wcctools/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@designestate/dees-wcctools)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/designestate/dees-wcctools)](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-wcctools)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@designestate/dees-wcctools)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@designestate/dees-wcctools)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## 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';
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh) @customElement('my-element')
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) class MyElement extends LitElement {
render() {
return html`<p>Hello, world!</p>`;
}
}
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) ### 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.

41
readme.plan.md Normal file
View File

@ -0,0 +1,41 @@
# Fix Properties Panel Element Detection (COMPLETED)
To fix the element detection issue, reread CLAUDE.md first.
## Problem Analysis
The properties panel has timing issues detecting rendered elements because:
1. Elements are rendered asynchronously via lit's `render()` in the dashboard
2. Properties panel tries to find elements immediately without waiting for render completion
3. Element search only looks at direct children, missing nested/shadow DOM elements
## Implementation Plan
### 1. Add proper synchronization ✅
- Add a delay or await render completion before element detection
- Use MutationObserver or lit's updateComplete promises
### 2. Improve element search algorithm ✅
- Search recursively through all descendants, not just direct children
- Handle shadow DOM boundaries properly
- Support elements wrapped in containers
### 3. Add retry mechanism ✅
- If element not found, retry after a delay
- Add maximum retry attempts to prevent infinite loops
- Clear error state when element is eventually found
## Code Changes Required
1. Modify `wcc-properties.ts` createProperties() method ✅
2. Add element search utility function ✅
3. Improve error handling and user feedback ✅
# Demo Wrapper Implementation (COMPLETED)
## Created DeesDemoWrapper Component
- Location: ts_demotools/demotools.ts
- Allows wrapping demo elements with post-render functionality
- Provides runAfterRender callback that receives the rendered element
- Uses display: contents to not affect layout
- Handles timing automatically with 50ms delay after firstUpdated
- Supports both sync and async callbacks
- Exports available at @design.estate/dees-wcctools/demoTools

View File

@ -1 +1 @@
export * from './test-demoelement'; export * from './test-demoelement.js';

View File

@ -1,15 +1,64 @@
import { DeesElement, customElement, TemplateResult, html } from '@designestate/dees-element'; import {
DeesElement,
customElement,
type TemplateResult,
html,
property,
css,
cssManager,
} from '@design.estate/dees-element';
import * as domtools from '@designestate/dees-domtools'; import * as domtools from '@design.estate/dees-domtools';
enum ETestEnum {
'first' = 'first',
'second' = 'second',
'awesome' = 'awesome',
}
@customElement('test-demoelement') @customElement('test-demoelement')
export class TestDemoelement extends DeesElement { export class TestDemoelement extends DeesElement {
public static demo = () => html`<test-demoelement></test-demoelement>`; public static demo = () => html`<test-demoelement>This is a slot text</test-demoelement>`;
public render() { @property()
return html` public notTyped = 'hello';
<style>
.maincontainer, .themeindicator { @property({
type: String,
})
public typedAndNotInitizalized: string;
@property()
public notTypedAndNotInitizalized: string;
@property({
type: Boolean,
})
public demoBoolean = false;
@property({
type: String,
})
public demoString = 'default demo string';
@property({
type: Number,
})
public demoNumber = 2;
@property({
type: ETestEnum,
})
public demoENum: ETestEnum = ETestEnum.first;
constructor() {
super();
}
public static styles = [
css`
.maincontainer,
.themeindicator {
display: block; display: block;
padding: 10px; padding: 10px;
border-radius: 10px; border-radius: 10px;
@ -20,18 +69,43 @@ export class TestDemoelement extends DeesElement {
background: #000; background: #000;
} }
.themeindicator { .themeindicator {
color: ${this.goBright ? '#000' : '#fff'}; color: ${cssManager.bdTheme('#000', '#fff')};
background: ${this.goBright ? '#fff' : '#000'}; background: ${cssManager.bdTheme('#fff', '#000')};
} }
${domtools.breakpoints.cssForPhablet(`
.maincontainer, .themeindicator { @container wccToolsViewport size(min-width: 1px) {
.maincontainer,
.themeindicator {
border-radius: 50px;
}
}
${domtools.breakpoints.cssForPhablet(css`
.maincontainer,
.themeindicator {
border-radius: 50px; border-radius: 50px;
} }
`)} `)}
</style>
pre b {
color: green;
}
`,
];
public render() {
return html`
<style></style>
<div class="maincontainer"><slot>This is a demo element</slot></div> <div class="maincontainer"><slot>This is a demo element</slot></div>
<div class="themeindicator"> <div class="themeindicator">
You have selected the ${this.goBright ? 'bright' : 'dark'} theme; You have selected the ${this.goBright ? 'bright' : 'dark'} theme.
<pre>
demoBoolean is <b>${this.demoBoolean}</b>
demoString is <b>"${this.demoString}"</b>
demoNumber is <b>${this.demoNumber}</b>
demoEnum is <b>"${this.demoENum}"</b>
</pre
>
</div> </div>
`; `;
} }

View File

@ -1,3 +1,3 @@
import * as wcctools from '../ts_web/index'; import * as wcctools from '../ts_web/index.js';
import * as elements from './elements'; import * as elements from './elements/index.js';
wcctools.setupWccTools(elements as any, {}); wcctools.setupWccTools(elements as any, {});

41
ts_demotools/demotools.ts Normal file
View File

@ -0,0 +1,41 @@
import { DeesElement, customElement, html, css, property, type TemplateResult } from '@design.estate/dees-element';
@customElement('dees-demowrapper')
export class DeesDemoWrapper extends DeesElement {
@property({ attribute: false })
public runAfterRender: (element: HTMLElement) => void | Promise<void>;
public static styles = [
css`
:host {
display: contents;
}
`
];
public render(): TemplateResult {
return html`
<slot></slot>
`;
}
public async firstUpdated() {
await this.updateComplete;
// Wait a bit for slotted content to render
await new Promise(resolve => setTimeout(resolve, 50));
// Find the first element child (excluding text nodes)
const slottedElements = this.children;
if (slottedElements.length > 0 && this.runAfterRender) {
const firstElement = slottedElements[0] as HTMLElement;
// Call the runAfterRender function with the element
try {
await this.runAfterRender(firstElement);
} catch (error) {
console.error('Error in runAfterRender:', error);
}
}
}
}

1
ts_demotools/index.ts Normal file
View File

@ -0,0 +1 @@
export * from './demotools.js';

5
ts_demotools/plugins.ts Normal file
View File

@ -0,0 +1,5 @@
import * as deesElement from '@design.estate/dees-element';
export {
deesElement
};

View File

@ -0,0 +1,3 @@
{
"order": 2
}

View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@design.estate/dees-wcctools',
version: '1.0.90',
description: 'A set of web component tools for creating element catalogues, enabling the structured development and documentation of custom elements and pages.'
}

View File

@ -1,20 +1,18 @@
import { LitElement, property, html, customElement, TemplateResult } from 'lit-element'; import { DeesElement, property, html, customElement, type TemplateResult, queryAsync, render, domtools } from '@design.estate/dees-element';
import * as plugins from '../wcctools.plugins'; import * as plugins from '../wcctools.plugins.js';
import { WccDefaultElement } from './wcc-defaultelement';
// wcc tools // wcc tools
import './wcc-frame'; import './wcc-frame.js';
import './wcc-sidebar'; import './wcc-sidebar.js';
import './wcc-properties'; import './wcc-properties.js';
import { TTheme } from './wcc-properties'; import { type TTheme } from './wcc-properties.js';
import { TElementType } from './wcc-sidebar'; import { type TElementType } from './wcc-sidebar.js';
import { TViewport } from '@designestate/dees-domtools/dist_ts/domtools.breakpoints'; import { breakpoints } from '@design.estate/dees-domtools';
import { WccFrame } from './wcc-frame.js';
@customElement('wcc-dashboard') @customElement('wcc-dashboard')
export class WccDashboard extends LitElement { export class WccDashboard extends DeesElement {
public domtools: plugins.deesDomtools.DomTools;
@property() @property()
public selectedType: TElementType; public selectedType: TElementType;
@ -23,7 +21,7 @@ export class WccDashboard extends LitElement {
public selectedItemName: string; public selectedItemName: string;
@property() @property()
public selectedItem: (() => TemplateResult) | LitElement; public selectedItem: (() => TemplateResult) | DeesElement;
@property() @property()
public selectedViewport: plugins.deesDomtools.breakpoints.TViewport = 'desktop'; public selectedViewport: plugins.deesDomtools.breakpoints.TViewport = 'desktop';
@ -35,13 +33,16 @@ export class WccDashboard extends LitElement {
public pages: { [key: string]: () => TemplateResult } = {}; public pages: { [key: string]: () => TemplateResult } = {};
@property() @property()
public elements: { [key: string]: LitElement } = {}; public elements: { [key: string]: DeesElement } = {};
@property() @property()
public warning: string = null; public warning: string = null;
@queryAsync('wcc-frame')
public wccFrame: Promise<WccFrame>;
constructor( constructor(
elementsArg?: { [key: string]: LitElement }, elementsArg?: { [key: string]: DeesElement },
pagesArg?: { [key: string]: () => TemplateResult } pagesArg?: { [key: string]: () => TemplateResult }
) { ) {
super(); super();
@ -60,7 +61,6 @@ export class WccDashboard extends LitElement {
return html` return html`
<style> <style>
:host { :host {
font-family: 'Roboto', sans-serif;
background: #fcfcfc; background: #fcfcfc;
display: block; display: block;
box-sizing: border-box; box-sizing: border-box;
@ -90,23 +90,71 @@ export class WccDashboard extends LitElement {
.selectedTheme=${this.selectedTheme} .selectedTheme=${this.selectedTheme}
@selectedViewport=${(eventArg) => { @selectedViewport=${(eventArg) => {
this.selectedViewport = eventArg.detail; this.selectedViewport = eventArg.detail;
this.performUpdate(); this.scheduleUpdate();
}} }}
@selectedTheme=${(eventArg) => { @selectedTheme=${(eventArg) => {
this.selectedTheme = eventArg.detail; this.selectedTheme = eventArg.detail;
}} }}
></wcc-properties> ></wcc-properties>
<wcc-frame id="wccFrame" viewport=${this.selectedViewport}> <wcc-frame id="wccFrame" viewport=${this.selectedViewport}>
${(() => { </wcc-frame>
`;
}
public setWarning(warningTextArg: string) {
if (this.warning !== warningTextArg) {
console.log(warningTextArg);
this.warning = warningTextArg;
setTimeout(() => {
this.scheduleUpdate();
}, 0);
}
}
public async firstUpdated() {
this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
this.domtools.router.on(
'/wcctools-route/:itemType/:itemName/:viewport/:theme',
async (routeInfo) => {
this.selectedType = routeInfo.params.itemType as TElementType;
this.selectedItemName = routeInfo.params.itemName;
this.selectedViewport = routeInfo.params.viewport as breakpoints.TViewport;
this.selectedTheme = routeInfo.params.theme as TTheme;
if (routeInfo.params.itemType === 'element') {
this.selectedItem = this.elements[routeInfo.params.itemName];
} else if (routeInfo.params.itemType === 'page') {
this.selectedItem = this.pages[routeInfo.params.itemName];
}
const domtoolsInstance = await plugins.deesDomtools.elementBasic.setup();
this.selectedTheme === 'bright'
? domtoolsInstance.themeManager.goBright()
: domtoolsInstance.themeManager.goDark();
}
);
}
public async updated(changedPropertiesArg: Map<string, any>) {
this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
await this.domtools.router._handleRouteState();
const storeElement = this.selectedItem;
const wccFrame: WccFrame = this.shadowRoot.querySelector('wcc-frame');
if (changedPropertiesArg.has('selectedItemName')) {
document.title = this.selectedItemName;
};
if (this.selectedType === 'page' && this.selectedItem) { if (this.selectedType === 'page' && this.selectedItem) {
if (typeof this.selectedItem === 'function') { if (typeof this.selectedItem === 'function') {
return this.selectedItem(); console.log('slotting page.');
const viewport = await wccFrame.getViewportElement();
render(this.selectedItem(), viewport);
console.log('rendered page.');
} else { } else {
console.error('The selected item looks strange:') console.error('The selected item looks strange:');
console.log(this.selectedItem); console.log(this.selectedItem);
} }
} else if (this.selectedType === 'element' && this.selectedItem) { } else if (this.selectedType === 'element' && this.selectedItem) {
// console.log(this.selectedItem); console.log('slotting element.');
const anonItem: any = this.selectedItem; const anonItem: any = this.selectedItem;
if (!anonItem.demo) { if (!anonItem.demo) {
this.setWarning(`component ${anonItem.name} does not expose a demo property.`); this.setWarning(`component ${anonItem.name} does not expose a demo property.`);
@ -119,66 +167,14 @@ export class WccDashboard extends LitElement {
return; return;
} }
this.setWarning(null); this.setWarning(null);
return html`${anonItem.demo()}`; const viewport = await wccFrame.getViewportElement();
render(anonItem.demo(), viewport);;
} }
})()}
</wcc-frame>
`;
}
public setWarning(warningTextArg: string) {
if (this.warning !== warningTextArg) {
console.log(warningTextArg);
this.warning = warningTextArg;
setTimeout(() => {
super.performUpdate();
}, 0);
}
}
public async firstUpdated() {
this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
this.domtools.router.on('/:itemType/:itemName/:viewport/:theme', async (routeInfo) => {
this.selectedType = routeInfo.params.itemType as TElementType;
this.selectedItemName = routeInfo.params.itemName;
this.selectedViewport = routeInfo.params.viewport as TViewport;
this.selectedTheme = routeInfo.params.theme as TTheme;
if (routeInfo.params.itemType === 'element') {
this.selectedItem = this.elements[routeInfo.params.itemName];
} else if (routeInfo.params.itemType === 'page') {
this.selectedItem = this.pages[routeInfo.params.itemName];
}
const domtoolsInstance = await plugins.deesDomtools.elementBasic.setup();
domtoolsInstance.setVirtualViewport(routeInfo.params.viewport as TViewport);
domtoolsInstance.themeManager.goBrightBoolean = this.selectedTheme === 'bright';
});
}
private updating = false;
public async updated() {
if (this.updating) {
return;
}
this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
await this.domtools.router._handleRouteState();
this.updating = true;
const storeElement = this.selectedItem;
setTimeout(async () => {
this.selectedItem = null;
setTimeout(async () => {
this.selectedItem = storeElement;
setTimeout(() => {
this.updating = false;
}, 0);
});
}, 0);
} }
public buildUrl() { public buildUrl() {
this.domtools.router.pushUrl( this.domtools.router.pushUrl(
`/${this.selectedType}/${this.selectedItemName}/${this.selectedViewport}/${ `/wcctools-route/${this.selectedType}/${this.selectedItemName}/${this.selectedViewport}/${this.selectedTheme}`
this.selectedTheme
}`
); );
} }
} }

View File

@ -1,37 +0,0 @@
import { LitElement, property, html, customElement } from 'lit-element';
import { TemplateResult } from 'lit-html';
@customElement('wcc-defaultelement')
export class WccDefaultElement extends LitElement {
public static demo = () => html`<wcc-defaultelement></wcc-defaultelement>`;
constructor() {
super();
// you have access to all kinds of things through this.
// this.setAttribute('gotIt','true');
}
public render(): TemplateResult {
return html`
<style>
:host {
font-family: 'Roboto', sans-serif;
background: #333;
text-align: center;
padding:30px;
box-shadow: 0px 0px 5px rgba(0,0,0,0.6);
display: block;
box-sizing: border-box;
color: #fff;
font-size: 30px;
}
:host([hidden]) {
display: none;
}
</style>
No Element specified!
`;
}
}

View File

@ -1,25 +1,46 @@
import { LitElement, property, html, customElement, TemplateResult } from 'lit-element'; import { DeesElement, property, html, customElement, type TemplateResult, css, cssManager } from '@design.estate/dees-element';
import * as domtools from '@designestate/dees-domtools'; import * as domtools from '@design.estate/dees-domtools';
declare global {
interface HTMLElementTagNameMap {
'wcc-frame': WccFrame;
}
}
@customElement('wcc-frame') @customElement('wcc-frame')
export class WccFrame extends LitElement { export class WccFrame extends DeesElement {
@property() @property()
public viewport: string; public viewport: string;
public render(): TemplateResult { public static styles = [
return html` css`
<style>
:host { :host {
border: 10px solid #ffaeaf; border: 10px solid #ffaeaf;
background: #222;
position: absolute; position: absolute;
background: ${cssManager.bdTheme('#333', '#000')};
left: 200px; left: 200px;
right: 0px; right: 0px;
top: 0px; top: 0px;
bottom: 100px; bottom: 100px;
overflow-y: auto; overflow-y: auto;
overflow-x: auto; overflow-x: auto;
overscroll-behavior: contain;
}
.viewport {
container-type: inline-size;
container-name: wccToolsViewport;
position: relative;
min-height: 100%;
}
`,
]
public render(): TemplateResult {
return html`
<style>
:host {
${(() => { ${(() => {
switch (this.viewport) { switch (this.viewport) {
case 'desktop': case 'desktop':
@ -49,12 +70,22 @@ export class WccFrame extends LitElement {
} }
.viewport { .viewport {
position: relative;
${this.viewport !== 'desktop' ${this.viewport !== 'desktop'
? html` border-right: 1px dotted #444; border-left: 1px dotted #444; ` ? html` border-right: 1px dotted #444; border-left: 1px dotted #444; `
: html``} : html``
min-height: 100%; }
background: background:
${
this.goBright ? `
radial-gradient(#CCCCCC 3px, transparent 4px),
radial-gradient(#CCCCCC 3px, transparent 4px),
linear-gradient(#eeeeee 4px, transparent 0),
linear-gradient(45deg, transparent 74px, transparent 75px, #CCCCCC 75px, #CCCCCC 76px, transparent 77px, transparent 109px),
linear-gradient(-45deg, transparent 75px, transparent 76px, #CCCCCC 76px, #CCCCCC 77px, transparent 78px, transparent 109px),
#eeeeee;
background-size: 109px 109px, 109px 109px,100% 6px, 109px 109px, 109px 109px;
background-position: 54px 55px, 0px 0px, 0px 0px, 0px 0px, 0px 0px;
` : `
radial-gradient(#444444 3px, transparent 4px), radial-gradient(#444444 3px, transparent 4px),
radial-gradient(#444444 3px, transparent 4px), radial-gradient(#444444 3px, transparent 4px),
linear-gradient(#222222 4px, transparent 0), linear-gradient(#222222 4px, transparent 0),
@ -63,11 +94,23 @@ export class WccFrame extends LitElement {
#222222; #222222;
background-size: 109px 109px, 109px 109px,100% 6px, 109px 109px, 109px 109px; background-size: 109px 109px, 109px 109px,100% 6px, 109px 109px, 109px 109px;
background-position: 54px 55px, 0px 0px, 0px 0px, 0px 0px, 0px 0px; background-position: 54px 55px, 0px 0px, 0px 0px, 0px 0px, 0px 0px;
`
}
} }
</style> </style>
<div class="viewport"> <div class="viewport">
<slot></slot>
</div> </div>
`; `;
} }
public async getDisplayedInstance() {
await this.updateComplete;
const slottedContent = this.children;
console.log(slottedContent);
}
public async getViewportElement(): Promise<HTMLElement> {
return this.shadowRoot.querySelector('.viewport') as HTMLElement;
}
} }

View File

@ -1,5 +1,7 @@
import { LitElement, property, html, customElement, TemplateResult } from 'lit-element'; import { DeesElement, property, html, customElement, type TemplateResult, state } from '@design.estate/dees-element';
import { WccDashboard } from './wcc-dashboard'; import { WccDashboard } from './wcc-dashboard.js';
export type TPropertyType = 'String' | 'Number' | 'Boolean' | 'Object' | 'Enum' | 'Array';
export type TEnvironment = 'native' | 'desktop' | 'tablet' | 'phablet' | 'phone'; export type TEnvironment = 'native' | 'desktop' | 'tablet' | 'phablet' | 'phone';
export type TTheme = 'bright' | 'dark'; export type TTheme = 'bright' | 'dark';
@ -11,12 +13,14 @@ export const setEnvironment = (envArg) => {
}; };
@customElement('wcc-properties') @customElement('wcc-properties')
export class WccProperties extends LitElement { export class WccProperties extends DeesElement {
@property() @property({
dashboardRef: WccDashboard; type: WccDashboard
})
public dashboardRef: WccDashboard;
@property() @property()
public selectedItem: TemplateResult | LitElement; public selectedItem: (() => TemplateResult) | DeesElement;
@property() @property()
public selectedViewport: TEnvironment = 'native'; public selectedViewport: TEnvironment = 'native';
@ -27,9 +31,11 @@ export class WccProperties extends LitElement {
@property() @property()
public warning: string = null; public warning: string = null;
@state()
propertyContent: TemplateResult[] = [];
public render(): TemplateResult { public render(): TemplateResult {
return html` return html`
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet" />
<style> <style>
:host { :host {
font-family: 'Roboto', sans-serif; font-family: 'Roboto', sans-serif;
@ -55,13 +61,39 @@ export class WccProperties extends LitElement {
grid-template-columns: 33% 33% 33%; grid-template-columns: 33% 33% 33%;
} }
.material-symbols-outlined {
font-family: 'Material Symbols Outlined';
font-weight: normal;
font-style: normal;
font-size: 24px; /* Preferred icon size */
display: inline-block;
line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
font-variation-settings: 'FILL' 1, 'wght' 400, 'GRAD' 0, 'opsz' 48;
}
.properties .property { .properties .property {
padding: 5px; padding: 5px;
background: #444; background: #444;
border: 1px solid #000; border: 1px solid #000;
} }
.properties input,
.properties select {
display: block;
width: 100%;
background: #333;
border: none;
color: #fff;
}
.viewportSelector, .viewportSelector,
.themeSelector { .themeSelector {
user-select: none;
border-right: 1px solid #999; border-right: 1px solid #999;
} }
.selectorButtons2 { .selectorButtons2 {
@ -79,7 +111,6 @@ export class WccProperties extends LitElement {
transition: all 0.2s; transition: all 0.2s;
} }
.button:hover { .button:hover {
cursor: pointer;
color: #333; color: #333;
background: #fff; background: #fff;
} }
@ -89,7 +120,6 @@ export class WccProperties extends LitElement {
} }
.button.selected:hover { .button.selected:hover {
cursor: pointer;
color: #ffffff; color: #ffffff;
background: #455a64; background: #455a64;
} }
@ -107,42 +137,27 @@ export class WccProperties extends LitElement {
} }
.docs:hover { .docs:hover {
cursor: pointer;
color: #333; color: #333;
background: #fff; background: #fff;
} }
.warning { .warning {
position: absolute; position: absolute;
background: #800000; background: #222;
color: #CCC;
top: 0px; top: 0px;
bottom: 0px; bottom: 0px;
left: 0px; left: 0px;
right: 0px; right: 520px;
text-align: center; text-align: center;
padding: 20px; padding: 35px;
font-size: 25px; font-size: 25px;
} }
</style> </style>
<div class="grid"> <div class="grid">
<div class="properties"> <div class="properties">
<div class="panelheading">Properties</div> <div class="panelheading">Properties</div>
${(() => { ${this.propertyContent}
if (this.selectedItem && !(this.selectedItem instanceof TemplateResult)) {
const anonItem: any = this.selectedItem;
if (!anonItem._classProperties) {
return `You have selected a page!`;
}
const classProperties: Map<string, any> = anonItem._classProperties;
const returnArray: TemplateResult[] = [];
for (const key of classProperties.keys()) {
returnArray.push(
html` <div class="property">${key} / ${classProperties.get(key).type.name}</div> `
);
}
return returnArray;
}
})()}
</div> </div>
<div class="themeSelector"> <div class="themeSelector">
<div class="panelheading">Theme</div> <div class="panelheading">Theme</div>
@ -153,7 +168,7 @@ export class WccProperties extends LitElement {
this.selectTheme('dark'); this.selectTheme('dark');
}} }}
> >
Dark<br /><i class="material-icons">brightness_3</i> Dark<br /><i class="material-symbols-outlined">brightness_3</i>
</div> </div>
<div <div
class="button ${this.selectedTheme === 'bright' ? 'selected' : null}" class="button ${this.selectedTheme === 'bright' ? 'selected' : null}"
@ -161,7 +176,7 @@ export class WccProperties extends LitElement {
this.selectTheme('bright'); this.selectTheme('bright');
}} }}
> >
Bright<br /><i class="material-icons">flare</i> Bright<br /><i class="material-symbols-outlined">flare</i>
</div> </div>
</div> </div>
</div> </div>
@ -174,7 +189,7 @@ export class WccProperties extends LitElement {
this.selectViewport('phone'); this.selectViewport('phone');
}} }}
> >
Phone<br /><i class="material-icons">smartphone</i> Phone<br /><i class="material-symbols-outlined">smartphone</i>
</div> </div>
<div <div
class="button ${this.selectedViewport === 'phablet' ? 'selected' : null}" class="button ${this.selectedViewport === 'phablet' ? 'selected' : null}"
@ -182,7 +197,7 @@ export class WccProperties extends LitElement {
this.selectViewport('phablet'); this.selectViewport('phablet');
}} }}
> >
Phablet<br /><i class="material-icons">smartphone</i> Phablet<br /><i class="material-symbols-outlined">smartphone</i>
</div> </div>
<div <div
class="button ${this.selectedViewport === 'tablet' ? 'selected' : null}" class="button ${this.selectedViewport === 'tablet' ? 'selected' : null}"
@ -190,7 +205,7 @@ export class WccProperties extends LitElement {
this.selectViewport('tablet'); this.selectViewport('tablet');
}} }}
> >
Tablet<br /><i class="material-icons">tablet</i> Tablet<br /><i class="material-symbols-outlined">tablet</i>
</div> </div>
<div <div
class="button ${this.selectedViewport === 'desktop' || class="button ${this.selectedViewport === 'desktop' ||
@ -201,7 +216,7 @@ export class WccProperties extends LitElement {
this.selectViewport('native'); this.selectViewport('native');
}} }}
> >
Desktop<br /><i class="material-icons">desktop_windows</i> Desktop<br /><i class="material-symbols-outlined">desktop_windows</i>
</div> </div>
</div> </div>
</div> </div>
@ -211,6 +226,181 @@ export class WccProperties extends LitElement {
`; `;
} }
private async findElementRecursively(container: Element, elementClass: any, maxDepth: number = 5): Promise<HTMLElement | null> {
if (maxDepth <= 0) return null;
// Check direct children
for (const child of Array.from(container.children)) {
if (child instanceof elementClass) {
return child as HTMLElement;
}
}
// Check shadow roots of children
for (const child of Array.from(container.children)) {
if (child.shadowRoot) {
const found = await this.findElementRecursively(child.shadowRoot as any, elementClass, maxDepth - 1);
if (found) return found;
}
// Also check nested children
const found = await this.findElementRecursively(child, elementClass, maxDepth - 1);
if (found) return found;
}
return null;
}
public async createProperties() {
console.log('creating properties for:');
console.log(this.selectedItem);
const isEnumeration = (propertyArg): boolean => {
const keys = Object.keys(propertyArg.type);
const values = [];
for (const key of keys) {
let value = propertyArg.type[key];
if (typeof value === 'number') {
value = value.toString();
}
values.push(value);
}
for (const key of keys) {
if (values.indexOf(key) < 0) {
return false;
}
}
return true;
};
const getEnumValues = (propertyArg): any[] => {
console.log(JSON.stringify(propertyArg));
const enumValues: any[] = [];
Object.keys(propertyArg.type).forEach((valueArg: string) => {
enumValues.push(valueArg);
});
return enumValues;
};
const determinePropertyType = async (propertyArg: any): Promise<TPropertyType> => {
const typeName: any | undefined = propertyArg.type.name;
if (typeName) {
return typeName;
} else {
return Array.isArray(propertyArg)
? 'Array'
: isEnumeration(propertyArg)
? 'Enum'
: 'Object';
}
};
if (this.selectedItem && (this.selectedItem as any).demo) {
console.log(`Got Dees-Element for property evaluation.`);
const anonItem: any = this.selectedItem;
if (!anonItem) {
this.warning = 'no element selected';
return;
}
console.log(anonItem.elementProperties);
const wccFrame = await this.dashboardRef.wccFrame;
// Wait for render to complete
await new Promise(resolve => setTimeout(resolve, 100));
// Try to find the element with recursive search
const viewport = await wccFrame.getViewportElement();
let firstFoundInstantiatedElement: HTMLElement = await this.findElementRecursively(
viewport,
this.selectedItem as any
);
// Retry logic if element not found
let retries = 0;
while (!firstFoundInstantiatedElement && retries < 5) {
await new Promise(resolve => setTimeout(resolve, 200));
firstFoundInstantiatedElement = await this.findElementRecursively(
viewport,
this.selectedItem as any
);
retries++;
}
if (!firstFoundInstantiatedElement) {
this.warning = `no first instantiated element found for >>${anonItem.name}<< after ${retries} retries`;
return;
}
const classProperties: Map<string, any> = anonItem.elementProperties;
if (!classProperties) {
this.warning = `selected element >>${anonItem.name}<< does not expose element properties`;
return;
}
this.warning = null;
const propertyArray: TemplateResult[] = [];
for (const key of classProperties.keys()) {
if (key === 'goBright' || key === 'domtools') {
continue;
}
const property = classProperties.get(key);
const propertyTypeString = await determinePropertyType(property);
propertyArray.push(
html`
<div class="property">
${key} / ${propertyTypeString}<br />
${(() => {
switch (propertyTypeString) {
case 'Boolean':
return html`<input
type="checkbox"
?checked=${firstFoundInstantiatedElement[key]}
@input="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.checked;
}}"
/>`;
case 'String':
return html`<input
type="text"
value=${firstFoundInstantiatedElement[key]}
@input="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.value;
}}"
/>`;
case 'Number':
return html`<input
type="number"
value=${firstFoundInstantiatedElement[key]}
@input="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.value;
}}"
/>`;
case 'Enum':
const enumValues: any[] = getEnumValues(property);
return html`<select
@change="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.value;
}}"
>
${enumValues.map((valueArg) => {
return html`
<option
?selected=${valueArg === firstFoundInstantiatedElement[key] ? true : false}
name="${valueArg}"
>
${valueArg}
</option>
`;
})}
</select>`;
}
})()}
</div>
`
);
}
this.propertyContent = propertyArray;
} else {
console.log(`Cannot extract properties of ${(this.selectedItem as any)?.name}`);
this.warning = `You selected a page.`;
return null;
}
}
public selectTheme(themeArg: TTheme) { public selectTheme(themeArg: TTheme) {
this.selectedTheme = themeArg; this.selectedTheme = themeArg;
this.dispatchEvent( this.dispatchEvent(
@ -222,6 +412,11 @@ export class WccProperties extends LitElement {
this.dashboardRef.buildUrl(); this.dashboardRef.buildUrl();
} }
public async scheduleUpdate() {
await this.createProperties();
super.scheduleUpdate();
}
public selectViewport(viewport: TEnvironment) { public selectViewport(viewport: TEnvironment) {
this.selectedViewport = viewport; this.selectedViewport = viewport;
setEnvironment(viewport); setEnvironment(viewport);

View File

@ -1,16 +1,13 @@
import * as plugins from '../wcctools.plugins'; import * as plugins from '../wcctools.plugins.js';
import { LitElement, property, html, customElement, TemplateResult } from 'lit-element'; import { DeesElement, property, html, customElement, type TemplateResult } from '@design.estate/dees-element';
import { WccDashboard } from './wcc-dashboard'; import { WccDashboard } from './wcc-dashboard.js';
export type TElementType = 'element' | 'page'; export type TElementType = 'element' | 'page';
@customElement('wcc-sidebar') @customElement('wcc-sidebar')
export class WccSidebar extends LitElement { export class WccSidebar extends DeesElement {
@property({type: Array})
public websites: string[] = [];
@property({ attribute: false }) @property({ attribute: false })
public selectedItem: LitElement | (() => TemplateResult); public selectedItem: DeesElement | (() => TemplateResult);
@property({ attribute: false }) @property({ attribute: false })
public selectedType: TElementType; public selectedType: TElementType;
@ -25,7 +22,8 @@ export class WccSidebar extends LitElement {
:host { :host {
display: block; display: block;
border-right: 1px solid #999; border-right: 1px solid #999;
font-family: 'Roboto', sans-serif; font-family: 'Roboto', 'Inter', sans-serif;
font-size: 12px;
box-sizing: border-box; box-sizing: border-box;
position: absolute; position: absolute;
left: 0px; left: 0px;
@ -39,15 +37,23 @@ export class WccSidebar extends LitElement {
padding: 5px; padding: 5px;
} }
.heading { .material-symbols-outlined {
font-size: 24px; font-family: 'Material Symbols Outlined';
text-align: center; font-weight: normal;
margin: 20px 5px 5px 5px; font-style: normal;
} font-size: 24px; /* Preferred icon size */
.subheading { display: inline-block;
text-align: center; line-height: 1;
text-transform: none;
letter-spacing: normal;
word-wrap: normal;
white-space: nowrap;
direction: ltr;
font-variation-settings: 'FILL' 1, 'wght' 400, 'GRAD' 0, 'opsz' 48;
} }
.selectOption { .selectOption {
user-select: none;
position: relative; position: relative;
line-height: 24px; line-height: 24px;
padding: 5px; padding: 5px;
@ -56,7 +62,6 @@ export class WccSidebar extends LitElement {
grid-template-columns: 28px auto; grid-template-columns: 28px auto;
} }
.selectOption:hover { .selectOption:hover {
cursor: pointer;
padding: 5px; padding: 5px;
color: #333; color: #333;
background: #fff; background: #fff;
@ -67,18 +72,17 @@ export class WccSidebar extends LitElement {
} }
.selectOption.selected:hover { .selectOption.selected:hover {
cursor: pointer;
color: #ffffff; color: #ffffff;
background: #455A64; background: #455A64;
} }
.selectOption .material-icons { .selectOption .material-symbols-outlined {
color: #666; color: #666;
display: block; display: block;
transition: all 0.2s; transition: all 0.2s;
} }
.selectOption.selected .material-icons { .selectOption.selected .material-symbols-outlined {
color: #000; color: #000;
} }
@ -91,16 +95,7 @@ export class WccSidebar extends LitElement {
</style> </style>
<div class="heading">
wcc-tools
</div>
<div class="subheading">
</div>
<div class="menu"> <div class="menu">
<h3>Live Websites</h3>
${this.websites.map(website => {
return html`<div class="selectOption"><i class="material-icons">ondemand_video</i><div class="text">${website}</div></div>`;
})}
<h3>Pages</h3> <h3>Pages</h3>
${(() => { ${(() => {
const pages = Object.keys(this.dashboardRef.pages); const pages = Object.keys(this.dashboardRef.pages);
@ -114,7 +109,7 @@ export class WccSidebar extends LitElement {
this.selectItem('page', pageName, item); this.selectItem('page', pageName, item);
}} }}
> >
<i class="material-icons">insert_drive_file</i> <i class="material-symbols-outlined">insert_drive_file</i>
<div class="text">${pageName}</div> <div class="text">${pageName}</div>
</div> </div>
`; `;
@ -127,23 +122,23 @@ export class WccSidebar extends LitElement {
const item = this.dashboardRef.elements[elementName]; const item = this.dashboardRef.elements[elementName];
return html` return html`
<div <div
class="selectOption ${this.selectedItem === item ? 'selected' : console.log('hi')}" class="selectOption ${this.selectedItem === item ? 'selected' : null}"
@click=${async () => { @click=${async () => {
const domtools = await plugins.deesDomtools.DomTools.setupDomTools(); const domtools = await plugins.deesDomtools.DomTools.setupDomTools();
this.selectItem('element', elementName, item); this.selectItem('element', elementName, item);
}} }}
> >
<i class="material-icons">featured_video</i> <i class="material-symbols-outlined">featured_video</i>
<div class="text">${elementName}</div> <div class="text">${elementName}</div>
</div> </div>
`; `;
}); });
})()} })()}
</menu> </div>
`; `;
} }
public selectItem(typeArg: TElementType, itemNameArg: string, itemArg: (() => TemplateResult) | LitElement) { public selectItem(typeArg: TElementType, itemNameArg: string, itemArg: (() => TemplateResult) | DeesElement) {
console.log('selected item'); console.log('selected item');
console.log(itemNameArg); console.log(itemNameArg);
console.log(itemArg); console.log(itemArg);

View File

@ -1,5 +1,5 @@
import { WccDashboard } from './elements/wcc-dashboard'; import { WccDashboard } from './elements/wcc-dashboard.js';
import { LitElement, TemplateResult } from 'lit-element'; import { LitElement, type TemplateResult } from 'lit';
const setupWccTools = (elementsArg?: { [key: string]: LitElement }, pagesArg?: { [key: string]: () => TemplateResult }) => { const setupWccTools = (elementsArg?: { [key: string]: LitElement }, pagesArg?: { [key: string]: () => TemplateResult }) => {
let hasRun = false; let hasRun = false;

View File

@ -1,16 +0,0 @@
{
"compilerOptions": {
"target": "es2017",
"module": "es2015",
"moduleResolution": "node",
"lib": ["es2017", "dom"],
"declaration": true,
"inlineSources": true,
"inlineSourceMap": true,
"noUnusedLocals": true,
"noFallthroughCasesInSwitch": true,
"outDir": "dist/",
"skipLibCheck": true,
"experimentalDecorators": true
}
}

3
ts_web/tspublish.json Normal file
View File

@ -0,0 +1,3 @@
{
"order": 1
}

View File

@ -1,10 +1,10 @@
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
export { export {
smartdelay smartdelay
}; };
import * as deesDomtools from '@designestate/dees-domtools'; import * as deesDomtools from '@design.estate/dees-domtools';
export { export {
deesDomtools deesDomtools

View File

@ -1,7 +1,14 @@
{ {
"compilerOptions": { "compilerOptions": {
"experimentalDecorators": true, "experimentalDecorators": true,
"target": "ES2017", "useDefineForClassFields": false,
"moduleResolution": "Node" "target": "ES2022",
} "module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
} }

View File

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}