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

Jump to bottom

fix(input, input-number, input-text): restore autofocus, enter-key-mode and input-mode attributes #9245

Merged
merged 5 commits into from
May 3, 2024
Merged

fix(input, input-number, input-text): restore autofocus, enter-key-mode and input-mode attributes #9245

merged 5 commits into from
May 3, 2024

Conversation

jcfranco
Copy link
Member

@jcfranco jcfranco commented May 2, 2024 •
edited

Related Issue: #9235

Summary

This fixes the following issues introduced by #9123 when component props that shadowed global attributes were removed:

@jcfranco
fix(input, input-number, input-text): restore enter-key-mode and `i…
2459db3 
…nput-mode` attributes

This was caused by the removal of custom props mapped to global attributes, which were kebab-cased through Stencil attr reflection rules.
@github-actions github-actions bot added the bug Bug reports for broken functionality. Issues should include a reproduction of the bug. label May 2, 2024
@jcfranco jcfranco added the pr ready for visual snapshots Adding this label will run visual snapshot testing. label May 2, 2024
@jcfranco jcfranco changed the title fix(input, input-number, input-text): restore enter-key-mode and input-mode attributes fix(input, input-number, input-text): restore autofocus, enter-key-mode and input-mode attributes May 3, 2024
@jcfranco jcfranco marked this pull request as ready for review May 3, 2024 04:37
@jcfranco jcfranco requested a review from a team as a code owner May 3, 2024 04:37
driskull
driskull approved these changes May 3, 2024
View reviewed changes
Copy link
Member

@driskull driskull left a comment

Choose a reason for hiding this comment

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

Nice! 👏

packages/calcite-components/src/components/input-number/input-number.tsx
@@ -1059,8 +1085,8 @@ export class InputNumber
autofocus={this.el.autofocus ? true : null}
defaultValue={this.defaultValue}
disabled={this.disabled ? true : null}
enterKeyHint={this.el.enterKeyHint}
inputMode={this.el.inputMode}
enterKeyHint={this.el.enterKeyHint || this.el.getAttribute("enterkeyhint")}
Copy link
Member

Choose a reason for hiding this comment

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

This looks a little odd to me because you could just do

enterKeyHint={this.enterKeyHint}

But I get why its like the way you have. So its easier to remove the property in the future breaking change release 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

This is actually needed since the component prop won't be populated if I set the global attribute. The custom props override the native behavior, so the prop will not be set when using the native global attributes.

packages/calcite-components/src/components/input/input.tsx Outdated Show resolved Hide resolved
driskull
driskull reviewed May 3, 2024
View reviewed changes
packages/calcite-components/src/components/input/input.tsx
enterKeyHint={this.el.enterKeyHint}
inputMode={this.el.inputMode}
enterKeyHint={enterKeyHint}
inputMode={inputMode}
Copy link
Member

Choose a reason for hiding this comment

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

Yeah this makes more sense. We'll just have to put the previous code back once we remove the internal props.

