Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release(toolkit): v1.5.0 #219

Merged
merged 1 commit into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGELOG_TOOLKIT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# [1.5.0](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/compare/toolkit-1.4.1...toolkit-1.5.0) (2024-10-03)


### Performance Improvements

* **toolkit/observable:** optimize position detection in `fromBoundingClientRect$ ` ([540b8bb](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/540b8bbdfd968b56ed484a0daf290257105c4d8f))


### Code Refactoring

* **toolkit/operators:** remove deprecated `pluckArray` operator ([6c84329](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/6c84329f8cb6180dee465b6ac1ffc6c660f2029f))
* **toolkit/testing:** remove deprecated `ObserveCaptor#resetValues` method ([10253e6](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/10253e6ab09e22ef43fccd7913eba27fe45541fc))


### BREAKING CHANGES

* **toolkit/testing:** `ObserveCaptor#resetValues` was deprecated and has been removed; use `ObserveCaptor#reset` instead.
* **toolkit/operators:** RxJS operator `pluckArray` was deprecated and has been removed; use `mapArray` instead.


## [1.4.1](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/compare/toolkit-1.4.0...toolkit-1.4.1) (2023-06-14)


Expand Down
21 changes: 21 additions & 0 deletions CHANGELOG_TOOLKIT_LATEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [1.5.0](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/compare/toolkit-1.4.1...toolkit-1.5.0) (2024-10-03)


### Performance Improvements

* **toolkit/observable:** optimize position detection in `fromBoundingClientRect$` ([540b8bb](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/540b8bbdfd968b56ed484a0daf290257105c4d8f))


### Code Refactoring

* **toolkit/operators:** remove deprecated `pluckArray` operator ([6c84329](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/6c84329f8cb6180dee465b6ac1ffc6c660f2029f))
* **toolkit/testing:** remove deprecated `ObserveCaptor#resetValues` method ([10253e6](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/10253e6ab09e22ef43fccd7913eba27fe45541fc))


### BREAKING CHANGES

* **toolkit/testing:** `ObserveCaptor#resetValues` was deprecated and has been removed; use `ObserveCaptor#reset` instead.
* **toolkit/operators:** RxJS operator `pluckArray` was deprecated and has been removed; use `mapArray` instead.



20 changes: 20 additions & 0 deletions docs/site/changelog-toolkit/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@
## [Changelog][menu-changelog] > @scion/toolkit


# [1.5.0](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/compare/toolkit-1.4.1...toolkit-1.5.0) (2024-10-03)


### Performance Improvements

* **toolkit/observable:** optimize position detection in `fromBoundingClientRect$ ` ([540b8bb](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/540b8bbdfd968b56ed484a0daf290257105c4d8f))


### Code Refactoring

* **toolkit/operators:** remove deprecated `pluckArray` operator ([6c84329](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/6c84329f8cb6180dee465b6ac1ffc6c660f2029f))
* **toolkit/testing:** remove deprecated `ObserveCaptor#resetValues` method ([10253e6](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/commit/10253e6ab09e22ef43fccd7913eba27fe45541fc))


### BREAKING CHANGES

* **toolkit/testing:** `ObserveCaptor#resetValues` was deprecated and has been removed; use `ObserveCaptor#reset` instead.
* **toolkit/operators:** RxJS operator `pluckArray` was deprecated and has been removed; use `mapArray` instead.


## [1.4.1](https://github.com/SchweizerischeBundesbahnen/scion-toolkit/compare/toolkit-1.4.0...toolkit-1.4.1) (2023-06-14)


Expand Down
4 changes: 2 additions & 2 deletions projects/scion/toolkit/observable/src/dimension.observable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
* @param target - HTMLElement to observe its dimension.
* @return Observable that emits dimension changes of the passed element.
*
* @deprecated since version 1.4.2; use `fromResize$` instead; API will be removed in version 2.0.
* @deprecated since version 1.5.0; use `fromResize$` instead; API will be removed in version 2.0.
*/
export function fromDimension$(target: HTMLElement): Observable<Dimension> {
return new Observable((observer: Observer<Dimension>): TeardownLogic => {
const resizeObserver = new ResizeObserver(() => observer.next(captureElementDimension(target)));

Check warning on line 26 in projects/scion/toolkit/observable/src/dimension.observable.ts

View workflow job for this annotation

GitHub Actions / Linting

'captureElementDimension' is deprecated. since version 1.5.0; use {@link HTMLElement.getBoundingClientRect} instead; API will be removed in version 2.0

Check warning on line 26 in projects/scion/toolkit/observable/src/dimension.observable.ts

View workflow job for this annotation

GitHub Actions / Linting

'captureElementDimension' is deprecated. since version 1.5.0; use {@link HTMLElement.getBoundingClientRect} instead; API will be removed in version 2.0
resizeObserver.observe(target); // emits the current dimension directly upon subscription

return (): void => {
Expand All @@ -35,7 +35,7 @@
/**
* Captures the dimension of the given element.
*
* @deprecated since version 1.4.2; use {@link HTMLElement.getBoundingClientRect} instead; API will be removed in version 2.0.
* @deprecated since version 1.5.0; use {@link HTMLElement.getBoundingClientRect} instead; API will be removed in version 2.0.
*/
export function captureElementDimension(element: HTMLElement): Dimension {
return {
Expand Down
2 changes: 1 addition & 1 deletion projects/scion/toolkit/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@scion/toolkit",
"version": "1.4.1",
"version": "1.5.0",
"description": "Provides a collection of framework-agnostic utilities designed primarily for use in SCION libraries such as `@scion/workbench` and `@scion/microfrontend-platform`. This library is written in plain TypeScript and has no dependency on any other library.",
"license": "EPL-2.0",
"private": false,
Expand Down
Loading