Skip to content

Commit 7c4ea2c

Browse files
committed
build(ngx-utils):v19.0.0
1 parent 6c076eb commit 7c4ea2c

File tree

2 files changed

+6
-183
lines changed

2 files changed

+6
-183
lines changed

libs/angular/utils/README.md

Lines changed: 3 additions & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -18,191 +18,14 @@ This package will follow a semver-like format, `major.minor.patch`, in which:
1818
- `minor`: Introduces new features and (potential) breaking changes
1919
- `patch`: Introduces bugfixes and minor non-breaking changes
2020

21-
For more information about the build process, authors, contributions and issues, we refer to the [ngx-tools](https://github.com/studiohyperdrive/ngx-tools) repository.
21+
For more information about the build process, authors, contributions and issues, we refer to the [hyperdrive-opensource](https://github.com/studiohyperdrive/hyperdrive-opensource) repository.
2222

2323
## Concept
2424

2525
The `ngx-utils` package seeks to provide easy to use and to customize solutions to common use-cases. Each of these solutions can be used independently and are meant to enhance both the developer and the user experience of the application.
2626

2727
This package comes with a wide array of pipes, directives, services, types and abstracts. New implementations are added on a regular basis.
2828

29-
## Implementation
29+
## Documentation
3030

31-
### Directives
32-
33-
#### FocusClickDirective
34-
35-
The FocusClickDirective provides an a11y friendly click handler.
36-
37-
[Full documentation.](src/lib/directives/focus-click/focus-click.directive.md)
38-
39-
### Injects
40-
41-
#### getQueryParams
42-
43-
The getQueryParams helper will get query params from the ActivatedRoute and return them as an observable.
44-
45-
[Full documentation.](src/lib/injects/query-params/query-params.inject.md)
46-
47-
### Pipes
48-
49-
#### BtwPipe
50-
51-
The BtwPipe will format Belgian VAT numbers.
52-
53-
[Full documentation.](src/lib/pipes/btw/btw.pipe.md)
54-
55-
#### EntriesPipe
56-
57-
The BtwPipe will transform an object in to an array of key/value arrays.
58-
59-
[Full documentation.](src/lib/pipes/entries/entries.pipe.md)
60-
61-
#### HasObserversPipe
62-
63-
The HasObserversPipe will check if an Output property has observers.
64-
65-
[Full documentation.](src/lib/pipes/has-observers/has-observers.pipe.md)
66-
67-
#### hasOwnProperty
68-
69-
The hasOwnProperty will check whether the specified property exists within the given object.
70-
71-
[Full documentation.](src/lib/pipes/has-own-property/has-own-property.pipe.md)
72-
73-
#### HasValuesPipe
74-
75-
The HasValuesPipe will check if a provided object has values.
76-
77-
[Full documentation.](src/lib/pipes/has-values/has-values.pipe.md)
78-
79-
#### HighlightPipe
80-
81-
The HighlightPipe will select a piece of text and wrap it in a new element.
82-
83-
[Full documentation.](src/lib/pipes/highlight/highlight.pipe.md)
84-
85-
#### IbanPipe
86-
87-
The IbanPipe will format an IBAN number.
88-
89-
[Full documentation.](src/lib/pipes/iban/iban.pipe.md)
90-
91-
#### IsNotEmptyPipe
92-
93-
The IsNotEmptyPipe will check if a given argument is an object or array and if it is empty.
94-
95-
[Full documentation.](src/lib/pipes/is-not-empty/is-not-empty.pipe.md)
96-
97-
#### JoinPipe
98-
99-
The JoinPipe will join values in an array.
100-
101-
[Full documentation.](src/lib/pipes/join/join.pipe.md)
102-
103-
#### LimitToPipe
104-
105-
The LimitToPipe will limit an array to x-amount of values.
106-
107-
[Full documentation.](src/lib/pipes/limit-to/limit-to.pipe.md)
108-
109-
#### LogPipe
110-
111-
The LogPipe will print the provided value to the console, it will not render the value on the page itself.
112-
113-
[Full documentation.](src/lib/pipes/log/log.pipe.md)
114-
115-
#### MergeArraysPipe
116-
117-
The MergeArraysPipe is a wrapper around the JS native Array.concat with some added safety.
118-
119-
[Full documentation.](src/lib/pipes/merge-arrays/merge-arrays.pipe.md)
120-
121-
#### SafeHtmlPipe
122-
123-
The SafeHtmlPipe will sanitize a given value with the DomSanitizer.
124-
125-
[Full documentation.](src/lib/pipes/safe-html/safe-html.pipe.md)
126-
127-
#### StripHtmlPipe
128-
129-
The StripHtmlPipe will strip HTML from a given value.
130-
131-
[Full documentation.](src/lib/pipes/strip-html/strip-html.pipe.md)
132-
133-
#### ToArrayPipe
134-
135-
The ToArrayPipe will check if a value is defined and then wrap it in a new array before returning it.
136-
137-
[Full documentation.](src/lib/pipes/to-array/to-array.pipe.md)
138-
139-
#### TransformPipe
140-
141-
The TransformPipe will transform a given value with the provided transform-function.
142-
143-
[Full documentation.](src/lib/pipes/transform/transform.pipe.md)
144-
145-
#### TruncateTextPipe
146-
147-
The TruncateTextPipe will truncate a given text to a given number of characters and suffix it with an ellipsis.
148-
149-
[Full documentation.](src/lib/pipes/truncate-text/truncate-text.pipe.md)
150-
151-
#### UniqByPipe
152-
153-
The UniqByPipe will execute the uniqBy function (Lodash) on a provided array.
154-
155-
[Full documentation.](src/lib/pipes/truncate-text/truncate-text.pipe.md)
156-
157-
#### WithRouterLinksPipe
158-
159-
The withRouterLinks pipe will provide a way to transform a string that contains one or more parts that need a routerLink by taking advantage of Angular web components.
160-
161-
[Full documentation.](src/lib/pipes/with-router-links/with-router-links.md)
162-
163-
#### NgxReplaceElementsPipe
164-
165-
The ngxReplaceElements pipe will provide a way to transform a string that contains one or more parts that need an Angular component by taking advantage of Angular web components.
166-
167-
[Full documentation.](src/lib/pipes/replace-elements/replace-elements.pipe.md)
168-
169-
### Services
170-
171-
#### Window service
172-
173-
This service uses the `DOCUMENT` injection-token to provide several methods to access both document and window and related information.
174-
It is convenient for using the document or window without breaking SSR.
175-
176-
[Full documentation.](src/lib/services/window-service/window.service.md)
177-
178-
#### subscription service
179-
180-
This service is a solution to end RxJS subscriptions when component is destroyed.
181-
182-
[Full documentation.](src/lib/services/subscription-service/subscription.service.md)
183-
184-
#### NgxStorageService
185-
186-
This service provides a SSR proof Observable based approach to both the local- and the sessionStorage.
187-
188-
[Full documentation.](src/lib/services/storage-service/storage.service.md)
189-
190-
#### NgxMediaQueryService
191-
192-
This service provides a SSR proof way to set and subscribe to the window's media query changes.
193-
194-
[Full documentation.](src/lib/services/media-query/query.service.md)
195-
196-
#### NgxBroadcastChannelService
197-
198-
This service provides a SSR proof way to create channels for the BroadcastChannel API, post messages on those channels and subscribe to the events.
199-
200-
[Full documentation.](src/lib/services/broadcast-channel/broadcast-channel.md)
201-
202-
### Abstracts
203-
204-
#### NgxQueryParamFormSyncComponent
205-
206-
This abstract component provides a way to sync the queryParams with a reactive form. This is ideal to handle filtered views, as it automatically syncs selected filters with the url.
207-
208-
[Full documentation.](src/lib/abstracts/query-param-form-sync/query-param-form-sync.component.abstract.md)
31+
To find more information regarding this package, we refer to [our documentation platform](https://open-source.studiohyperdrive.be/docs/angular/utils/introduction).

libs/angular/utils/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@studiohyperdrive/ngx-utils",
3-
"version": "18.4.1",
3+
"version": "19.0.0",
44
"description": "A series of abstracts, utils, pipes and services for Angular applications.",
55
"keywords": [
66
"angular",
@@ -38,15 +38,15 @@
3838
"replace elements",
3939
"web components"
4040
],
41-
"homepage": "https://github.com/studiohyperdrive/ngx-tools/tree/master/libs/angular/utils",
41+
"homepage": "https://open-source.studiohyperdrive.be/docs/angular/utils/installation",
4242
"license": "MIT",
4343
"author": {
4444
"name": "Studio Hyperdrive",
4545
"url": "https://studiohyperdrive.be/"
4646
},
4747
"repository": {
4848
"type": "git",
49-
"url": "https://github.com/studiohyperdrive/ngx-tools",
49+
"url": "https://github.com/studiohyperdrive/hyperdrive-opensource",
5050
"directory": "libs/angular/utils/src"
5151
},
5252
"peerDependencies": {

0 commit comments

Comments
 (0)