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

fix(deps): update dependency @openedx/paragon to v22 #2357

Merged
merged 1 commit into from
Jan 23, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jan 22, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@openedx/paragon ^21.5.7 -> ^22.0.0 age adoption passing confidence

Release Notes

openedx/paragon (@​openedx/paragon)

v22.0.0

Compare Source

This release contains breaking changes to the following 4 components:

  • Chip
  • Pagination
  • SearchField
  • Form.Autosuggest

Breaking Changes

Chip

This updates the Chip component to reflect the design spec as intended.

BREAKING CHANGE: Many of the SCSS variables (i.e., tokens) surrounding Chip were removed. Consumers should verify no longer using any of the removed SCSS variables in custom Paragon brands/themes.

Pagination

This updates the Pagination component to rely on the proper button variants, rather than having all pagination buttons be of the primary variant (even when unselected) with custom styles overriding the default button variant style (e.g., background color).

It also refactors the component to be more maintainable moving forward.

BREAKING CHANGE: Many of the SCSS variables (i.e., tokens) surrounding Pagination were removed. Consumers should verify no longer using any of the removed SCSS variables in custom Paragon brands/themes.

BREAKING CHANGE: icons prop now accepts the icon src instead of an Icon component.

Before

<Pagination
  ...
  icons={{
    leftIcon: <Icon src={ChevronLeft} />,
    rightIcon: <Icon src={ChevronRight} />,
  }}
/>

After

<Pagination
  ...
  icons={{
    leftIcon: ChevronLeft,
    rightIcon: ChevronRight,
  }}
/>
SearchField

This updates the SearchField component to rely on IconButton components for its actions (e.g., reset, submit). It also ensures the external submit button in the dark variant has appropriate hover styles.

BREAKING CHANGE: icons prop now accepts the icon src instead of an Icon component.

Before

<SearchField
  ...
  icons={{
    submit: <Icon src={Search} />,
    clear: <Icon src={Close} />,
  }}
/>

After

<SearchField
  ...
  icons={{
    submit: Search,
    clear: Close,
  }}
/>
Form.Autosuggest

This updates the Autosuggest component to provide the consumer with:

  • The value entered in the textbox by the user
  • The selected value (as it is displayed in the dropdown)
  • The id of the selected option

This also allows the consumer to determine if the component should be in an error state when:

  • No text has been entered
  • Text has been entered, but not selection has been made
  • An external validation check has failed - "customError"

The consumer will provide error messages for the appropriate error states.

BREAKING CHANGE: value prop of Form.Autosuggest is now an object instead of a string

BREAKING CHANGE: Form.Autosuggest now uses onChange instead of onSelected

BREAKING CHANGE: Form.Autosuggest now takes in different error messages for value/selection required, and custom errors


Configuration

📅 Schedule: Branch creation - "before 6am every weekday" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/openedx-paragon-22.x branch from f8c85e9 to 954de73 Compare January 23, 2024 16:40
@deborahgu deborahgu merged commit fcadb1c into master Jan 23, 2024
6 of 7 checks passed
@deborahgu deborahgu deleted the renovate/openedx-paragon-22.x branch January 23, 2024 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant