Skip to content

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

Closed
@abp6318

Description

@abp6318

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

Metadata

Metadata

Labels

4 - verifiedIssues that have been tested, confirmed as mitigated, and are ready to close.ArcGIS HubIssues logged by ArcGIS Hub team members.bugBug reports for broken functionality. Issues should include a reproduction of the bug.calcite-componentsIssues specific to the @esri/calcite-components package.docsIssues relating to documentation updates only.estimate - 1Very small fix or change (potentially a single line), doesn't require updates to tests.impact - p2 - want for an upcoming milestoneUser set priority impact status of p2 - want for an upcoming milestonep - highIssue should be addressed in the current milestone, impacts component or core functionality

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions