Compare commits

..

4 Commits

Author SHA1 Message Date
4ed37086ae 1.0.99
Some checks failed
Default (tags) / security (push) Failing after 20s
Default (tags) / test (push) Failing after 20s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-06-26 20:18:20 +00:00
b4c0de47b9 fix(dashboard): Fix scroll state preservation in dashboard by tracking frame and sidebar scroll positions and updating the URL accordingly. 2025-06-26 20:18:20 +00:00
e11f0df950 1.0.98
Some checks failed
Default (tags) / security (push) Failing after 40s
Default (tags) / test (push) Failing after 35s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-06-16 17:57:37 +00:00
c64b106569 fix(properties-panel): improve element detection timing and value handling in properties panel 2025-06-16 17:56:14 +00:00
7 changed files with 172 additions and 18 deletions

36
changelog.md Normal file
View File

@ -0,0 +1,36 @@
# Changelog
## 2025-06-26 - 1.0.99 - fix(dashboard)
Fix scroll state preservation in dashboard by tracking frame and sidebar scroll positions and updating the URL accordingly.
- Added frameScrollY and sidebarScrollY properties to capture scroll positions.
- Set up scroll listeners on wcc-frame and wcc-sidebar to update scroll state.
- Implemented debounced updates to modify the URL with current scroll positions without navigation.
- Restored scroll positions from URL query parameters during initialization.
## 2025-06-16 - 1.0.97 - properties-panel
- Improve element detection timing and value handling in properties panel
## 2025-06-16 - 1.0.96 - properties-panel
- Enhance element detection and error handling for nested structures
## 2025-06-16 - 1.0.95 - package
- Correct path for demotools export in package.json
## 2025-06-16 - 1.0.94 - demotools
- Enhance runAfterRender to provide full DOM API access and improve element selection
## 2025-06-16 - 1.0.92 - demotools
- Update DeesDemoWrapper to handle multiple slotted elements in runAfterRender callback
## 2025-06-16 - 1.0.91 - readme
- Update documentation with comprehensive overview, quick start guide, and detailed feature descriptions
## 2025-06-16 - 1.0.90 - demo/properties/refactor
- Add DeesDemoWrapper component for enhanced demo element handling
- Enhance element detection in properties panel with recursive search and retry mechanism
- Refactor code structure for improved readability and maintainability
## 2024-05-06 to 2020-05-10 - 1.0.891.0.17 - core
- Over a series of releases, trivial core fixes and updates were applied.
- (Note: Version 1.0.87 also included an update to the documentation.)

View File

