Organize CHANGELOG for upcoming release. (#425)

- Organized items into Added/Changed/Fixed sections.
- Added **BREAKING** labels.
- Removed items that are only relevant for internal development. I think we should only include things directly relevant to users.
- Mentioned the new READMEs.
- Re-phrased some items for clarity.
- Added PR numbers so users can get more info.
This commit is contained in:
Alexander Marks 2019-08-26 21:02:01 -07:00 committed by GitHub
parent e1ec538f1b
commit 45e107fbc3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,52 +5,91 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/). and this project adheres to [Semantic Versioning](http://semver.org/).
## Unreleased ## Unreleased
- Components no longer automatically load the Material Icons font, so that
users have control over how fonts are loaded. Users can still import the ### Added
`mwc-icon-font.js` module themselves to automatically load the font from - New components:
fonts.googleapis.com. - [`<mwc-textfield>`](https://github.com/material-components/material-components-web-components/tree/master/packages/textfield) ([#297](https://github.com/material-components/material-components-web-components/pull/297))
- Fix layout issue affecting scrolling `<mwc-tab-bar>` in Firefox. - [`<mwc-textarea>`](https://github.com/material-components/material-components-web-components/tree/master/packages/textarea) ([#297](https://github.com/material-components/material-components-web-components/pull/297))
- Fix bug where `<mwc-icon>` icons did not render in IE11. - [`<mwc-icon-button-toggle>`](https://github.com/material-components/material-components-web-components/tree/master/packages/icon-button-toggle) ([#370](https://github.com/material-components/material-components-web-components/pull/370))
- Buttons slotted into `<mwc-snackbar>` now render with correct default styles. - [`<mwc-top-app-bar-fixed>`](https://github.com/material-components/material-components-web-components/tree/master/packages/top-app-bar-fixed) ([#379](https://github.com/material-components/material-components-web-components/pull/379))
Add `--mdc-snackbar-action-color` CSS custom property to override default
action button color. - Added support for `<svg>` and `<img>` icons to `<mwc-icon-button>` and
- Fix bug where `<mwc-snackbar>` `open` method threw if called immediately `<mwc-icon-button-toggle>`.
after construction (before `firstUpdated`). ([#358](https://github.com/material-components/material-components-web-components/pull/358))
- Add support for `<svg>` and `<img>` to `<mwc-icon-button>`
- Add `lit-analyzer` to CI - Added `--mdc-snackbar-action-color` CSS custom property to `<mwc-snackbar>` to
- Only set up structure in `bootstrap`, make `build` explicit. override the default action button color
Run `lint` and `format` in CI ([#354](https://github.com/material-components/material-components-web-components/pull/354)).
- Remove CHANGELOG files in packages
- Add section about CHANGELOG entries to CONTRIBUTING guide - Added a default slot to `<mwc-top-app-bar>` and `<mwc-top-app-bar-fixed>`
- Remove `as any` from `@customElement` decorators which takes page content and automatically applies the correct `padding-top`
- Improve README for `<mwc-button>` ([#370](https://github.com/material-components/material-components-web-components/pull/370)).
- Improve README for `<mwc-icon-button>`
- Split toggling icon button out into `@material/mwc-icon-button-toggle` with tag name `<mwc-icon-button-toggle>` - Added documentation for:
- Fix bug where setting the `checked` property on an `<mwc-radio>` did not - [`<mwc-button>`](https://github.com/material-components/material-components-web-components/tree/master/packages/button)
result in the other radios in the group becoming unchecked. ([#366](https://github.com/material-components/material-components-web-components/pull/366))
- Fix bug where `<mwc-drawer>` did not work in IE (via - [`<mwc-fab>`](https://github.com/material-components/material-components-web-components/tree/master/packages/fab)
[WICG/inert#129](https://github.com/WICG/inert/pull/129)) ([#361](https://github.com/material-components/material-components-web-components/pull/361))
- Split mwc-top-app-bar fixed and short variants into separate components - [`<mwc-icon-button>`](https://github.com/material-components/material-components-web-components/tree/master/packages/icon-button)
- Removed, and readded mwc-top-app-bar `centerTitle`, fixing padding with `dense` and `prominent` setting ([#370](https://github.com/material-components/material-components-web-components/pull/370))
- Implemented: - [`<mwc-radio>`](https://github.com/material-components/material-components-web-components/tree/master/packages/radio)
- mwc-textfield ([#377](https://github.com/material-components/material-components-web-components/pull/377))
- mwc-textarea - [`<mwc-snackbar>`](https://github.com/material-components/material-components-web-components/tree/master/packages/snackbar)
- mwc-notched-outline ([#355](https://github.com/material-components/material-components-web-components/pull/355))
- mwc-line-ripple-directive - [`<mwc-top-app-bar>`](https://github.com/material-components/material-components-web-components/tree/master/packages/top-app-bar)
- mwc-floating-label-directive ([#379](https://github.com/material-components/material-components-web-components/pull/379))
- mwc-top-app-bar-fixed
- mwc-top-app-bar-short ### Changed
- Testing Infra: - **BREAKING** The Material Icons font is no longer loaded automatically
- Tests now in TS ([#314](https://github.com/material-components/material-components-web-components/pull/314)).
- Tests now all pass in evergreens but still failing in IE and Safari 9 This allows more control over how fonts are loaded (e.g. serving fonts from a
- Using Koa Karma proxy server and auto-amd-ifies files different server, or loading multiple fonts with a single request). Most users
- Can now run individual tests using npm run test -- --packages mwc-icon-button*,mwc-button should now add a tag like this to their HTML page:
- Fix bug where setting the `<mwc-snackbar>` `labelText` property could throw
```html
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500|Material+Icons" rel="stylesheet">
```
- **BREAKING** The *toggling* behavior of `<mwc-icon-button>` has been removed
(i.e. `offIcon`), and is now instead supported by the dedicated
[`<mwc-icon-button-toggle>`](https://github.com/material-components/material-components-web-components/tree/master/packages/icon-button-toggle)
component
([#370](https://github.com/material-components/material-components-web-components/pull/370)).
- **BREAKING** The *short* layout for `<mwc-top-app-bar>` has been removed, and
is no longer supported because it is not part of the Material Design
specification
([#422](https://github.com/material-components/material-components-web-components/pull/422)).
- **BREAKING** The *fixed* layout for `<mwc-top-app-bar>` has been removed, and
is now instead implemented by the dedicated `<mwc-top-app-bar-fixed>`
component
([#379](https://github.com/material-components/material-components-web-components/pull/379)).
### Fixed
- Fixed bug where `<mwc-snackbar>` `open` method threw if called immediately
after construction (before `firstUpdated`)
([#356](https://github.com/material-components/material-components-web-components/pull/356)).
- Fixed bug where setting the `<mwc-snackbar>` `labelText` property could throw
an exception and fail to render an exception and fail to render
([#367](https://github.com/material-components/material-components-web-components/issues/367)). ([#412](https://github.com/material-components/material-components-web-components/pull/412)).
- Removed: - Buttons slotted into `<mwc-snackbar>` now render with the correct default
- mwc-top-app-bar-short has been removed after guidance from the Material Design team. styles
- Fix top-app-bar centering for multiple icons. ([#354](https://github.com/material-components/material-components-web-components/pull/354)).
- Fixed layout issue affecting scrolling `<mwc-tab-bar>` in Firefox
([#349](https://github.com/material-components/material-components-web-components/pull/349)).
- Fixed bug where `<mwc-icon>` icons did not render in IE11
([#353](https://github.com/material-components/material-components-web-components/pull/353)).
- Fixed bug where setting the `checked` property on an `<mwc-radio>` did not
result in the other radios in the group becoming unchecked
([#373](https://github.com/material-components/material-components-web-components/pull/373)).
- Fixed bug where `<mwc-drawer>` did not work in IE
([WICG/inert#129](https://github.com/WICG/inert/pull/129)).
- Fixed `dense` and `prominent` styling bugs in `<mwc-top-app-bar>`
([#379](https://github.com/material-components/material-components-web-components/pull/379)).
## [0.6.0] - 2019-06-05 ## [0.6.0] - 2019-06-05
- Upgrade lerna to 3.x - Upgrade lerna to 3.x