react-md/CHANGELOG.md

This is the full react-md library bundled together for convenience.

# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## [5.1.6](https://github.com/mlaursen/react-md/compare/v5.1.5...v5.1.6) (2023-12-11)

**Note:** Version bump only for package react-md





## [5.1.5](https://github.com/mlaursen/react-md/compare/v5.1.4...v5.1.5) (2023-05-09)

**Note:** Version bump only for package react-md





## [5.1.4](https://github.com/mlaursen/react-md/compare/v5.1.3...v5.1.4) (2022-06-16)

**Note:** Version bump only for package react-md





## [5.1.3](https://github.com/mlaursen/react-md/compare/v5.1.2...v5.1.3) (2022-05-07)

**Note:** Version bump only for package react-md





## [5.1.2](https://github.com/mlaursen/react-md/compare/v5.1.1...v5.1.2) (2022-04-02)

**Note:** Version bump only for package react-md





## [5.1.1](https://github.com/mlaursen/react-md/compare/v5.1.0...v5.1.1) (2022-04-01)

**Note:** Version bump only for package react-md





# [5.1.0](https://github.com/mlaursen/react-md/compare/v5.0.0...v5.1.0) (2022-03-18)

**Note:** Version bump only for package react-md





# [5.0.0](https://github.com/mlaursen/react-md/compare/v4.0.3...v5.0.0) (2022-01-31)


### Documentation

