Skip to content

Release v1.0.0
Compare
Choose a tag to compare
@github-actions github-actions released this 04 Feb 06:38
· 1324 commits to main since this release
v1.0.0
baf1112

The first major version is here! 🎉

Version 1.0.0 introduces large updates to the design system like updating to MUI v5, changing Storybook environment and changing the DatePicker component. It introduces a lot of breaking changes and the migration from previous versions should be done carefully. We acknowledge there might be some stones that were left unturned so if you run into any issues please open a new issue here!

Changes

🆙 MUI v5 upgrade

  • MUI is a core dependency of the design system and this update focused on customisation developer experience.
  • Changes styling library to emotion and styling can now mostly done with the efficient sx prop
  • If you used the design system components previously in your project we recommend checking out the MUI migration guide for details about the changes

📚 Changing Storybook environment from CRA to Next.js

  • Doesn't change the npm package but focuses on the Storybook documentation and contributor experience
  • Changes old CRA environment to current go-to React env, Next.js
  • Simplifies eslint config and adds eslint-plugin-storybook
  • Move stories under their own folder

📆 Datepicker upgrade

  • Changes the underlying Datepicker component used from react-dates to MUI datepicker. React-dates was not actively maintained and running old versions of dependencies so this was a very welcome change.
  • The datepicker now doesn't enforce a single date utility library but instead provides support for Moment, DateFns, Dayjs and Luxon.
  • Changes the look and feel of the Datepicker component, adds a quick year selection
  • Removes support for date range selection which will be added at a later stage

📦 New component: Box and other minor changes

  • New Box component for easy styling with the sx prop, Box basically acts as a HTML div element that you can apply sx styles to
  • Paper now also has a story for easier discovery of the component. Paper is fairly similar to Box but has built-in elevation
  • One of the underlying components for DropdownMenu, MenuList, was replaced with Menu
  • MUI system props are hidden in stories but can be used with most components. But we recommend using the sx prop instead of these
Assets 2
Loading