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

Add core component CatalogAutocomplete and use for Catalog entity filters #27363

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

jroebu14
Copy link
Contributor

@jroebu14 jroebu14 commented Oct 25, 2024

Hey, I just made a Pull Request!

Adds a new component CatalogAutocomplete to @backstage/catalog-react that has opinion on label and input styles and composition as well as the options popup animation style.

The new CatalogAutocomplete tries not to deviate from the original MUI Autocomplete component with regards to the API.

Use the CatalogAutocomplete component to align autocompletes visual style and labelling with the Select component from @backstage/core-components.

Demo

Below is a before and after video demoing the interacting with the catalog filters. The top 2 filters are Select components and the rest are Autocomplete components.

Before

Notice the visual differences such as bgColor, icon positioning, labels and popup animations.

Autocomplete_Select.Before.mp4

After

The Select and Autocomplete components are aligned visually by use of a reusable component added to @backstage/core-components.

Autocomplete_Select.After.mp4

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

@github-actions github-actions bot added the area:catalog Related to the Catalog Project Area label Oct 25, 2024
@backstage-goalie
Copy link
Contributor

backstage-goalie bot commented Oct 25, 2024

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage/plugin-catalog-react plugins/catalog-react patch v1.14.3-next.2

@jroebu14 jroebu14 force-pushed the select-and-autocomplete-ui-alignments branch 3 times, most recently from a95df1f to 105f44b Compare October 25, 2024 15:55
@jroebu14 jroebu14 marked this pull request as ready for review October 25, 2024 15:57
@jroebu14 jroebu14 requested review from a team as code owners October 25, 2024 15:57
@jroebu14 jroebu14 requested review from Rugvip and camilaibs October 25, 2024 15:57
Copy link
Contributor

@camilaibs camilaibs left a comment

Choose a reason for hiding this comment

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

Looks great to me, It is just missing the changeset file and I left a question about a potential breaking change. Please take a look 🙂

plugins/catalog-react/report.api.md Outdated Show resolved Hide resolved
@jroebu14 jroebu14 force-pushed the select-and-autocomplete-ui-alignments branch 3 times, most recently from 3e75b52 to 6acafa2 Compare November 5, 2024 09:54
@jroebu14 jroebu14 changed the title Add new core component Autocomplete and use for entity pickers Add new core component Autocomplete and use for Catalog entity filters Nov 6, 2024
@jroebu14 jroebu14 requested a review from camilaibs November 11, 2024 08:51
Copy link
Member

@vinzscam vinzscam left a comment

Choose a reason for hiding this comment

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

this is great!

'@backstage/plugin-catalog-react': patch
---

Uses new Autocomplete component from core-components that aligns with Select component UI for consistent a dropdown UI for all catalog filters
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we could split this changeset in two to have a better description for the changes in core-components

@jroebu14 jroebu14 requested review from a team, awanlin and pjungermann as code owners November 18, 2024 10:31
@jroebu14 jroebu14 force-pushed the select-and-autocomplete-ui-alignments branch from 6775b74 to 791515f Compare November 18, 2024 10:47
@github-actions github-actions bot removed the storybook https://backstage.io/storybook label Nov 18, 2024
@jroebu14 jroebu14 force-pushed the select-and-autocomplete-ui-alignments branch 2 times, most recently from ff18be1 to 1a578b9 Compare November 18, 2024 11:30
Copy link
Contributor

github-actions bot commented Dec 2, 2024

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

@github-actions github-actions bot added the stale label Dec 2, 2024
@github-actions github-actions bot closed this Dec 9, 2024
@jroebu14 jroebu14 reopened this Dec 9, 2024
@github-actions github-actions bot removed the stale label Dec 9, 2024
@camilaibs
Copy link
Contributor

Hi @jroebu14 and @backstage/maintainers would we like to proceed with this pull request, or will this component be added to Canon?

@jroebu14 jroebu14 force-pushed the select-and-autocomplete-ui-alignments branch 2 times, most recently from b202772 to 2782323 Compare December 12, 2024 16:18
@jroebu14
Copy link
Contributor Author

Hi @jroebu14 and @backstage/maintainers would we like to proceed with this pull request, or will this component be added to Canon?

@camilaibs we've decided to remove the Autcomplete component from core-components and place it in catalog-react. When there is a need for this component to exist in a few more places then we can revisit adding it to core-components.

This of course means the PR will need re-reviewed.

@jroebu14 jroebu14 requested a review from vinzscam December 12, 2024 16:20
@jroebu14 jroebu14 changed the title Add new core component Autocomplete and use for Catalog entity filters Add core component CatalogAutocomplete and use for Catalog entity filters Dec 12, 2024
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
Signed-off-by: Jonathan Roebuck <jroebuck@spotify.com>
@jroebu14 jroebu14 force-pushed the select-and-autocomplete-ui-alignments branch from 2782323 to 893e92f Compare December 16, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:catalog Related to the Catalog Project Area
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants