Migrations
Here’s how to upgrade between various versions of ES UI components.
v5.x.x to v6.x.x
Section titled “v5.x.x to v6.x.x”-
Update the package to the latest version.
-
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.cssGeneral 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- 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.
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.
- Misc. minor updates:
ContainerPanel
Re-addtopBorderif desiredTabs
ReplacepillInverse,pillCompactInverse,pillOutline, andpillCompactOutlinestyles if usedOptionsPanelIntro
Removeborderprop if setNumberPicker
Update values for thesizeprop if set;'compact' | 'small' | 'default'→'small' | 'medium' | 'default' | 'large'NumberPicker
If using<Button>as a custom control within, addslot={null}
v1.x.x to v2.0.1
Section titled “v1.x.x to v2.0.1”-
Update the package to the latest version.
-
Remove all font imports.
@import '~@eightshift/ui-components/dist/assets/fonts.css';- 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';- Replace CSS reset classes
es-uic-has-css-resetes:css-reset- Replace all
es-uic-classes withes:classes (be careful with the order of operators!)