npm package: @mxenabled/mxui
Description: Package containing MX theme and common controls for MUI
Author: MX
Latest version: 2.3.0

## Getting started
In order to run the project you will need to make sure that you have yarn installed. It must be higher than 1.22 in order to do that you must have corepack enabled. Do not just run "npm i" to install dependencies, all packages must be installed with yarn.

1. Install [yarn](https://yarnpkg.com/getting-started/install)
1. From the project root dir, run `yarn` or `yarn install` to install dependencies
1. To start the project run `yarn dev` (the project should automatically run in the browser, showing the storybook docs)

## Questions/Help

There are several places you can get answers to your questions:
- this readme document
- the changelog file in this repo
- the storybook documentation: [introduction](https://mxui.kube.qa.internal.mx/?path=/docs/introduction--docs), [contributing](https://mxui.kube.qa.internal.mx/?path=/docs/contributing--docs), [theming](https://mxui.kube.qa.internal.mx/?path=/docs/mxui-components-theming--docs)
- the #design-system slack channel. don't be shy.

## Using this Library

The QA storybook containing the latest changes is [accessible here](https://mxui.kube.qa.internal.mx/?path=/docs/introduction--docs). (you need to be connected to the vpn to view this since it is in the qa environment)

Follow the setup instructions found in the storybook.

Teams are currently adding components as needed, so the list in storybook right now is what has been built so far. Follow the instructions in [the contributing section](https://mxui.kube.qa.internal.mx/?path=/docs/contributing--docs) of the storybook docs to add to this project.

## Contributing

If your MR includes any changes outside of documentation, you will need to ensure the following:

1. Update the `CHANGELOG.md` as part of your MR.
1. Do not update the version in the `package.json` file, as it will be handled automatically by `shipit`.

## Merging and Publishing
To merge and publish, comment `shipit --publish-version=major/minor/patch` once the MR is approved.  
Shipit will handle version bumping based on the specified flag (major, minor, or patch), publish the package to the npm registry, merge the MR into the master branch, and create a corresponding tag.

> **Note:** If an alpha version is to be published, update the package version to include a pre-release identifier like `1.2.3-alpha.1` or `1.2.3-v1` and run the `publish:nodejs-npmregistry` job to publish that alpha version.

## Upgrading from 1.x to 2.x
This major change introcuces a number of breaking changes due to dependency upgrades for React 19 and MUI 7. It also 
includes removal of deprected components and theme values.

- React has been upgraded to version 19.
  - See https://react.dev/blog/2024/04/25/react-19-upgrade-guide for more details.
- MUI has been upgraded to version 7.
  - See https://mui.com/material-ui/migration/upgrade-to-v6/ for changes from 5 to 6.
  - See https://mui.com/material-ui/migration/upgrade-to-v7/ for changes from 6 to 7.
- MUI-X has been upgraded to version 8.
  - See https://mui.com/x/migration/migration-pickers-v7/ for Date picker changes
  - See https://mui.com/x/migration/migration-data-grid-v7/ for Data Grid changes
  - See https://mui.com/x/migration/migration-charts-v7/ for Chart changes
- Vite has been upgraded to version 7.
  - See https://vite.dev/guide/migration.html for more details.
- Storybook has been upgraded to version 9.
  - See https://storybook.js.org/docs/releases/migration-guide for more details
- `TokenProvider` and it's dependency `@mxenabled/mx-design-tokens` has been removed.
- The palette color `border` has been removed. Utilize `neutral`, `grey` or `divider` instead.
- The palette color properties for `lighter` & `darker` have been removed. Utilize `light` & `dark` instead.
- Custom Typography variants have been removed. Use the standard MUI variants instead.
  - H1 -> h1
  - H2 -> h2
  - H3 -> h3
  - Body -> body1
  - Small -> body2
  - XSmall -> caption
  - Tiny -> tiny
  - Button -> button
  - Paragraph -> subtitle1
  - ParagraphSmall -> subtitle2
- Deprecated icons have been removed. Use Material Symbol icons via the `Icon` component or directly from the MX-Icons package instead.