Skip to main content

Migrations

Here's how to upgrade between various versions of ES UI components.

v5.x.x to v6.x.x​

  1. Update the package to the latest version.

  2. Update CSS imports for UI components styles.

Font enhancements:

- @eightshift/ui-components/dist/assets/wp-font-enhancements.css
+ @eightshift/ui-components/dist/assets/wp-overrides/replace-fonts.css

General style tweaks/overrides (now modular, pick&choose enhancements you want):

- @eightshift/ui-components/dist/assets/wp-ui-enhancements.css
+ @eightshift/ui-components/dist/assets/wp-overrides/fix-label-text-case.css
+ @eightshift/ui-components/dist/assets/wp-overrides/increase-sidebar-width.css
+ @eightshift/ui-components/dist/assets/wp-overrides/make-block-messages-nicer.css
+ @eightshift/ui-components/dist/assets/wp-overrides/restyle-tooltips.css
+ @eightshift/ui-components/dist/assets/wp-overrides/round-corners.css
+ @eightshift/ui-components/dist/assets/wp-overrides/unify-button-sizes.css
+ @eightshift/ui-components/dist/assets/wp-overrides/allow-full-width-blocks.css
  1. Selects

Check all Select, AsyncSelect, MultiSelect, AsyncMultiSelect components, remove any references to legacy react-select components (name starting with RS)

AsyncSelect/AsyncMultiSelect: change loadOptions prop for fetchFunction.

  1. ComponentToggle

If used, try to replace with a Toggle and conditional rendering. The component is marked as deprecated, but won't be removed until v7.

  1. Misc. minor updates:
  • ContainerPanel
    Re-add topBorder if desired
  • Tabs
    Replace pillInverse, pillCompactInverse, pillOutline, and pillCompactOutline styles if used
  • OptionsPanelIntro
    Remove border prop if set
  • NumberPicker
    Update values for the size prop if set; 'compact' | 'small' | 'default' → 'small' | 'medium' | 'default' | 'large'
  • NumberPicker
    If using <Button> as a custom control within, add slot={null}

v1.x.x to v2.0.1​

  1. Update the package to the latest version.

  2. Remove all font imports.

- @import '~@eightshift/ui-components/dist/assets/fonts.css';
  1. Replace editor imports

application-blocks-editor.css

@import '~@eightshift/ui-components/dist/assets/wp-font-enhancements.css';
- @import '~@eightshift/ui-components/dist/assets/style.css';
+ @import '~@eightshift/ui-components/dist/assets/style-editor.css';

application-admin.css

- @import '~@eightshift/ui-components/dist/assets/style.css';
+ @import '~@eightshift/ui-components/dist/assets/style-admin.css';
  1. Replace CSS reset classes
- es-uic-has-css-reset
+ es:css-reset
  1. Replace all es-uic- classes with es: classes (be careful with the order of operators!)