Skip to content

Commit

Permalink
Release 3.0.0 (#238)
Browse files Browse the repository at this point in the history
* chore: deprecate usage of ngx-mat-select-search without parent mat-option

BREAKING CHANGE

* chore: update @angular-devkit/build-angular to 0.803.27

* prepare release 3.0.0
  • Loading branch information
macjohnny committed Jun 16, 2020
1 parent d258ad7 commit 6a17e42
Show file tree
Hide file tree
Showing 13 changed files with 2,682 additions and 1,784 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Changelog

## 3.0.0
* Fix: prevent scrolling to first option if option does not change (e.g. with infinity scrolling) [#200](https://github.com/bithost-gmbh/ngx-mat-select-search/issues/200)

Thanks to @raysuelzer
* Enhancement: Add option to clear input when pressing escape with `[enableClearOnEscapePressed]="true"`
[#231](https://github.com/bithost-gmbh/ngx-mat-select-search/issues/231)

Thanks to @nischi
* Enhancement: Add compatibility with `@angular/core`: `^10.0.0`, `@angular/material`: `^10.0.0`
* Chore: (**Breaking Change**) The possibility to place the `<ngx-mat-select-search>` element directly inside `<mat-select>`
without wrapping it in an `<mat-option>` element was removed due to changes of the public API of `mat-select`. [#208](https://github.com/bithost-gmbh/ngx-mat-select-search/issues/208)

To fix this, simply place the `<ngx-mat-select-search>` inside a `<mat-option>` element.
Thanks to @evoltafreak

## 2.2.0
* Enhancement: add tooltip message to select-all checkbox [#227](https://github.com/bithost-gmbh/ngx-mat-select-search/issues/227)

Expand Down
29 changes: 3 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@ and [https://github.com/bithost-gmbh/ngx-mat-select-search/blob/master/src/app/a
how to wire the `ngx-mat-select-search` and filter the options available.
Or have a look at [https://github.com/bithost-gmbh/ngx-mat-select-search-example](https://github.com/bithost-gmbh/ngx-mat-select-search-example) to see it in a standalone app.

Note: it is also possible to place the `<ngx-mat-select-search>` element directly inside `<mat-select>`
without wrapping it in an `<mat-option>` element. However, the search field might be outside of the visible viewport.
See [#1](https://github.com/bithost-gmbh/ngx-mat-select-search/issues/1) and [Known Problems / Solutions](#known-problems--solutions)

### Template driven forms
You can alternatively use it with template driven forms as follows:
```html
Expand Down Expand Up @@ -182,29 +178,10 @@ Custom content with the CSS class `mat-select-search-custom-header-content` can
</ngx-mat-select-search>
```

## Known Problems / Solutions
* The search input is placed outside of the visible screen if the select element is at the top of the screen
(in the stackblitz example, remove the header
or add some content above the select and scroll the select to the top edge).
See [#1](https://github.com/bithost-gmbh/ngx-mat-select-search/issues/1)

**Workaround 1**: place the `<ngx-mat-select-search>` inside a `<mat-option>`
```html
<mat-select>
<mat-option>
<ngx-mat-select-search></ngx-mat-select-search>
</mat-option>
<mat-option *ngFor="let bank of ...">...</mat-option>
</mat-select>
```
Caveat: the currently selected option might be hidden under the search input field when opening the options panel.
## Known Problems
* The currently selected option might be hidden under the search input field when opening the options panel
and the panel is at the screen border.

**Workaround 2**: use the disableOptionCentering option on the `<mat-select>`
[https://material.angular.io/components/select/api](https://material.angular.io/components/select/api)
while placing the `<ngx-mat-select-search>` element directly inside `<mat-select>`
without wrapping it in an `<mat-option>` element.


## Support Development

We aim at providing the best service possible by constantly improving `NgxMatSelectSearch` and responding fast to bug reports. We do this fully free of cost.
Expand Down
Loading

0 comments on commit 6a17e42

Please sign in to comment.