@ -1,6 +1,6 @@
{ {
"name": "@design.estate/dees-wcctools", "name": "@design.estate/dees-wcctools",
"version": "1.0.97", "version": "1.0.99",
"private": false, "private": false,
"description": "A set of web component tools for creating element catalogues, enabling the structured development and documentation of custom elements and pages.", "description": "A set of web component tools for creating element catalogues, enabling the structured development and documentation of custom elements and pages.",
"exports": { "exports": {

View File

@ -25,9 +25,11 @@ The properties panel had timing issues detecting rendered elements because:
### Code Flow ### Code Flow
1. Dashboard renders element demo into viewport using `render(anonItem.demo(), viewport)` 1. Dashboard renders element demo into viewport using `render(anonItem.demo(), viewport)`
2. Properties panel waits, then searches recursively for the element instance 2. Properties panel waits 200ms for demo wrappers to run and set initial values
3. If not found, retries with delays to handle async rendering 3. Searches recursively for the element instance
4. Once found, extracts and displays element properties 4. If not found, retries with delays to handle async rendering
5. Once found, extracts and displays element properties
6. Uses property binding (`.value=`) instead of attribute binding to prevent input events during initialization
## Demo Tools ## Demo Tools

View File

@ -85,4 +85,16 @@ These test various scenarios:
- Complex data type display and editing - Complex data type display and editing
- Element detection inside dees-demowrapper - Element detection inside dees-demowrapper
- Error handling for problematic values - Error handling for problematic values
- Deep nesting and shadow DOM traversal - Deep nesting and shadow DOM traversal
# Fixed Demo Value Overwriting (COMPLETED)
## Issue:
Properties panel was overwriting values set by demo functions
## Solution:
1. Changed from attribute binding (`value=`) to property binding (`.value=`)
2. This prevents browser from firing input events during initialization
3. Added proper number parsing for number inputs
4. Increased initial wait to 200ms for demo wrappers to complete
5. Simplified select element handling to use property binding

View File

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

View File

@ -38,6 +38,12 @@ export class WccDashboard extends DeesElement {
@property() @property()
public warning: string = null; public warning: string = null;
@property()
public frameScrollY: number = 0;
@property()
public sidebarScrollY: number = 0;
@queryAsync('wcc-frame') @queryAsync('wcc-frame')
public wccFrame: Promise<WccFrame>; public wccFrame: Promise<WccFrame>;
@ -113,6 +119,12 @@ export class WccDashboard extends DeesElement {
public async firstUpdated() { public async firstUpdated() {
this.domtools = await plugins.deesDomtools.DomTools.setupDomTools(); this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
// Set up scroll listeners after DOM is ready
setTimeout(() => {
this.setupScrollListeners();
}, 500);
this.domtools.router.on( this.domtools.router.on(
'/wcctools-route/:itemType/:itemName/:viewport/:theme', '/wcctools-route/:itemType/:itemName/:viewport/:theme',
async (routeInfo) => { async (routeInfo) => {
@ -125,6 +137,25 @@ export class WccDashboard extends DeesElement {
} else if (routeInfo.params.itemType === 'page') { } else if (routeInfo.params.itemType === 'page') {
this.selectedItem = this.pages[routeInfo.params.itemName]; this.selectedItem = this.pages[routeInfo.params.itemName];
} }
// Restore scroll positions from query parameters
if (routeInfo.queryParams) {
const frameScrollY = routeInfo.queryParams.frameScrollY;
const sidebarScrollY = routeInfo.queryParams.sidebarScrollY;
if (frameScrollY) {
this.frameScrollY = parseInt(frameScrollY);
}
if (sidebarScrollY) {
this.sidebarScrollY = parseInt(sidebarScrollY);
}
// Apply scroll positions after a short delay to ensure DOM is ready
setTimeout(() => {
this.applyScrollPositions();
}, 100);
}
const domtoolsInstance = await plugins.deesDomtools.elementBasic.setup(); const domtoolsInstance = await plugins.deesDomtools.elementBasic.setup();
this.selectedTheme === 'bright' this.selectedTheme === 'bright'
? domtoolsInstance.themeManager.goBright() ? domtoolsInstance.themeManager.goBright()
@ -136,7 +167,6 @@ export class WccDashboard extends DeesElement {
public async updated(changedPropertiesArg: Map<string, any>) { public async updated(changedPropertiesArg: Map<string, any>) {
this.domtools = await plugins.deesDomtools.DomTools.setupDomTools(); this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
await this.domtools.router._handleRouteState(); await this.domtools.router._handleRouteState();
const storeElement = this.selectedItem;
const wccFrame: WccFrame = this.shadowRoot.querySelector('wcc-frame'); const wccFrame: WccFrame = this.shadowRoot.querySelector('wcc-frame');
if (changedPropertiesArg.has('selectedItemName')) { if (changedPropertiesArg.has('selectedItemName')) {
@ -173,8 +203,82 @@ export class WccDashboard extends DeesElement {
} }
public buildUrl() { public buildUrl() {
this.domtools.router.pushUrl( const baseUrl = `/wcctools-route/${this.selectedType}/${this.selectedItemName}/${this.selectedViewport}/${this.selectedTheme}`;
`/wcctools-route/${this.selectedType}/${this.selectedItemName}/${this.selectedViewport}/${this.selectedTheme}` const queryParams = new URLSearchParams();
);
if (this.frameScrollY > 0) {
queryParams.set('frameScrollY', this.frameScrollY.toString());
}
if (this.sidebarScrollY > 0) {
queryParams.set('sidebarScrollY', this.sidebarScrollY.toString());
}
const queryString = queryParams.toString();
const fullUrl = queryString ? `${baseUrl}?${queryString}` : baseUrl;
this.domtools.router.pushUrl(fullUrl);
}
private scrollUpdateTimeout: NodeJS.Timeout;
public async setupScrollListeners() {
const wccFrame = await this.wccFrame;
const wccSidebar = this.shadowRoot.querySelector('wcc-sidebar');
if (wccFrame) {
// The frame element itself is the scrollable container
wccFrame.addEventListener('scroll', () => {
this.frameScrollY = wccFrame.scrollTop;
this.debouncedScrollUpdate();
});
}
if (wccSidebar) {
// The sidebar element itself is the scrollable container
wccSidebar.addEventListener('scroll', () => {
this.sidebarScrollY = wccSidebar.scrollTop;
this.debouncedScrollUpdate();
});
}
}
private debouncedScrollUpdate() {
clearTimeout(this.scrollUpdateTimeout);
this.scrollUpdateTimeout = setTimeout(() => {
this.updateUrlWithScrollState();
}, 300);
}
private updateUrlWithScrollState() {
const baseUrl = `/wcctools-route/${this.selectedType}/${this.selectedItemName}/${this.selectedViewport}/${this.selectedTheme}`;
const queryParams = new URLSearchParams();
if (this.frameScrollY > 0) {
queryParams.set('frameScrollY', this.frameScrollY.toString());
}
if (this.sidebarScrollY > 0) {
queryParams.set('sidebarScrollY', this.sidebarScrollY.toString());
}
const queryString = queryParams.toString();
const fullUrl = queryString ? `${baseUrl}?${queryString}` : baseUrl;
// Use replaceState to update URL without navigation
window.history.replaceState(null, '', fullUrl);
}
public async applyScrollPositions() {
const wccFrame = await this.wccFrame;
const wccSidebar = this.shadowRoot.querySelector('wcc-sidebar');
if (wccFrame && this.frameScrollY > 0) {
// The frame element itself is the scrollable container
wccFrame.scrollTop = this.frameScrollY;
}
if (wccSidebar && this.sidebarScrollY > 0) {
// The sidebar element itself is the scrollable container
wccSidebar.scrollTop = this.sidebarScrollY;
}
} }
} }

View File

@ -309,8 +309,8 @@ export class WccProperties extends DeesElement {
console.log(anonItem.elementProperties); console.log(anonItem.elementProperties);
const wccFrame = await this.dashboardRef.wccFrame; const wccFrame = await this.dashboardRef.wccFrame;
// Wait for render to complete // Wait for render to complete and any demo wrappers to run
await new Promise(resolve => setTimeout(resolve, 100)); await new Promise(resolve => setTimeout(resolve, 200));
// Try to find the element with recursive search // Try to find the element with recursive search
const viewport = await wccFrame.getViewportElement(); const viewport = await wccFrame.getViewportElement();
@ -370,7 +370,7 @@ export class WccProperties extends DeesElement {
case 'String': case 'String':
return html`<input return html`<input
type="text" type="text"
value=${firstFoundInstantiatedElement[key]} .value=${firstFoundInstantiatedElement[key] || ''}
@input="${(eventArg: any) => { @input="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.value; firstFoundInstantiatedElement[key] = eventArg.target.value;
}}" }}"
@ -378,14 +378,15 @@ export class WccProperties extends DeesElement {
case 'Number': case 'Number':
return html`<input return html`<input
type="number" type="number"
value=${firstFoundInstantiatedElement[key]} .value=${firstFoundInstantiatedElement[key] ?? ''}
@input="${(eventArg: any) => { @input="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.value; firstFoundInstantiatedElement[key] = parseFloat(eventArg.target.value) || 0;
}}" }}"
/>`; />`;
case 'Enum': case 'Enum':
const enumValues: any[] = getEnumValues(property); const enumValues: any[] = getEnumValues(property);
return html`<select return html`<select
.value=${firstFoundInstantiatedElement[key] || ''}
@change="${(eventArg: any) => { @change="${(eventArg: any) => {
firstFoundInstantiatedElement[key] = eventArg.target.value; firstFoundInstantiatedElement[key] = eventArg.target.value;
}}" }}"
@ -393,8 +394,7 @@ export class WccProperties extends DeesElement {
${enumValues.map((valueArg) => { ${enumValues.map((valueArg) => {
return html` return html`
<option <option
?selected=${valueArg === firstFoundInstantiatedElement[key] ? true : false} value="${valueArg}"
name="${valueArg}"
> >
${valueArg} ${valueArg}
</option> </option>