close
Skip to content

Components: Fix icon condition for Badge#68588

Merged
Mamaduka merged 1 commit intotrunkfrom
fix/component-badge-intent-icon
Jan 10, 2025
Merged

Components: Fix icon condition for Badge#68588
Mamaduka merged 1 commit intotrunkfrom
fix/component-badge-intent-icon

Conversation

@Mamaduka
Copy link
Copy Markdown
Member

What?

PR fixes a condition when a Badge might render an icon; now, it depends on the value returned by the contextBasedIcon helper.

Why?

While TypeScript will inform consumers that they're passing an invalid value as intent, components can also be accessed via wp.component, which allows users to pass unsupported intents like - alert.

Testing Instructions

  • All unit tests for the Badge component are passing.
  • Smoke text the component in Storybook - npm run storybook:dev.

Testing Instructions for Keyboard

Same

Screenshots or screencast

CleanShot 2025-01-10 at 11 09 53

@Mamaduka Mamaduka added [Type] Bug An existing feature does not function as intended [Feature] UI Components Impacts or related to the UI component system labels Jan 10, 2025
@Mamaduka Mamaduka self-assigned this Jan 10, 2025
@Mamaduka Mamaduka requested a review from ajitbohra as a code owner January 10, 2025 07:14
@Mamaduka Mamaduka force-pushed the fix/component-badge-intent-icon branch from d99868d to 7922597 Compare January 10, 2025 08:49
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 10, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: ciampo <mciampini@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link
Copy Markdown

Flaky tests detected in 7922597.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12706234639
📝 Reported issues:

className
) }
className={ clsx( 'components-badge', className, {
[ `is-${ intent }` ]: intent,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we also apply the is-intent classname only if hasIcon ?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Not a big difference. IMO, this method is more future-proof and will avoid is-undefined if we ever remove the default for the intent prop.

Copy link
Copy Markdown
Contributor

@ciampo ciampo left a comment

Choose a reason for hiding this comment

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

🚀

@Mamaduka
Copy link
Copy Markdown
Member Author

Thanks, Marco. I'm going to skip the changelog entry since this is a private component.

@Mamaduka Mamaduka merged commit 79234bd into trunk Jan 10, 2025
@Mamaduka Mamaduka deleted the fix/component-badge-intent-icon branch January 10, 2025 09:50
@github-actions github-actions bot added this to the Gutenberg 20.1 milestone Jan 10, 2025
Gulamdastgir-Momin pushed a commit to Gulamdastgir-Momin/gutenberg that referenced this pull request Jan 23, 2025
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: ciampo <mciampini@git.wordpress.org>
chriszarate pushed a commit to chriszarate/gutenberg that referenced this pull request Jul 1, 2025
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Co-authored-by: ciampo <mciampini@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Feature] UI Components Impacts or related to the UI component system [Type] Bug An existing feature does not function as intended

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants