Skip to content

Enhance handleProperty function to dynamically handle additional properties #2098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Aug 3, 2025
Merged

Enhance handleProperty function to dynamically handle additional properties #2098

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
3267a8f
Enhance handleProperty function to dynamically handle additional prop…
Bashamega Aug 2, 2025
0377309
chore: new line
Bashamega Aug 2, 2025
37efe71
-
Bashamega Aug 3, 2025
3884300
format
Bashamega Aug 3, 2025
afd7b3e
-
Bashamega Aug 3, 2025
c63e69c
-
Bashamega Aug 3, 2025
18881d4
-
Bashamega Aug 3, 2025
a2beb93
chore: spaces
Bashamega Aug 3, 2025
ea9284b
-
Bashamega Aug 3, 2025
36e43e3
??
Bashamega Aug 3, 2025
8e75e22
Merge branch 'microsoft:main' into optional-properties
Bashamega Aug 3, 2025
501d38e
-
Bashamega Aug 3, 2025
d504495
Merge branch 'optional-properties' of https://github.com/Bashamega/Ty…
Bashamega Aug 3, 2025
405e381
Revert "-"
Bashamega Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions inputfiles/overridingTypes.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,6 @@
}
}
},
"GlobalEventHandlers": {
"properties": {
"property": {
"onerror": {
"overrideType": "OnErrorEventHandler"
},
"ontouchcancel": {
"optional": true
},
"ontouchend": {
"optional": true
},
"ontouchmove": {
"optional": true
},
"ontouchstart": {
"optional": true
}
}
}
},
"HTMLOrSVGElement": {
"properties": {
"property": {
Expand Down
7 changes: 7 additions & 0 deletions inputfiles/patches/eventhandlers.kdl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
interface-mixin GlobalEventHandlers {
property ontouchcancel optional=#true
property ontouchend optional=#true
property ontouchmove optional=#true
property ontouchstart optional=#true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some context comment would be nice for touch events, which would be nicer as touch-events.kdl:

Touch event handlers are intentionally hidden in non-mobile web browsers.
See https://w3c.github.io/touch-events/#dfn-expose-legacy-touch-event-apis.

property onerror overrideType=OnErrorEventHandler
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can go events.kdl, as this should ultimately also be autogenerated rather than overridden.

}
13 changes: 11 additions & 2 deletions src/build/patches.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,19 @@ function handleEvent(child: Node): Event {
* @param child The child node to handle.
*/
function handleProperty(child: Node): Partial<Property> {
return {
const result: Partial<Property> = {
name: child.values[0] as string,
exposed: child.properties?.exposed as string,
};

const props: (keyof Property)[] = ["exposed", "optional", "overrideType"];

props.forEach((prop) => {
const value = child.properties[prop];
if (value !== undefined) {
result[prop] = value as any;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice to have some type check, any should not be used.

Perhaps could use some helper:

import { parse, type Node, type Value } from "kdljs";

function optionalMember<const T>(prop: string, type: T, value?: Value) {
  if (value === undefined) {
    return {};
  }
  if (typeof value !== type) {
    throw new Error(`Expected type ${value} for ${prop}`);
  }
  return { [prop]: value as T extends "string" ? string : T extends "number" ? number : T extends "boolean" ? boolean : never };
}

const result = {
  name: child.values[0] as string,
  ...optionalMember("exposed", "string", child.properties?.exposed),
  ...optionalMember("optional", "boolean", child.properties?.optional),
  ...optionalMember("overrideType", "string", child.properties?.overrideType),
};

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated it for property and mixins

}
});
return result;
}

/**
Expand Down
Loading