Skip to content
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

Add full functionality of classnames package to classList #88

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add full functionality of classnames package to classList #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions packages/dom-expressions/src/client.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,16 @@ export function spread<T>(
export function assign(node: Element, props: any, isSVG?: Boolean, skipChildren?: Boolean): void;
export function setAttribute(node: Element, name: string, value: string): void;
export function setAttributeNS(node: Element, namespace: string, name: string, value: string): void;
export function addEventListener(node: Element, name: string, handler: () => void, delegate: boolean): void;
export function classList(
export function addEventListener(
node: Element,
value: { [k: string]: boolean },
prev?: { [k: string]: boolean }
name: string,
handler: () => void,
delegate: boolean
): void;
type ClassList =
| { [k: string]: boolean }
| (ClassList | string | number | boolean | null | undefined)[];
export function classList(node: Element, value: ClassList, prev?: { [k: string]: boolean }): void;
export function style(
node: Element,
value: { [k: string]: string },
Expand Down
32 changes: 23 additions & 9 deletions packages/dom-expressions/src/client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,22 +84,36 @@ export function addEventListener(node, name, handler, delegate) {
}

export function classList(node, value, prev = {}) {
const classKeys = Object.keys(value),
prevKeys = Object.keys(prev);
const prevKeys = Object.keys(prev);
let i, len;
for (i = 0, len = prevKeys.length; i < len; i++) {
const key = prevKeys[i];
if (!key || key === "undefined" || key in value) continue;
toggleClassKey(node, key, false);
delete prev[key];
}
Comment on lines 89 to 94
Copy link
Owner

Choose a reason for hiding this comment

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

This loop compares prev keys that and if they are missing from the value it unsets them. I'm gathering we need to update to support objects in arrays.

Copy link
Author

@kcirtaptrick kcirtaptrick Sep 15, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Oh mb, missed the key in value, I have a couple of solutions in mind. First I'm thinking the simplest way to achieve this is to just wipe them all and rebuild them. At first that sounds like it would have poor performance, but I think its unlikely developers will be setting enough classnames to make this significant, even on several components. Another option would be to track present classes with setClasses, and remove all other classes.
I'll draft up these 2 scenarios so you'll have some more context.

Comment on lines 89 to 94
Copy link
Author

Choose a reason for hiding this comment

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

Scenario 1, wipe all classes. These will be rebuilt in setClasses

Suggested change
for (i = 0, len = prevKeys.length; i < len; i++) {
const key = prevKeys[i];
if (!key || key === "undefined" || key in value) continue;
toggleClassKey(node, key, false);
delete prev[key];
}
for (const key of Object.keys(prev)) {
toggleClassKey(node, key, false);
delete prev[key];
}

for (i = 0, len = classKeys.length; i < len; i++) {
const key = classKeys[i],
classValue = !!value[key];
if (!key || key === "undefined" || prev[key] === classValue) continue;
toggleClassKey(node, key, classValue);
prev[key] = classValue;
}
(function setClasses(classes) {
if (classes instanceof Array) {
for (const key of classes) {
// classList setting classes for all numbers except for 0 may be
// unexpected behavior, you must explicity omit 0 using `n || false`
if (!key && key !== 0) continue;
if (typeof key === 'object') { // Both objects and arrays
setClasses(key);
continue;
}
toggleClassKey(node, key, true);
prev[key] = true;
}
} else if (typeof classes === 'object') {
for (const [key, enabled] of Object.entries(classes)) {
if (!enabled) continue;
toggleClassKey(node, key, true);
prev[key] = true
}
}
})(value);

Comment on lines +95 to +116
Copy link
Author

@kcirtaptrick kcirtaptrick Sep 15, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Scenario 2, track classes & remove absent

Suggested change
(function setClasses(classes) {
if (classes instanceof Array) {
for (const key of classes) {
// classList setting classes for all numbers except for 0 may be
// unexpected behavior, you must explicity omit 0 using `n || false`
if (!key && key !== 0) continue;
if (typeof key === 'object') { // Both objects and arrays
setClasses(key);
continue;
}
toggleClassKey(node, key, true);
prev[key] = true;
}
} else if (typeof classes === 'object') {
for (const [key, enabled] of Object.entries(classes)) {
if (!enabled) continue;
toggleClassKey(node, key, true);
prev[key] = true
}
}
})(value);
const present = new Set();
(function setClasses(classes) {
if (classes instanceof Array) {
for (const key of classes) {
// classList setting classes for all numbers except for 0 may be
// unexpected behavior, you must explicity omit 0 using `n || false`
if (!key && key !== 0) continue;
if (typeof key === 'object') { // Both objects and arrays
setClasses(key);
continue;
}
toggleClassKey(node, key, true);
prev[key] = true;
present.add(key);
}
} else if (typeof classes === 'object') {
for (const [key, enabled] of Object.entries(classes)) {
if (!enabled) continue;
toggleClassKey(node, key, true);
prev[key] = true
present.add(key);
}
}
})(value);
for(const key of Object.keys(prev)) {
if(!present.has(key)) {
toggleClassKey(node, key, false);
delete prev[key];
}
}

also delete this snippet

  for (i = 0, len = classKeys.length; i < len; i++) {
    const key = classKeys[i],
      classValue = !!value[key];
    if (!key || key === "undefined" || prev[key] === classValue) continue;
    toggleClassKey(node, key, classValue);
    prev[key] = classValue;
  }

return prev;
}

Expand Down