* Removed Working with v1 documentation ([8aa71ac](https://github.com/mlaursen/react-md/commit/8aa71ac2bc9eccf261c70f53bbfcd02ee0e8663f))


### Other Internal Changes

* Removed commitizen since I never use it ([3e738b4](https://github.com/mlaursen/react-md/commit/3e738b4ab14fd7b4aab4f104b0d4120d226b7747))






## [4.0.3](https://github.com/mlaursen/react-md/compare/v4.0.2...v4.0.3) (2021-12-31)


### Other Internal Changes

* Updated all packages' peerDependenciesMeta ([60fcd71](https://github.com/mlaursen/react-md/commit/60fcd719ac785c2f0b9d27cda82baa3c773c0e5a)), closes [#1319](https://github.com/mlaursen/react-md/issues/1319)






## [4.0.2](https://github.com/mlaursen/react-md/compare/v4.0.1...v4.0.2) (2021-11-30)

**Note:** Version bump only for package react-md





## [4.0.1](https://github.com/mlaursen/react-md/compare/v4.0.0...v4.0.1) (2021-11-27)

**Note:** Version bump only for package react-md





# [4.0.0](https://github.com/mlaursen/react-md/compare/v3.1.1...v4.0.0) (2021-11-24)


### Features

* Update to use new JSX Transform and latest `eslint` ([8111cd3](https://github.com/mlaursen/react-md/commit/8111cd31e45bf60c1b92509264af1b71dfba5696))
* **@react-md/typography:** Renamed Text to `Typography` ([30cf056](https://github.com/mlaursen/react-md/commit/30cf056fbaf0e3d28e04dd03f1fd37929967f7ab))


### Other Internal Changes

* always skip lib check ([229cef1](https://github.com/mlaursen/react-md/commit/229cef1e3d338ea362c1a2eaac06204c84ff21a6))


### Breaking Changes

* Minimum React version is now 16.14 instead of 16.8
* **@react-md/typography:** The Text component has been renamed to Typography to
help with auto-imports conflicting with the Text element that exists in
`lib.d.ts`






## [3.1.1](https://github.com/mlaursen/react-md/compare/v3.1.0...v3.1.1) (2021-09-12)

**Note:** Version bump only for package react-md





# [3.1.0](https://github.com/mlaursen/react-md/compare/v3.0.1...v3.1.0) (2021-09-10)


### Other Internal Changes

* ran `yarn format` to include new files ([48d3d7f](https://github.com/mlaursen/react-md/commit/48d3d7fddb0435edf7dec9d0ba38cf3f0f251709))






## [3.0.1](https://github.com/mlaursen/react-md/compare/v3.0.0...v3.0.1) (2021-08-15)


### Bug Fixes

* Updated peerDependencies to fix yarn berry peer requirements ([250efcd](https://github.com/mlaursen/react-md/commit/250efcdd81ea39c06b08eb30109589c89d9b8e0f)), closes [#1224](https://github.com/mlaursen/react-md/issues/1224)






# [3.0.0](https://github.com/mlaursen/react-md/compare/v2.9.1...v3.0.0) (2021-08-13)


### Bug Fixes

* **sass:** drop node-sass in favor of `sass` since it's deprecated ([126fb5a](https://github.com/mlaursen/react-md/commit/126fb5aa1ad53cd12f183d5eaa349b70af4fceb3))


### Features

* **react-md:** Simplify `sass` usage with: `@use 'react-md';` ([787bfb5](https://github.com/mlaursen/react-md/commit/787bfb51e68d6b5200d43b8658dc33f5fe870584))


### Documentation

* **react-md.dev:** Updated sandboxes for new Sass module system ([095ae97](https://github.com/mlaursen/react-md/commit/095ae97c1d75e152c6fbe1bfce9c809d15cd4985))


### Other Internal Changes

* **react-md.dev:** removed tilde from imports ([6081e14](https://github.com/mlaursen/react-md/commit/6081e145c13ab4f86c2f84da3dbc1988986ffdd2))


### Breaking Changes

* **sass:** `node-sass` is no longer supported and users must switch to `sass`






## [2.9.1](https://github.com/mlaursen/react-md/compare/v2.9.0...v2.9.1) (2021-07-27)


### Other Internal Changes

* **install:** slighly reduce install size by excluding tests in publish ([9d01a44](https://github.com/mlaursen/react-md/commit/9d01a44b81b619d6ac1c4d458005c99838fc6894))






# [2.9.0](https://github.com/mlaursen/react-md/compare/v2.8.5...v2.9.0) (2021-07-18)

**Note:** Version bump only for package react-md





## [2.8.5](https://github.com/mlaursen/react-md/compare/v2.8.4...v2.8.5) (2021-07-03)

**Note:** Version bump only for package react-md





## [2.8.4](https://github.com/mlaursen/react-md/compare/v2.8.3...v2.8.4) (2021-06-10)

**Note:** Version bump only for package react-md





## [2.8.3](https://github.com/mlaursen/react-md/compare/v2.8.2...v2.8.3) (2021-05-18)


### Documentation

* **react-md.dev:** update v1 links to new repo and static hosting ([92801bb](https://github.com/mlaursen/react-md/commit/92801bb457c30540551bc3dbfcc0a7f692044d84))


### Other Internal Changes

* removed v1 info from README ([b0e8ccb](https://github.com/mlaursen/react-md/commit/b0e8ccbfdb47befb39eacd98804f50ec30ae372e))






## [2.8.2](https://github.com/mlaursen/react-md/compare/v2.8.1...v2.8.2) (2021-04-23)

**Note:** Version bump only for package react-md





## [2.8.1](https://github.com/mlaursen/react-md/compare/v2.8.0...v2.8.1) (2021-04-23)

**Note:** Version bump only for package react-md





# [2.8.0](https://github.com/mlaursen/react-md/compare/v2.7.1...v2.8.0) (2021-04-22)


### Other Internal Changes

* **tsconfig:** separate tsconfig by package instead of a single root ([b278230](https://github.com/mlaursen/react-md/commit/b2782303b2a2db07eeaa25b6a3d04337976cffaa))






## [2.7.1](https://github.com/mlaursen/react-md/compare/v2.7.0...v2.7.1) (2021-03-23)

**Note:** Version bump only for package react-md





# [2.7.0](https://github.com/mlaursen/react-md/compare/v2.6.0...v2.7.0) (2021-02-28)

**Note:** Version bump only for package react-md





# [2.6.0](https://github.com/mlaursen/react-md/compare/v2.5.5...v2.6.0) (2021-02-13)

**Note:** Version bump only for package react-md





## [2.5.5](https://github.com/mlaursen/react-md/compare/v2.5.4...v2.5.5) (2021-01-30)

**Note:** Version bump only for package react-md

## [2.5.4](https://github.com/mlaursen/react-md/compare/v2.5.3...v2.5.4) (2021-01-27)

**Note:** Version bump only for package react-md

## [2.5.3](https://github.com/mlaursen/react-md/compare/v2.5.2...v2.5.3) (2021-01-12)

**Note:** Version bump only for package react-md

## [2.5.2](https://github.com/mlaursen/react-md/compare/v2.5.1...v2.5.2) (2021-01-12)

**Note:** Version bump only for package react-md

## [2.5.1](https://github.com/mlaursen/react-md/compare/v2.5.0...v2.5.1) (2020-12-16)

**Note:** Version bump only for package react-md

# [2.5.0](https://github.com/mlaursen/react-md/compare/v2.4.3...v2.5.0) (2020-12-15)

**Note:** Version bump only for package react-md

## [2.4.3](https://github.com/mlaursen/react-md/compare/v2.4.2...v2.4.3) (2020-11-14)

**Note:** Version bump only for package react-md

## [2.4.2](https://github.com/mlaursen/react-md/compare/v2.4.1...v2.4.2) (2020-10-23)

**Note:** Version bump only for package react-md

## [2.4.1](https://github.com/mlaursen/react-md/compare/v2.4.0...v2.4.1) (2020-10-17)

**Note:** Version bump only for package react-md

# [2.4.0](https://github.com/mlaursen/react-md/compare/v2.3.1...v2.4.0) (2020-10-17)

### Features

- [@react-md/theme](../theme): Better Contrast Colors by Default and dev-utils
  refactor ([#955](https://github.com/mlaursen/react-md/issues/955))
  ([519b128](https://github.com/mlaursen/react-md/commit/519b128522de944d55ff96a1e1125447665ed586))

## [2.3.1](https://github.com/mlaursen/react-md/compare/v2.2.0...v2.3.1) (2020-09-15)

**Note:** Version bump only for package react-md

# [2.3.0](https://github.com/mlaursen/react-md/compare/v2.2.0...v2.3.0) (2020-09-10)

**Note:** Version bump only for package react-md

## [2.2.2](https://github.com/mlaursen/react-md/compare/v2.2.1...v2.2.2) (2020-09-02)

**Note:** Version bump only for package react-md

## [2.2.1](https://github.com/mlaursen/react-md/compare/v2.2.0...v2.2.1) (2020-09-02)

**Note:** Version bump only for package react-md

# [2.2.0](https://github.com/mlaursen/react-md/compare/v2.1.2...v2.2.0) (2020-08-11)

**Note:** Version bump only for package react-md

## [2.1.2](https://github.com/mlaursen/react-md/compare/v2.1.1...v2.1.2) (2020-08-01)

**Note:** Version bump only for package react-md

## [2.1.1](https://github.com/mlaursen/react-md/compare/v2.1.0...v2.1.1) (2020-07-21)

**Note:** Version bump only for package react-md

# [2.1.0](https://github.com/mlaursen/react-md/compare/v2.0.4...v2.1.0) (2020-07-12)

**Note:** Version bump only for package react-md

## [2.0.4](https://github.com/mlaursen/react-md/compare/v2.0.3...v2.0.4) (2020-07-10)

**Note:** Version bump only for package react-md

## [2.0.3](https://github.com/mlaursen/react-md/compare/v2.0.2...v2.0.3) (2020-07-07)

**Note:** Version bump only for package react-md

## [2.0.2](https://github.com/mlaursen/react-md/compare/v2.0.1...v2.0.2) (2020-06-30)

### Bug Fixes

- Main `README` `Layout` example
  ([bcc8405](https://github.com/mlaursen/react-md/commit/bcc84056351821fb55cc21327de191f65fe7958a))
- **LICENSE:** Removed the time range from license since it was incorrect
  ([50c9021](https://github.com/mlaursen/react-md/commit/50c9021cedc0d642758b9fd541bb6c93d2fe1786))
- Added `sideEffects` field to `package.json`
  ([31820b9](https://github.com/mlaursen/react-md/commit/31820b9b43705e5849664500a17b6849eb6dc2a9))
- Added unpkg url for base react-md package
  ([d0efc59](https://github.com/mlaursen/react-md/commit/d0efc59aed0b0ccaa9acadb4e8cf8037bad1f3b3))

## v2.0.1

This release just updated the UMD bundle to be separated into three parts to
keep the library as small as possible. This really should not affect anyone even
though it is a "breaking" change.

##### Base react-md library (no material icons)

Development:

- https://unpkg.com/react-md@2.0.1/dist/umd/react-md.development.js

Production:

- https://unpkg.com/react-md@2.0.1/dist/umd/react-md.production.min.js

##### Base react-md library with the Font Icon components for material icons

Development:

- https://unpkg.com/react-md@2.0.1/dist/umd/react-md-with-font-icons.development.js

Production:

- https://unpkg.com/react-md@2.0.1/dist/umd/react-md-with-font-icons.production.min.js

##### Base react-md library with the SVG Icon components for material icons

Development:

- https://unpkg.com/react-md@2.0.1/dist/umd/react-md-with-svg-icons.development.js

Production:

- https://unpkg.com/react-md@2.0.1/dist/umd/react-md-with-svg-icons.production.min.js

### Fixed and updated GZip Size

```sh
v1 size
The gzipped UMD bundle size is:
 - dist/v1/umd/react-md.min.js 98.68 KB

The min and max gzipped CSS bundle sizes are:
 - dist/v1/css/react-md.yellow-red.min.css 13.2 KB
 - dist/v1/css/react-md.blue_grey-deep_purple.min.css 13.23 KB

v2 size
The gzipped UMD bundle size is:
 - dist/umd/react-md.production.min.js 86.49 KB
 - dist/umd/react-md-with-font-icons.production.min.js 196.05 KB
 - dist/umd/react-md-with-svg-icons.production.min.js 196.03 KB

The min and max gzipped CSS bundle sizes are:
 - dist/css/react-md.grey-deep_orange-200-light.min.css 15.65 KB
 - dist/css/react-md.indigo-blue-400-dark.min.css 15.71 KB

```

## v2.0.0

The v2 release is a complete re-write of react-md to address the majority of
problems encountered while using v1. Unfortunately, this took a **lot** longer
than I had hoped since I ended up using this project to learn [Typescript] as
well as the new [React hooks API]. Even though there are some missing components
from v1, I think the new functionality outweighs it and the components are
scoped for a later release.

##### Missing Components and Functionality from v1 <!-- no-margin-bottom -->

Before starting the migration to v2, I highly recommend reviewing the [Working
with v1] guide and reviewing the following missing functionality:

- **dropped full support for IE 11** and mostly targeting evergreen browsers for
  the new dynamic themes
- some styling props have been removed since the new component API should
  hopefully eliminate the need for those props. (These props were normally
  `get*Style`, `get*ClassName`, etc)
- controlling the visibility and value of some components has been removed since
  I struggled figuring out a good way to handle controlled/uncontrolled
  components and hooks. I definitely plan on adding support for this
  functionality back in.
- the `BottomNavigation` component has not been added to the initial v2 release.
  This component might be added at a later time, but the new #app-bar package
  should be able to solve a decent amount of use cases.
- the `DatePicker` and `TimePicker` components have not been added to the
  initial v2 release. These two components will definitely be added in a later
  release, but require a lot more time to implement since **dates are hard** and
  I want to create all the sub-components in a reusable and exportable way for
  additional customization.
- removed the `FileUpload` component since it didn't feel extremely useful since
  it didn't actually upload a file to a server
- the `mini` variants for the `Drawer`/`NavigationDrawer` components have not
  yet been implemented in the new `Layout` component.
- removed the `MenuTab` component due to never really working correctly and the
  new #tabs package should allow for a much better user experience and
  customization.
- removed the `ListItemControl` component since it was implemented pretty badly.
  The new #list and #form packages should allow for this to be re-implemented in
  your app fairly easily though.
- removed the `TablePagination` and `TableCardHeader` components since I wasn't
  sure how helpful they were and didn't really work. The new #table styling
  behavior and customization should allow for a custom implementation fairly
  easily though.
- removed the `EditDialogColumn`, `SelectFieldColumn`, `*Column` components from
  the #table package since they aren't really needed anymore. Form elements
  should be renderable within tables without the weird hacks these components
  were implementing.
- removed the `Version` component since it was probably only ever used by the
  documentation site.

### What's new in v2?

This release focused on updating `react-md` to be as customizable as possible by
exporting a lot more low-level components, hooks, and utils that were used
internally. Something that I noticed from the v1 release is that if something
was not easily customizable or specific components were not public, it was
**easier to actually write your own version of that component**. This was a
major flaw and caused lots of problems especially since the majority of the
functionality behind these components were not reusable. The new components and
hooks should be able to help for these use cases but the down side is that
you'll still need to create a custom implementation for common patterns
throughout your app because some patterns seem repetitive.

#### Rewrite to Typescript

> Note: Upgrading to v2 of `react-md` does **not** require you to also use
> Typescript even though it is highly recommended to do so. You can still use
> `react-md` with JavaScript as you have done before, but all the examples and
> documentation will be written with Typescript.

[v1.1.0](https://mlaursen.github.io/react-md-v1-docs/#/discover-more/whats-new#v1-1-0-released) was the first `react-md`
release to add support for Typescript but unfortunately the type definitions
were [not that great]({{GITHUB_URL}}/blob/v1/src/js/index.d.ts) because I did
not fully understand Typescript and kept getting out of sync or forgotten. Since
Typescript is becoming the new trend for web development with additional tooling
and editor integrations, it seemed like a good time to finally start learning
Typescript and re-write `react-md` to use it natively.

One of the biggest pros for rewriting to Typescript is that now all the
documentation around Component props, hooks, or utils can now be viewed within
your editor or IDE if it supports the `"Go to Definition"` functionality due to
being compiled with the `*.d.ts` files now. In addition, the type definitions
should never be out of sync and should be much more strictly typed than before
since the entire library has been written in Typescript.

That being said, there are a few type definitions that could still be improved
in v2 especially around [generics and Records]({{GITHUB_URL}}/issues/859) so any
suggestions or PRs are welcomed.

#### New Behavior for Determining the Current Application Size

In v1, the `Drawer` and `NavigationDrawer` components were used to be able to
determine the current app size using the static methods: `getCurrentMedia` and
`matchesMedia`. This meant that the only way to determine the current
application size through media queries was to either:

- render a `Drawer` or `NavigationDrawer` components and hook into the
  `onMediaTypeChange` callback prop
- manually create a resize listener and use the
  `Drawer.getCurrentMedia`/`NavigationDrawer.getCurrentMedia` static methods
- implement a custom solution

This solution was pretty terrible and lead to confusion, out-of-sync behavior,
and bugs.

Starting with v2 these issues should be resolved due to React implementing the
new [Context API] along with the new [AppSizeListener] component and media query
SCSS mixins.

##### AppSizeListener Component and useAppSize Hook <!-- no-margin-bottom -->

The new `AppSizeListener` component should be mounted **once** near the root of
your app which will initialize multiple resize and media query event listeners
to determine what size your app is currently being rendered while the
`useAppSize` hook allows access to the current size.

Check out the [AppSizeListener] example for more details and a live demo.

##### Media Query Mixins and Components <!-- no-margin-bottom -->

In addition to the new component and hook, `react-md` now provides a few utility
SCSS mixins for applying styles at different media query sizes:

- [rmd-utils-phone-media]
- [rmd-utils-tablet-media]
- [rmd-utils-tablet-only-media]
- [rmd-utils-desktop-media]
- [rmd-utils-large-desktop-media]

There are also a few media query components which can be used to conditionally
render components based on the current application site. Check out the [Media
Query Components example] for some more information.

#### New Theme API

Since this release dropped IE 11 support, all the dynamic theming is done
through [Custom CSS Properties (CSS Variables)] with the new theme SCSS
functions and mixins. The root #theme package now provides a new `background`
and `surface` color variable to use along with a lot of [other themeable values]
while the other packages will provide themeable variables for colors, margin,
and padding. The new theme API allows you to easily modify existing themes
without all the boilerplate and "hacks" from the v1 release. Here is a quick
example:

####### v1 theme updates <!-- no-margin -->

```scss
.custom-theme--v1 {
  // create smaller icon buttons
  .md-btn--icon {
    height: 1rem;
    font-size: 1rem;
    width: 1rem;
  }

  // updating icon spacing
  .md-icon-text {
    $new-spacing: 0.5rem;

    &:first-child {
      padding-right: $new-spacing;
    }

    &:last-child {
      padding-left: $new-spacing;
    }
  }

  // change theme colors
  @include react-md-theme-colors($md-orange-500, $md-purple-a-200);
}
```

####### v2 theme updates <!-- no-margin -->

```scss
// in v2
.custom-theme--v2 {
  @include rmd-button-theme-update-var(icon-size, 1rem);
  @include rmd-icon-theme-update-var(text-spacing, 0.5rem);
  @include rmd-theme-update-var(primary, $rmd-orange-500);
  @include rmd-theme-update-var(secondary, $rmd-purple-a-200);
}
```

You can also reference the current theme values as a value or CSS Variable:

```scss
.custom-class {
  // use current background-color
  @include rmd-theme(background-color, background);

  // use the current primary text color on the current background color
  @include rmd-theme(color, text-primary-on-background);

  // use the current primary theme color as a border color (for some reason)
  @include rmd-theme(border-color, primary): ;

  // add 1rem to the current CSS Variable value for the icon text spacing
  padding: calc(#{rmd-icon-theme-var(text-spacing)} + 1rem);
}
```

The new theme API is pretty powerful and allows for a lot of new customization
without needing to modify the `react-md` internals and remembering specific
class names. Please check out the [creating dynamic themes] documentation for
more information.

> Disclaimer: This new theme API was heavily inspired by the
> [material components web](https://github.com/material-components/material-components-web)
> library.

#### New Utility SCSS Functions and Mixins

This release added a bunch of new utility functions and mixins to add additional
styling throughout your app for common use cases such as:

- updating styles for right to left languages: [rmd-utils-rtl]
- applying styles for mobile devices only: [rmd-utils-phone-media]
- applying styles for tablets and above: [rmd-utils-tablet-media]
- applying a simple button CSS reset: [rmd-button-reset]
- updating a CSS variable's value for the theme package: [rmd-theme-update-var]
- checking if a color is considered light or dark: [rmd-theme-tone]
- and more!

Check out the SassDoc pages for additional documentation and examples for common
mixins:

- [@react-md/alert](/packages/alert/sassdoc#alert-mixins)
- [@react-md/app-bar](/packages/app-bar/sassdoc#app-bar-mixins)
- [@react-md/avatar](/packages/avatar/sassdoc#avatar-mixins)
- [@react-md/badge](/packages/badge/sassdoc#badge-mixins)
- [@react-md/button](/packages/button/sassdoc#button-mixins)
- [@react-md/card](/packages/card/sassdoc#card-mixins)
- [@react-md/chip](/packages/chip/sassdoc#chip-mixins)
- [@react-md/dialog](/packages/dialog/sassdoc#dialog-mixins)
- [@react-md/divider](/packages/divider/sassdoc#divider-mixins)
- [@react-md/elevation](/packages/elevation/sassdoc#elevation-mixins)
- [@react-md/expansion-panel](/packages/expansion-panel/sassdoc#expansion-panel-mixins)
- [@react-md/form](/packages/form/sassdoc#form-mixins)
- [@react-md/icon](/packages/icon/sassdoc#icon-mixins)
- [@react-md/layout](/packages/layout/sassdoc#layout-mixins)
- [@react-md/link](/packages/link/sassdoc#link-mixins)
- [@react-md/list](/packages/list/sassdoc#list-mixins)
- [@react-md/media](/packages/media/sassdoc#media-mixins)
- [@react-md/menu](/packages/menu/sassdoc#media-mixins)
- [@react-md/overlay](/packages/overlay/sassdoc#overlay-mixins)
- [@react-md/progress](/packages/progress/sassdoc#progress-mixins)
- [@react-md/sheet](/packages/sheet/sassdoc#sheet-mixins)
- [@react-md/states](/packages/states/sassdoc#states-mixins)
- [@react-md/table](/packages/table/sassdoc#table-mixins)
- [@react-md/tabs](/packages/tabs/sassdoc#tabs-mixins)
- [@react-md/theme](/packages/theme/sassdoc#theme-mixins)
- [@react-md/tooltip](/packages/tooltip/sassdoc#tooltip-mixins)
- [@react-md/transition](/packages/transition/sassdoc#transition-mixins)
- [@react-md/tree](/packages/tree/sassdoc#tree-mixins)
- [@react-md/typography](/packages/typography/sassdoc#typography-mixins)
- [@react-md/utils](/packages/utils/sassdoc#utils-mixins)

#### Automatic Color Fixes for Accessible Contrast Ratios

The default styles from `react-md` will now **attempt** to automatically fix
contrast ratio issues between foreground and background colors using the new
[rmd-theme-tone] function. This appears to work for a great amount of use cases,
but it is still recommended to verify colors meet the recommended contrast ratio
for accessibility. You can check out the [Theme Builder] for a few examples of
contrast ratio issues by playing with the theme colors.

#### SCSS Variables and Default Values in JavaScript

Every SCSS variable is now automatically compiled with its default value and
written to a `dist/scssVariables.js` file for each package as a record of
variable names as keys and the default compiled value as the value. This allows
you to get access to each variable name as well as all the themeable CSS
Variables in JavaScript.

For example, if you want to get all the available material design colors from
the theme package, you can use the following code:

```ts
import scssVariables from "@react-md/theme/dist/scssVariables";

// get all the colors from the color palette
// only the color variables in this package will not be prefixed
// with rmd-theme
const colorKeys = Object.keys(scssVariables).filter(
  (name) => !/^rmd-theme/.test(name)
);
```

> Note: This will be strictly typed for Typescript users as well.

#### Improved Typography and CSS Reset

To be honest, I had no idea what I was doing with typography in v1 <sup>_(I
still don't really understand typography)_</sup> and defaulted to modifying the
default tags with `react-md` typography styles:

- `<h1> - <h6>`
- `<p>`
- `<caption>`
- `<input>`
- `<textarea>`
- `<button>`

Starting with v2, `react-md` will provide a much simpler
[CSS reset](/packages/utils/sassdoc#utils-mixin-rmd-utils-base) and not apply
any typography to html tags. In addition, the default typography styles can be
overridden or merged with new styles using the
[\$rmd-typography-styles variable](/packages/typography/sassdoc#typography-variable-rmd-typography-styles).
The new #typography package also exports two new components for general text
styling and reusable typography mixins.

#### Improved User Interaction States

A user interaction state is the feedback presented to the user when one of the
following actions happens:

- tap a clickable element on a touch device
- click a clickable element with the mouse
- focus an element with the keyboard

####### v1 implementation<!-- no-margin -->

![v1 implementation](https://i.imgur.com/MTxYr1e.mp4)

v1 of `react-md` had a very "noisy" implementation of this with the
[ripple/ink effect](https://mlaursen.github.io/react-md-v1-docs/#/components/inks) which caused a 300ms animation each
time the user interacted with a focusable element. This was _okay_ for the tap
and click behaviors but extremely obnoxious for keyboard users especially when
tabbing through elements quickly.

In addition there would sometimes be `:hover` styles applied accidentally after
a user touches an element on mobile since touch events also trigger the `:hover`
state. The rewrite for v2 has solved these issues by introducing interaction
states, providing mixins to dynamically apply styles based on an interaction
state, and providing a new keyboard focus state.

####### Starting with v2<!-- no-margin -->

![v2 implementation](https://i.imgur.com/wsvliUy.mp4)

The #utils package provides an `InteractionModeListener` that is bundled into
the `Configuration` component in the #layout package that helps determine which
interaction mode the user is currently using. This can be used along with the
following mixins for dynamically applying styles based on an interaction mode:

- [rmd-utils-touch-only]
- [rmd-utils-keyboard-only]
- [rmd-utils-mouse-only]

In addition, a new #states package has been added that implements the new
behavior for the ink/ripple effect that will now only trigger after a click
event instead of focus. The focus state has been drastically simplified to add
blue `box-shadow` and sometimes add a slight background color change while
keyboard focused. The new interaction states can be implemented for any
non-react-md component as well with the following mixins:

- [rmd-states-surface]
- [rmd-states-focus-shadow]
- [rmd-states-pressed-styles]
- [rmd-states-theme]
- [rmd-states-theme-update-var]

#### Improved Accessibility and Keyboard Movement

The v1 release of `react-md` implemented _some_ accessibility features and
keyboard movement but the majority of the behavior was incorrect and caused more
issues than it tried to solve. v2 is still not 100% perfect due to how
differently screen readers behave, but should now follow the specs outlined on
the [WIA-ARIA Best Practices](https://www.w3.org/TR/wai-aria-practices/)
website. Due to these fixes a lot of components will now correctly require an
`aria-label` or `aria-labelledby` prop which only required an `id` before.

The new keyboard movement behavior is drastically different now since components
now correctly follow the recommendations outlined in the WIA-ARIA Best practices
website. A new feature that is introduced in v2 is the ability to
"type-to-focus" elements in some complex components. The user can now focus a
component like the `Tree` or `DropdownMenu` and type letters to match the first
child that starts with those letters. In addition, lot of work has been made
into ensuring that keyboard focus is no longer lost while navigating between
temporary elements like menus and dialogs and implementing the new
`aria-activedescendant` movement when needed to keep focus on the correct
components. It is highly recommended to check out the [AutoComplete],
[DropdownMenu], and [Tree] components since the changes should be extremely
noticeable and a few of the demos showcase this functionality.

Finally, the accessibility helpers have been created as reusable hooks in the
##utils package so that non react-md components can implement this functionality
as well.

- [useFocusOnMount] - Focuses an element when the component mounts which
  defaults to the first focusable element child. Can be configured to focus the
  last child by default or a custom `document.querySelector` string.
- [usePreviousFocus] - Used in temporary elements like menus and dialogs to help
  ensure that keyboard focus is not lost once the temporary element is closed.
- [useTabFocusWrap] - A hook implementation of the `FocusContainer` that just
  provides a `onKeyDown` event handler for maintaining focus within a container.
- [useFocusMovement] - Provides the functionality to focus elements with custom
  key configurations.
- [useActiveDescendantMovement] - Provides the functionality to "focus" elements
  with custom key configurations by using the `aria-activedescendant` focus
  pattern which maintains focus on the "root" element
- [useKeyboardSearch] - A low-level hook for providing the "type-to-focus"
  behavior on components as an `onKeyDown` event handler.
- [useKeyboardMovement] - A low-level hook that is used by both the
  `useFocusMovement` and `useActiveDescendantMovement` to provide keyboard
  movement and optional search functionality.

#### Right to left Language Support

`react-md` will now automatically update the provided styles when a parent
element (normally the root `<html>`) for `dir="rtl"` to support right to left
languages. The following properties will be automatically inversed:

- `margin-left`
- `margin-right`
- `padding-left`
- `padding-right`
- `left`
- `right`

Since it might be required to update non-react-md components with these styles,
the #utils package also exports the following mixins to implement this behavior:

- [rmd-utils-rtl]
- [rmd-utils-rtl-auto]
- [rmd-utils-rtl-auto-group]

> The documentation site allows for a live preview for this functionality! If
> you are on desktop, click the right to left toggle button in the main header.
> If you are on mobile, click the kebab menu in the main header and then click
> the toggle right to left option.

This feature is enabled by default starting with v2 but can be disabled by
updating the
[rmd-utils-enable-rtl](/packages/utils/sassdoc#utils-variable-rmd-utils-enable-rtl)
variable:

```scss
$rmd-utils-enable-rtl: false;

@import "react-md/dist/react-md";
```

#### Convenience Configuration and Context Provider Components

v2 of react-md heavily uses the [Context API] to implement different features
and configuration for things such as:

- changing the default icons used throughout `react-md`
- disabling the ripple behavior
- configuring the `theme` for different components
- determining the current application size

Check out the #layout package for more information since it provides a
`Configuration` component that combines all of these context providers into a
single component.

#### Around 50 new Components and 40 hooks

In order to allow more customization and reconfigurability within react-md, more
low level components are now exported as well as moving some functionality
within hooks.

#### All Material Icons Available as Components

Since it can be difficult to remember all the icon names or even mistyping a
font icon name, `react-md@v2` now provides every material icon as a `FontIcon`
and `SVGIcon` implementation. At the time of writing these release notes, there
are **932 icons available** which means **1864 icon components**. Check out the
##material-icons package for more info and previewing every icon.

#### Scoped Packages

Since v2 of `react-md` ended up being a complete re-write, I wanted to create a
way to be able to slowly update existing apps from v1 to v2 without forcing an
immediate re-write. Related components will now be grouped and published
together using the `@react-md` scope as well as the "root" `react-md` package
that exports everything like normal. If you are completely new to `react-md`, I
recommend just installing `react-md` while apps that are migrating should use
the scoped packages.

Please see the [scoped packages] documentation for a more in-depth write up.

#### New Documentation Site

The documentation site has been re-written to use [NextJS](https://nextjs.org/)
instead of the extremely outdated custom implementation with different webpack
configs. This should hopefully allow contributors to get started more quickly
and apply changes as needed. Each page should now also provide a table of
contents to be able to quickly navigate to a specific heading, demo,
documentation, etc. There are also some other small other documentation
improvements that will be outlined below.

> Note: The search behavior needs to be fixed since it was hacked together in
> about 20 minutes. You should be able to find the majority of components other
> than the grid components. These can be found in the #utils package as
> `GridList` and `Grid`.

##### Improved Documentation <!-- no-margin-bottom -->

After reviewing feedback about the v1 documentation site, the main problem areas
were:

- unable to view the full context of the example code
- unable to live-edit the example code
- unable to see the default compiled value for SCSS variables
- not enough useful documentation around SCSS usage
- not enough information about the example

To solve the first two issues, a custom
[sandbox generator script]({{GITHUB_FILE_URL}}/packages/dev-utils/src/sandbox/index.ts)
was created that resolves every
[dependency and file name]({{GITHUB_FILE_URL}}/packages/dev-utils/src/sandbox/extract.ts#L58)
for each demo and generates a
[sandbox json file]({{GITHUB_FILE_URL}}/packages/dev-utils/src/sandbox/generate.ts#L139).
This allows for the new and improved
[DemoSandbox]({{GITHUB_FILE_URL}}/packages/documentation/src/components/DemoSandbox/DemoSandbox.tsx)
to render all the files for a demo as well as dynamically creating an editable
code sandbox using the
[codesandbox define API](https://codesandbox.io/docs/importing#define-api). Each
demo will now have a button to preview the code in the new `DemoSandbox`, create
an editable sandbox with [CodeSandbox](https://codesandbox.io/), and a directly
link to the source code within GitHub to help show the full context of the
demos. In addition, each demo was updated to hopefully be a lot less complex
than some that appeared in v1.

The third issue was solved by re-writing the
[sassdoc generator script]({{GITHUB_FILE_URL}}/packages/dev-utils/src/sassdoc.ts)
to
[hackily force compile the scss variable]({{GITHUB_FILE_URL}}/packages/dev-utils/src/utils/getCompiledScssVariable.ts#L134).
Now if a variable references another SCSS variable, the default compiled value
can be viewed by enabling the "Default Compiled Value" switch for that variable.
Check out the
[\$rmd-alert-theme-values variable](/packages/alert/sassdoc#alert-variable-rmd-alert-theme-values)
for a quick example.

The forth issue has not been solved completely, but there is now a new solution
in place by being able to render examples a bit easier within SassDoc and
showing the compiled value. The
[rmd-utils-rtl mixin](/packages/utils/sassdoc#utils-mixin-rmd-utils-rtl) has a
pretty good example to reference for this functionality.

The last issue about missing information for the example has hopefully been
solved by the new writing patterns throughout the documentation site. Each
example should now have a bit more information about the components being used
along with some background information about what the demo is trying to
accomplish. **Documentation is difficult** so please provide feedback for what
has been helpful and what has not.

#### GZip Size Comparison

The v2 release has decreased the UMD bundle size by `12.35%` while the CSS
bundles have increased by `18.56% - 18.75%`:

```sh
v1 size
The gzipped UMD bundle size is:
 - dist/v1/umd/react-md.min.js 98.68 KB

The min and max gzipped CSS bundle sizes are:
 - dist/v1/css/react-md.yellow-red.min.css 13.2 KB
 - dist/v1/css/react-md.blue_grey-deep_purple.min.css 13.23 KB

v2 size
The gzipped UMD bundle size is:
 - dist/umd/react-md.production.min.js 86.49 KB
 - dist/umd/react-md-with-font-icons.production.min.js 196.05 KB
 - dist/umd/react-md-with-svg-icons.production.min.js 196.03 KB

The min and max gzipped CSS bundle sizes are:
 - dist/css/react-md.grey-deep_orange-200-light.min.css 15.65 KB
 - dist/css/react-md.indigo-blue-400-dark.min.css 15.71 KB
```

In addition, v2 _should_ have finally solved the code splitting issue that
existing in v1 and produce an even smaller bundle if every feature within
`react-md` is not used.

### In-depth Changelogs

This should be the main highlights for the v2 release. If you are interested in
an in-depth package-by-package update and changelog, you can view one of the
following changelogs:

- [@react-md/alert](/packages/alert/changelog#v200)
- [@react-md/app-bar](/packages/app-bar/changelog#v200)
- [@react-md/autocomplete](/packages/autocomplete/changelog#v200)
- [@react-md/avatar](/packages/avatar/changelog#v200)
- [@react-md/badge](/packages/badge/changelog#v200)
- [@react-md/button](/packages/button/changelog#v200)
- [@react-md/card](/packages/card/changelog#v200)
- [@react-md/chip](/packages/chip/changelog#v200)
- [@react-md/dialog](/packages/dialog/changelog#v200)
- [@react-md/divider](/packages/divider/changelog#v200)
- [@react-md/elevation](/packages/elevation/changelog#v200)
- [@react-md/expansion-panel](/packages/expansion-panel/changelog#v200)
- [@react-md/form](/packages/form/changelog#v200)
- [@react-md/icon](/packages/icon/changelog#v200)
- [@react-md/layout](/packages/layout/changelog#v200)
- [@react-md/link](/packages/link/changelog#v200)
- [@react-md/list](/packages/list/changelog#v200)
- [@react-md/material-icons](/packages/material-icons/changelog#v200)
- [@react-md/media](/packages/media/changelog#v200)
- [@react-md/menu](/packages/menu/changelog#v200)
- [@react-md/overlay](/packages/overlay/changelog#v200)
- [@react-md/portal](/packages/portal/changelog#v200)
- [@react-md/progress](/packages/progress/changelog#v200)
- [@react-md/sheet](/packages/sheet/changelog#v200)
- [@react-md/states](/packages/states/changelog#v200)
- [@react-md/table](/packages/table/changelog#v200)
- [@react-md/tabs](/packages/tabs/changelog#v200)
- [@react-md/theme](/packages/theme/changelog#v200)
- [@react-md/tooltip](/packages/tooltip/changelog#v200)
- [@react-md/transition](/packages/transition/changelog#v200)
- [@react-md/tree](/packages/tree/changelog#v200)
- [@react-md/typography](/packages/typography/changelog#v200)
- [@react-md/utils](/packages/utils/changelog#v200)

[typescript]: https://www.typescriptlang.org/
[react hooks api]: https://reactjs.org/docs/hooks-intro.html
[context api]: https://reactjs.org/docs/context.html
[custom css properties (css variables)]:
  https://developer.mozilla.org/en-US/docs/Web/CSS/--*
[usekeyboardsearch]:
  {{GITHUB_FILE_URL}}/packages/utils/src/search/useKeyboardSearch.ts
[usefocusonmount]:
  {{GITHUB_FILE_URL}}/packages/utils/src/wia-aria/useFocusOnMount.ts
[usepreviousfocus]:
  {{GITHUB_FILE_URL}}/packages/utils/src/wia-aria/usePreviousFocus.ts
[usetabfocuswrap]:
  {{GITHUB_FILE_URL}}/packages/utils/src/wia-aria/useTabFocusWrap.ts
[usefocusmovement]:
  {{GITHUB_FILE_URL}}/packages/utils/src/wia-aria/movement/useFocusMovement.ts
[useactivedescendantmovement]:
  {{GITHUB_FILE_URL}}/packages/utils/src/wia-aria/movement/useActiveDescendantMovement.ts
[usekeyboardmovement]:
  {{GITHUB_FILE_URL}}/packages/utils/src/movement/useKeyboardMovement.ts
[autocomplete]: /packages/autocomplete/demos
[dropdownmenu]: /packages/menu/demos
[tree]: /packages/tree/demos
[working with v1]: /guides/working-with-v1
[creating dynamic themes]: /colors-and-theming/creating-dynamic-themes
[theme builder]: /colors-and-theming/theme-builder
[appsizelistener]: /packages/utils/demos#app-size-listener-example-title
[other themeable values]:
  /packages/theme/sassdoc#theme-variable-rmd-theme-values
[media query components example]:
  /packages/utils/demos#media-query-components-title
[scoped packages]: /guides/scoped-packages
[rmd-button-reset]: /packages/button/sassdoc#button-mixin-rmd-button-reset
[rmd-states-surface]: /packages/states/sassdoc#states-mixin-rmd-states-surface
[rmd-states-focus-shadow]:
  /packages/states/sassdoc#states-mixin-rmd-states-focus-shadow
[rmd-states-pressed-styles]:
  /packages/states/sassdoc#states-mixin-rmd-states-pressed-styles
[rmd-states-theme]: /packages/states/sassdoc#states-mixin-rmd-states-theme
[rmd-states-theme-update-var]:
  /packages/states/sassdoc#states-mixin-rmd-states-theme-update-var
[rmd-theme-update-var]: /packages/theme/sassdoc#theme-mixin-rmd-theme-update-var
[rmd-theme-tone]: /packages/theme/sassdoc#theme-function-rmd-theme-tone
[rmd-utils-rtl]: /packages/utils/sassdoc#utils-mixin-rmd-utils-rtl
[rmd-utils-rtl-auto]: /packages/utils/sassdoc#utils-mixin-rmd-utils-rtl-auto
[rmd-utils-rtl-auto-group]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-rtl-auto-group
[rmd-utils-touch-only]: /packages/utils/sassdoc#utils-mixin-rmd-utils-touch-only
[rmd-utils-keyboard-only]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-keyboard-only
[rmd-utils-mouse-only]: /packages/utils/sassdoc#utils-mixin-rmd-utils-mouse-only
[rmd-utils-phone-media]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-phone-media
[rmd-utils-tablet-media]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-tablet-media
[rmd-utils-tablet-only-media]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-tablet-only-media
[rmd-utils-desktop-media]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-desktop-media
[rmd-utils-large-desktop-media]:
  /packages/utils/sassdoc#utils-mixin-rmd-utils-large-desktop-media