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

Deprecate usage of iconDescription for v11 #9624

Closed
8 of 23 tasks
Tracked by #9535
joshblack opened this issue Sep 8, 2021 · 2 comments
Closed
8 of 23 tasks
Tracked by #9535

Deprecate usage of iconDescription for v11 #9624

joshblack opened this issue Sep 8, 2021 · 2 comments

Comments

@joshblack
Copy link
Contributor

joshblack commented Sep 8, 2021

We currently use the iconDescription prop in the following components: Link

We want iconDescription to no longer be needed. The accessible label for a component should come from either content or a direct aria-label, aria-labelledby, or aria-describedby prop.

  • Select
  • Button (should be deprecated with IconButton)
  • TimePickerSelect (I think this can be deprecated / removed)
  • RadioTile
  • SelectableTile
  • SearchFilterButton deprecated
  • OverflowMenu (used for aria-label and <title>, should change to label)
  • NumberInput (used for both increment and decrement buttons)
  • NotificationButton (used for label on button, no tooltip)
  • NotificationIcon (used for <title> in SVG)
  • ToastNotification (passed to NotificationButton for close)
  • InlineNotification (passed to NotificationButton for close)
  • Modal (uses iconDescription for close label)
  • InlineLoading (could use label, mismatch with Loading which uses description)
  • FileUploaderItem (this gets passed to Filename)
  • Filename (should this just be label?)
  • FileUploader (this gets passed to Filename)
  • DatePickerInput (is this needed for this input?)
  • TableToolbarMenu (this gets passed to OverflowMenu)
  • TableBatchAction (this gets passed to Button)
  • CopyButton (updated to use label)
  • ModalHeader (used for close icon label)
  • AccordionItem
@joshblack joshblack mentioned this issue Sep 8, 2021
20 tasks
@joshblack joshblack changed the title iconDescription Deprecate usage of iconDescription for v11 Sep 8, 2021
@joshblack
Copy link
Contributor Author

Deprecation warning should read something like:

The iconDescription prop is no longer needed and can be safely removed. This prop will be removed in the next major release of Carbon.

OR

The iconDescription prop has been deprecated, use the soAndSo prop instead. This prop will be removed in the next major release of Carbon.

@dlavrenuek
Copy link

@joshblack Now that the iconDescription is gone from ToastNotification it is no longer possible to set a localized title for the close button (NotificationButton). This does not seem to be the desired behavior, is there already a plan to have this title being set with other means?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants