fix(engine-dom): remove ARIA reflection global polyfill (BREAKING CHANGE) #3666
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,7 +45,5 @@ | |
| } | ||
| } | ||
| }, | ||
| "dependencies": {} | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,85 @@ | ||
| /* | ||
| * Copyright (c) 2023, salesforce.com, inc. | ||
|
There was a problem hiding this comment. Just curious whether you're updating these manually? There was a problem hiding this comment. Manually, yes. We should really go through and just run a script or something. |
||
| * All rights reserved. | ||
| * SPDX-License-Identifier: MIT | ||
| * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT | ||
| */ | ||
|
|
||
| // Minimal polyfill of ARIA string reflection, plus some non-standard ARIA props | ||
| // Taken from https://github.com/salesforce/lwc/blob/44a01ef/packages/%40lwc/shared/src/aria.ts#L22-L70 | ||
| // This is designed for maximum backwards compatibility on LEX - it should never change. | ||
| // We deliberately don't import from @lwc/shared because that would make this code less portable. | ||
| const ARIA_PROPERTIES = [ | ||
| 'ariaActiveDescendant', | ||
| 'ariaAtomic', | ||
| 'ariaAutoComplete', | ||
| 'ariaBusy', | ||
| 'ariaChecked', | ||
| 'ariaColCount', | ||
| 'ariaColIndex', | ||
| 'ariaColSpan', | ||
| 'ariaControls', | ||
| 'ariaCurrent', | ||
| 'ariaDescribedBy', | ||
| 'ariaDetails', | ||
| 'ariaDisabled', | ||
| 'ariaErrorMessage', | ||
| 'ariaExpanded', | ||
| 'ariaFlowTo', | ||
| 'ariaHasPopup', | ||
| 'ariaHidden', | ||
| 'ariaInvalid', | ||
| 'ariaKeyShortcuts', | ||
| 'ariaLabel', | ||
| 'ariaLabelledBy', | ||
| 'ariaLevel', | ||
| 'ariaLive', | ||
| 'ariaModal', | ||
| 'ariaMultiLine', | ||
| 'ariaMultiSelectable', | ||
| 'ariaOrientation', | ||
| 'ariaOwns', | ||
| 'ariaPlaceholder', | ||
| 'ariaPosInSet', | ||
| 'ariaPressed', | ||
| 'ariaReadOnly', | ||
| 'ariaRelevant', | ||
| 'ariaRequired', | ||
| 'ariaRoleDescription', | ||
| 'ariaRowCount', | ||
| 'ariaRowIndex', | ||
| 'ariaRowSpan', | ||
| 'ariaSelected', | ||
| 'ariaSetSize', | ||
| 'ariaSort', | ||
| 'ariaValueMax', | ||
| 'ariaValueMin', | ||
| 'ariaValueNow', | ||
| 'ariaValueText', | ||
| 'role', | ||
| ]; | ||
|
|
||
| for (const prop of ARIA_PROPERTIES) { | ||
| const attribute = prop.replace(/^aria/, 'aria-').toLowerCase(); // e.g. ariaPosInSet => aria-posinset | ||
|
|
||
| if (!Object.getOwnPropertyDescriptor(Element.prototype, prop)) { | ||
| Object.defineProperty(Element.prototype, prop, { | ||
| get() { | ||
| return this.getAttribute(attribute); | ||
| }, | ||
| set(value) { | ||
| // Per the spec, only null is treated as removing the attribute. However, Chromium/WebKit currently | ||
| // differ from the spec and allow undefined as well. Here, we follow the spec, as well as | ||
| // our historical behavior. See: https://github.com/w3c/aria/issues/1858 | ||
| if (value === null) { | ||
| this.removeAttribute(attribute); | ||
| } else { | ||
| this.setAttribute(attribute, value); | ||
| } | ||
| }, | ||
| // configurable and enumerable to allow it to be overridden – this mimics Safari's/Chrome's behavior | ||
| configurable: true, | ||
| enumerable: true, | ||
| }); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -42,7 +42,6 @@ | |
| } | ||
| }, | ||
| "dependencies": { | ||
| "@lwc/features": "3.2.0", | ||
| "@lwc/shared": "3.2.0" | ||
| }, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * Copyright (c) 2023, salesforce.com, inc. | ||
| * All rights reserved. | ||
| * SPDX-License-Identifier: MIT | ||
| * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT | ||
| */ | ||
| import { | ||
| AriaPropNameToAttrNameMap, | ||
| defineProperty, | ||
| getOwnPropertyDescriptor, | ||
| isNull, | ||
| isUndefined, | ||
| keys, | ||
| } from '@lwc/shared'; | ||
| import { LightningElement } from '../../framework/base-lightning-element'; | ||
|
|
||
| // Apply ARIA string reflection behavior to a prototype. | ||
| // This is deliberately kept separate from @lwc/aria-reflection. @lwc/aria-reflection is a global polyfill that is | ||
| // needed for backwards compatibility in LEX, whereas `applyAriaReflection` is designed to only apply to our own | ||
| // LightningElement/BaseBridgeElement prototypes. | ||
| export function applyAriaReflection(prototype: HTMLElement | LightningElement) { | ||
| for (const propName of keys(AriaPropNameToAttrNameMap)) { | ||
| const attrName = AriaPropNameToAttrNameMap[propName]; | ||
| if (isUndefined(getOwnPropertyDescriptor(prototype, propName))) { | ||
| // Note that we need to call this.{get,set,has,remove}Attribute rather than dereferencing | ||
| // from Element.prototype, because these methods are overridden in LightningElement. | ||
| defineProperty(prototype, propName, { | ||
| get(this: HTMLElement): any { | ||
| return this.getAttribute(attrName); | ||
ekashida marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| set(this: HTMLElement, newValue: any) { | ||
| // TODO [#3284]: there is disagreement between browsers and the spec on how to treat undefined | ||
| // Our historical behavior is to only treat null as removing the attribute | ||
| // See also https://github.com/w3c/aria/issues/1858 | ||
| if (isNull(newValue)) { | ||
| this.removeAttribute(attrName); | ||
| } else { | ||
| this.setAttribute(attrName, newValue); | ||
| } | ||
| }, | ||
| // configurable and enumerable to allow it to be overridden – this mimics Safari's/Chrome's behavior | ||
| configurable: true, | ||
| enumerable: true, | ||
| }); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel we may as well test with synthetic shadow on vs off, especially since this flag will be set to true in LEX.