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.

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

combobox-item: label vs heading vs textLabel mix-up in code and documentation #10321

Open
2 of 6 tasks
abp6318 opened this issue Sep 16, 2024 · 1 comment
Open
2 of 6 tasks
Labels
0 - new New issues that need assignment. ArcGIS Hub Issues logged by ArcGIS Hub team members. bug Bug reports for broken functionality. Issues should include a reproduction of the bug. calcite-components Issues specific to the @esri/calcite-components package. docs Issues relating to documentation updates only. estimate - 1 Very small fix or change (potentially a single line), doesn't require updates to tests. impact - p2 - want for an upcoming milestone User set priority impact status of p2 - want for an upcoming milestone p - high Issue should be addressed in the current milestone, impacts component or core functionality

Comments

@abp6318
Copy link
Contributor

abp6318 commented Sep 16, 2024

Check existing issues

Actual Behavior

textLabel is now deprecated, and label and heading are the new go-tos, but removing textLabel from the combobox-items causes the combobox to not render correctly.

bug

ALSO

The combobox-item documentation is a bit funny looking, where the textLabel is both deprecated and required
Screenshot 2024-09-16 at 1 32 49 PM

Expected Behavior

label and heading are sufficient for the combobox to render the items and chips correctly.

Reproduction Sample

https://codepen.io/AaronPutterman/pen/JjQqgyW?editors=1000

Reproduction Steps

  1. Create a combobox with combobox-items
  2. Provide only a label and heading attribute to the combobox-items
  3. Render the combobox and select any of the items

Reproduction Version

v2.12.2

Relevant Info

Chrome Version 128.0.6613.138 (Official Build) (arm64), MacOS, 16-inch 2023, Apple M2 Pro

Regression?

v2.8 was the last version we used

Priority impact

impact - p2 - want for an upcoming milestone

Impact

More confusing than anything, and we can use textLabel in the mean-time

Calcite package

  • @esri/calcite-components
  • @esri/calcite-components-angular
  • @esri/calcite-components-react
  • @esri/calcite-design-tokens
  • @esri/eslint-plugin-calcite-components

Esri team

ArcGIS Hub

@abp6318 abp6318 added 0 - new New issues that need assignment. bug Bug reports for broken functionality. Issues should include a reproduction of the bug. needs triage Planning workflow - pending design/dev review. labels Sep 16, 2024
@github-actions github-actions bot added ArcGIS Hub Issues logged by ArcGIS Hub team members. calcite-components Issues specific to the @esri/calcite-components package. impact - p2 - want for an upcoming milestone User set priority impact status of p2 - want for an upcoming milestone labels Sep 16, 2024
@jcfranco jcfranco changed the title combobox-item: label vs heading vs textLabel mix-up in code and documentaiton combobox-item: label vs heading vs textLabel mix-up in code and documentation Nov 5, 2024
@geospatialem geospatialem added docs Issues relating to documentation updates only. p - high Issue should be addressed in the current milestone, impacts component or core functionality estimate - 1 Very small fix or change (potentially a single line), doesn't require updates to tests. and removed needs triage Planning workflow - pending design/dev review. labels Nov 5, 2024
@geospatialem
Copy link
Member

We should also include a linting rule to ensure deprecated properties are not also required as part of the above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - new New issues that need assignment. ArcGIS Hub Issues logged by ArcGIS Hub team members. bug Bug reports for broken functionality. Issues should include a reproduction of the bug. calcite-components Issues specific to the @esri/calcite-components package. docs Issues relating to documentation updates only. estimate - 1 Very small fix or change (potentially a single line), doesn't require updates to tests. impact - p2 - want for an upcoming milestone User set priority impact status of p2 - want for an upcoming milestone p - high Issue should be addressed in the current milestone, impacts component or core functionality
Projects
None yet
Development

No branches or pull requests

2 participants