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

chore(AI Label): web components - rename Slug to AI Label #17739

Merged
merged 21 commits into from
Oct 22, 2024
Merged

chore(AI Label): web components - rename Slug to AI Label #17739

merged 21 commits into from
Oct 22, 2024

Conversation

annawen1
Copy link
Member

@annawen1 annawen1 commented Oct 14, 2024 •
edited
Loading

Closes #17697

This PR renames the slug component to ai-label in the web-components package and brings it out of experimental.

To prevent a breaking change, we are keeping the slug component and its references in the related components.

Changelog

Changed

  • Moved the AI Label Data Table + Example stories into their own component stories (each component has their own With AI Label story) for:
    • data-table
    • checkbox
    • combobox
    • date-picker
    • dropdown
    • modal
    • multiselect
    • number-input
    • radio-button
    • select
    • tag
    • text-input
    • textarea
    • tile
  • Renamed all instances of slug and related properties to ai-label
  • set AI Label component within the stable "Components" section of storybook
  • add deprecated notices to the cds-slug and cds-slug-action-button components

Removed

  • consolidated AI Slug / Label stories

Testing / Reviewing

View the new separate With AI Label stories for each of the components listed above in the deploy preview

@annawen1 annawen1 changed the title Chore(AI Label): web components - rename Slug to AI Label chore(AI Label): web components - rename Slug to AI Label Oct 14, 2024
@netlify Netlify
Copy link

netlify bot commented Oct 14, 2024 •
edited
Loading

✅ Deploy Preview for carbon-elements ready!

Name Link
🔨 Latest commit c37c2a6
🔍 Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/6717fd411623560008f2540c
😎 Deploy Preview https://deploy-preview-17739--carbon-elements.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify Netlify
Copy link

netlify bot commented Oct 14, 2024 •
edited
Loading

✅ Deploy Preview for v11-carbon-react ready!

Name Link
🔨 Latest commit c37c2a6
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-react/deploys/6717fd41dcfd9f000863f33b
😎 Deploy Preview https://deploy-preview-17739--v11-carbon-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov Codecov
Copy link

codecov bot commented Oct 14, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.14%. Comparing base (7115f33) to head (c37c2a6).
Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #17739   +/-   ##
=======================================
  Coverage   80.14%   80.14%           
=======================================
  Files         406      406           
  Lines       14029    14029           
  Branches     4391     4363   -28     
=======================================
  Hits        11243    11243           
+ Misses       2620     2619    -1     
- Partials      166      167    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@netlify Netlify
Copy link

netlify bot commented Oct 16, 2024 •
edited
Loading

✅ Deploy Preview for v11-carbon-web-components ready!

Name Link
🔨 Latest commit c37c2a6
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-web-components/deploys/6717fd4120300f000884f74f
😎 Deploy Preview https://deploy-preview-17739--v11-carbon-web-components.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@annawen1 annawen1 marked this pull request as ready for review October 16, 2024 23:32
@annawen1 annawen1 requested a review from a team as a code owner October 16, 2024 23:32
alisonjoseph
alisonjoseph approved these changes Oct 18, 2024
View reviewed changes
Copy link
Member

@alisonjoseph alisonjoseph left a comment

Choose a reason for hiding this comment

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

This LGTM.

One question, will this break things for anyone currently using the Slug? I know in React we kept the slug export with the rename/move to stable, but wasn't sure if there was a similar way to do that in web components.

@annawen1
Copy link
Member Author

This LGTM.

One question, will this break things for anyone currently using the Slug? I know in React we kept the slug export with the rename/move to stable, but wasn't sure if there was a similar way to do that in web components.

Oh hmm yeah it would break for folks, I was assuming since it was in experimental we would be able to rename without worrying about it being a breaking change. We could keep Slug around as its own component and I add a check to the components that can have the AI Label to see if they're using cds-slug or cds-ai-label

@annawen1 annawen1 force-pushed the chore/wc-slug-to-label branch from 7d70b23 to 2aa30ca Compare October 22, 2024 15:52
ariellalgilmore
ariellalgilmore approved these changes Oct 22, 2024
View reviewed changes
Copy link
Member

@ariellalgilmore ariellalgilmore left a comment

Choose a reason for hiding this comment

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

awesome updates! LGTM!

@annawen1 annawen1 enabled auto-merge October 22, 2024 19:42
@annawen1 annawen1 added this pull request to the merge queue Oct 22, 2024
Merged via the queue into carbon-design-system:main with commit b543079 Oct 22, 2024
26 of 27 checks passed
@annawen1 annawen1 deleted the chore/wc-slug-to-label branch October 22, 2024 20:51
@carbon-automation
Copy link
Contributor

Hey there! v11.69.0 was just released that references this issue/PR.

irfadkp pushed a commit to irfadkp/carbon that referenced this pull request Oct 24, 2024
@annawen1 @irfadkp
chore(AI Label): web components - rename Slug to AI Label (carbon-des…
6a63abd 
…ign-system#17739)

* chore: rename ai slug to ai label

* chore: rename to ai-label

* chore: rename slug example to ai-label

* chore: add ai label to form group stories

* chore: rename handle slug slot change methods

* chore: all stories shifted

* fix: fix radio-button with ai-label

* fix: modal ai-label styles

* chore: rename test files to ai-label

* chore: add space between AI and Label in docs

* chore: undo changes to tearsheet and side-panel

* chore: keep slug component as deprecated

* chore: restore readme

* fix: specify js extensions for icon imports (carbon-design-system#17818)

* chore: add extensions to icons in stories

* fix: show actions for playground and datatable sort

* fix: catch both slug and ai-label in event handlers
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@guidari guidari guidari approved these changes

@ariellalgilmore ariellalgilmore ariellalgilmore approved these changes

@alisonjoseph alisonjoseph alisonjoseph approved these changes

Assignees
No one assigned
Labels
status: ready for review 👀
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[AI] Rename and bring AI label to stable in Web Components
4 participants
@annawen1 @alisonjoseph @ariellalgilmore @guidari