@jcfranco jcfranco added skip visual snapshots Pull requests that do not need visual regression testing. and removed pr ready for visual snapshots Adding this label will run visual snapshot testing. labels May 3, 2024
@jcfranco jcfranco merged commit a493664 into main May 3, 2024
11 checks passed
@jcfranco jcfranco deleted the jcfranco/fix-regression-from-removal-of-custom-global-props branch May 3, 2024 20:45
@github-actions github-actions bot added this to the 2024-05-28 - May Main Release milestone May 3, 2024
@calcite-admin calcite-admin mentioned this pull request May 3, 2024
Merged
@jcfranco jcfranco mentioned this pull request May 3, 2024
Open
5 tasks
jcfranco added a commit that referenced this pull request May 10, 2024
@jcfranco
fix(input, input-number, input-text): restore autofocus, `enter-key…
2542f4e 
…-mode` and `input-mode` attributes (#9245)

**Related Issue:** #9235

## Summary

This fixes the following issues introduced by #9123 when component props
that shadowed global attributes were removed:

* the kebab-cased attribute names of those props would no longer work
(namely, `enter-key-mode`, `input-mode`)
* `autofocus` was missing from component types as Stencil does not
include it in the base `HTMLAttribute` type (see
ionic-team/stencil#5726).
@jcfranco jcfranco mentioned this pull request May 10, 2024
Merged
jcfranco added a commit that referenced this pull request May 10, 2024
@jcfranco @benelan
fix(input, input-number, input-text): restore autofocus, `enter-key…
0498c6e 
…-mode` and `input-mode` attributes (#9245) (#9306)

**Related Issue:** #9235

## Summary

This fixes the following issues introduced by #9123 when component props
that shadowed global attributes were removed:

* the kebab-cased attribute names of those props would no longer work
(namely, `enter-key-mode`, `input-mode`)
* `autofocus` was missing from component types as Stencil does not
include it in the base `HTMLAttribute` type (see
ionic-team/stencil#5726).

Co-authored-by: Ben Elan <no-reply@benelan.dev>
@calcite-admin calcite-admin mentioned this pull request May 10, 2024
Merged
geospatialem pushed a commit that referenced this pull request May 14, 2024
@calcite-admin
chore: release hotfix (#9308)
d1f9381 
🤖 I have created a release *beep* *boop*
---


<details><summary>@esri/calcite-components: 2.8.1</summary>

##
[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.8.0...@esri/calcite-components@2.8.1)
(2024-05-14)


### Bug Fixes

* Add type-fest as dependency due to build error
([3819688](3819688))
* **carousel:** Animate items with the same direction
([#9325](#9325))
([6bf7b74](6bf7b74))
* **input, input-number, input-text:** Restore `autofocus`,
`enter-key-mode` and `input-mode` attributes
([#9245](#9245))
([#9306](#9306))
([0498c6e](0498c6e))
* **list-item:** Decrease horizontal spacing between selection icon and
content
([#9304](#9304))
([0e828b6](0e828b6))
</details>

<details><summary>@esri/calcite-components-angular: 2.8.1</summary>

##
[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.8.0...@esri/calcite-components-angular@2.8.1)
(2024-05-14)


### Miscellaneous Chores

* **@esri/calcite-components-angular:** Synchronize components versions


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @esri/calcite-components bumped from ^2.8.1-hotfix.0 to ^2.8.1
</details>

<details><summary>@esri/calcite-components-react: 2.8.1</summary>

##
[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.8.0...@esri/calcite-components-react@2.8.1)
(2024-05-14)


### Miscellaneous Chores

* **@esri/calcite-components-react:** Synchronize components versions


### Dependencies

* The following workspace dependencies were updated
  * dependencies
    * @esri/calcite-components bumped from ^2.8.1-hotfix.0 to ^2.8.1
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
benelan pushed a commit that referenced this pull request May 14, 2024
@calcite-admin @benelan
chore: release hotfix (#9308)
3a4f5ed 
🤖 I have created a release *beep* *boop*
---

<details><summary>@esri/calcite-components: 2.8.1</summary>

[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.8.0...@esri/calcite-components@2.8.1)
(2024-05-14)

* Add type-fest as dependency due to build error
([3819688](3819688))
* **carousel:** Animate items with the same direction
([#9325](#9325))
([6bf7b74](6bf7b74))
* **input, input-number, input-text:** Restore `autofocus`,
`enter-key-mode` and `input-mode` attributes
([#9245](#9245))
([#9306](#9306))
([0498c6e](0498c6e))
* **list-item:** Decrease horizontal spacing between selection icon and
content
([#9304](#9304))
([0e828b6](0e828b6))
</details>

<details><summary>@esri/calcite-components-angular: 2.8.1</summary>

[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.8.0...@esri/calcite-components-angular@2.8.1)
(2024-05-14)

* **@esri/calcite-components-angular:** Synchronize components versions

* The following workspace dependencies were updated
  * dependencies
    * @esri/calcite-components bumped from ^2.8.1-hotfix.0 to ^2.8.1
</details>

<details><summary>@esri/calcite-components-react: 2.8.1</summary>

[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.8.0...@esri/calcite-components-react@2.8.1)
(2024-05-14)

* **@esri/calcite-components-react:** Synchronize components versions

* The following workspace dependencies were updated
  * dependencies
    * @esri/calcite-components bumped from ^2.8.1-hotfix.0 to ^2.8.1
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
@benelan benelan mentioned this pull request May 14, 2024
Merged
benelan added a commit that referenced this pull request May 14, 2024
@benelan @calcite-admin
chore: release hotfix (#9338)
3153012 
🤖 I have created a release *beep* *boop*
---

<details><summary>@esri/calcite-components: 2.8.1</summary>


[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components@2.8.0...@esri/calcite-components@2.8.1)
(2024-05-14)

* Add type-fest as dependency due to build error
([3819688](3819688))
* **carousel:** Animate items with the same direction
([#9325](#9325))
([6bf7b74](6bf7b74))
* **input, input-number, input-text:** Restore `autofocus`,
`enter-key-mode` and `input-mode` attributes
([#9245](#9245))
([#9306](#9306))
([0498c6e](0498c6e))
* **list-item:** Decrease horizontal spacing between selection icon and
content
([#9304](#9304))
([0e828b6](0e828b6))
</details>

<details><summary>@esri/calcite-components-angular: 2.8.1</summary>


[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-angular@2.8.0...@esri/calcite-components-angular@2.8.1)
(2024-05-14)

* **@esri/calcite-components-angular:** Synchronize components versions

* The following workspace dependencies were updated
  * dependencies
    * @esri/calcite-components bumped from ^2.8.1-hotfix.0 to ^2.8.1
</details>

<details><summary>@esri/calcite-components-react: 2.8.1</summary>


[2.8.1](https://github.com/Esri/calcite-design-system/compare/@esri/calcite-components-react@2.8.0...@esri/calcite-components-react@2.8.1)
(2024-05-14)

* **@esri/calcite-components-react:** Synchronize components versions

* The following workspace dependencies were updated
  * dependencies
    * @esri/calcite-components bumped from ^2.8.1-hotfix.0 to ^2.8.1
</details>

---
This PR was generated with
[ReleasePlease](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: Calcite Admin <calcite-admin@esri.com>
@calcite-admin calcite-admin mentioned this pull request May 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@driskull driskull driskull approved these changes

Assignees

@jcfranco jcfranco

Labels
bug Bug reports for broken functionality. Issues should include a reproduction of the bug. skip visual snapshots Pull requests that do not need visual regression testing.
Projects
None yet
Milestone
2024-05-14 - May maintenance release
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jcfranco @driskull @geospatialem