Skip to content

Commit 940a3f4

Browse files
committed
docs: update documentation
1 parent c5f715c commit 940a3f4

File tree

13 files changed

+391
-640
lines changed

13 files changed

+391
-640
lines changed

docs/cdk/date-suggestion.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
#### `@angular-ru/cdk/date`
22

3-
#### DateSuggestionModule
3+
#### DateSuggestion Composer
44

5-
Module for convenient substitution of date intervals depending on values and the current date.
5+
DateSuggestion composer can be used for convenient substitution of date intervals depending on values and the current
6+
date.
67

78
##### Default usage
89

@@ -17,16 +18,23 @@ Default implementation has 8 built-in strategies:
1718
- `LAST_180_DAYS_OF_INTERVAL` — set 180 days to the last day from the current interval.
1819

1920
```typescript
20-
import {DateSuggestionModule, DateSuggestionComposer, DefaultDateIntervalSuggestion} from '@angular-ru/cdk/date';
21+
import {
22+
DateSuggestionComposer,
23+
DayOfWeek,
24+
DefaultDateIntervalSuggestion,
25+
FIRST_DAY_OF_WEEK,
26+
provideDateSuggestion,
27+
} from '@angular-ru/cdk/date';
2128

22-
@NgModule({
23-
// ...
24-
imports: [
25-
// ...
26-
DateSuggestionModule,
29+
export const appConfig: ApplicationConfig = {
30+
providers: [
31+
provideDateSuggestion(),
32+
{
33+
provide: FIRST_DAY_OF_WEEK,
34+
useValue: DayOfWeek.Monday,
35+
},
2736
],
28-
})
29-
export class AppModule {}
37+
};
3038

3139
@Component({
3240
// ...
@@ -68,10 +76,10 @@ import {
6876
DAYS_COUNT,
6977
DEFAULT_SUGGESTION_STRATEGY_MAP,
7078
SuggestionStrategyMap,
71-
DateSuggestionModule,
7279
DateSuggestionComposer,
7380
DefaultDateIntervalSuggestion,
7481
endOfDay,
82+
provideDateSuggestion,
7583
shiftDate,
7684
startOfDay,
7785
} from '@angular-ru/cdk/date';
@@ -107,15 +115,9 @@ const EXTENDED_STRATEGY_MAP: SuggestionStrategyMap<ExtendedDateIntervalSuggestio
107115
},
108116
};
109117

110-
@NgModule({
111-
// ...
112-
imports: [
113-
// ...
114-
// Import DateSuggestionModule with created map as parameter
115-
DateSuggestionModule.forRoot(EXTENDED_STRATEGY_MAP),
116-
],
117-
})
118-
export class AppModule {}
118+
export const appConfig: ApplicationConfig = {
119+
providers: [provideDateSuggestion(EXTENDED_STRATEGY_MAP)],
120+
};
119121

120122
@Component({
121123
// ...

docs/cdk/directives.md

Lines changed: 32 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,18 @@
11
#### `@angular-ru/cdk/directives`
22

3-
- `InitialFocusDirective, InitialFocusModule`
3+
- `InitialFocus`
44
- Selector: `initialFocus`
55

66
- API:
7-
87
- `Input() focusDisabled: boolean` - default: `false`
98

109
```typescript
11-
import {InitialFocusModule} from '@angular-ru/cdk/directives';
12-
import {Component, NgModule} from '@angular/core';
13-
14-
@NgModule({
15-
// ..
16-
imports: [InitialFocusModule],
17-
})
18-
export class AppModule {}
10+
import {InitialFocus} from '@angular-ru/cdk/directives';
11+
import {Component} from '@angular/core';
1912

2013
@Component({
2114
//...
15+
imports: [InitialFocus],
2216
template: `
2317
<input
2418
[focusDisabled]="false"
@@ -30,20 +24,15 @@ export class AppModule {}
3024
export class AppComponent {}
3125
```
3226

33-
- `AmountFormatDirective, AmountFormatDirectiveModule`
27+
- `AmountFormat`
3428

3529
```typescript
36-
import {AmountFormatDirectiveModule} from '@angular-ru/cdk/directives';
37-
import {Component, NgModule} from '@angular/core';
38-
39-
@NgModule({
40-
// ..
41-
imports: [AmountFormatDirectiveModule],
42-
})
43-
export class AppModule {}
30+
import {AmountFormat} from '@angular-ru/cdk/directives';
31+
import {Component} from '@angular/core';
4432

4533
@Component({
4634
//...
35+
imports: [AmountFormat],
4736
template: `
4837
<input
4938
amountFormat
@@ -54,20 +43,15 @@ export class AppModule {}
5443
export class AppComponent {}
5544
```
5645

57-
- `ConvertCaseDirective, ConvertCaseDirectiveModule`
46+
- `ConvertCase`
5847

5948
```typescript
60-
import {ConvertCaseDirectiveModule} from '@angular-ru/cdk/directives';
61-
import {Component, NgModule} from '@angular/core';
62-
63-
@NgModule({
64-
// ..
65-
imports: [ConvertCaseDirectiveModule],
66-
})
67-
export class AppModule {}
49+
import {ConvertCase} from '@angular-ru/cdk/directives';
50+
import {Component} from '@angular/core';
6851

6952
@Component({
7053
//...
54+
imports: [ConvertCase],
7155
template: `
7256
<input
7357
convertCase
@@ -78,20 +62,15 @@ export class AppModule {}
7862
export class AppComponent {}
7963
```
8064

81-
- `DisableControlDirective, DisableControlDirectiveModule`
65+
- `DisableControl`
8266

8367
```typescript
84-
import {DisableControlDirectiveModule} from '@angular-ru/cdk/directives';
85-
import {Component, NgModule} from '@angular/core';
86-
87-
@NgModule({
88-
// ..
89-
imports: [DisableControlDirectiveModule],
90-
})
91-
export class AppModule {}
68+
import {DisableControl} from '@angular-ru/cdk/directives';
69+
import {Component} from '@angular/core';
9270

9371
@Component({
9472
//...
73+
imports: [DisableControl],
9574
template: `
9675
<input
9776
disableControl
@@ -102,20 +81,15 @@ export class AppModule {}
10281
export class AppComponent {}
10382
```
10483

105-
- `MaxLengthDirective, MaxLengthDirectiveModule`
84+
- `MaxLength`
10685

10786
```typescript
108-
import {MaxLengthDirectiveModule} from '@angular-ru/cdk/directives';
109-
import {Component, NgModule} from '@angular/core';
110-
111-
@NgModule({
112-
// ..
113-
imports: [MaxLengthDirectiveModule],
114-
})
115-
export class AppModule {}
87+
import {MaxLength} from '@angular-ru/cdk/directives';
88+
import {Component} from '@angular/core';
11689

11790
@Component({
11891
//...
92+
imports: [MaxLength],
11993
template: `
12094
<input
12195
maxLength="3000"
@@ -126,25 +100,20 @@ export class AppModule {}
126100
export class AppComponent {}
127101
```
128102

129-
- `TrimInputDirective, TrimInputModule`
103+
- `TrimInput`
130104
- Selector: `trimInput`
131105

132106
API:
133107

134108
- `@Input('trimDisabled') disabled: boolean` - default: `false`
135109

136110
```typescript
137-
import {TrimInputModule} from '@angular-ru/cdk/directives';
138-
import {Component, NgModule} from '@angular/core';
139-
140-
@NgModule({
141-
// ..
142-
imports: [TrimInputModule],
143-
})
144-
export class AppModule {}
111+
import {TrimInput} from '@angular-ru/cdk/directives';
112+
import {Component} from '@angular/core';
145113

146114
@Component({
147115
//...
116+
imports: [TrimInput],
148117
template: `
149118
<input
150119
[trimDisabled]="false"
@@ -156,20 +125,15 @@ export class AppModule {}
156125
export class AppComponent {}
157126
```
158127

159-
- `SplitStringDirective, SplitStringModule`
128+
- `SplitString`
160129

161130
```typescript
162-
import {SplitStringModule, SplitStringOptions} from '@angular-ru/cdk/directives';
163-
import {Component, NgModule} from '@angular/core';
164-
165-
@NgModule({
166-
// ..
167-
imports: [SplitStringModule],
168-
})
169-
export class AppModule {}
131+
import {SplitString, SplitStringOptions} from '@angular-ru/cdk/directives';
132+
import {Component} from '@angular/core';
170133

171134
@Component({
172135
selector: 'test',
136+
imports: [SplitString],
173137
template: `
174138
<form [formGroup]="form">
175139
<input type="text" formControlName="input1" splitString" />
@@ -202,20 +166,15 @@ class TestComponent {
202166
}
203167
```
204168

205-
- `InputFilterDirective, InputFilterModule`
169+
- `InputFilter`
206170

207171
```typescript
208-
import {InputFilterModule, FilterPredicate} from '@angular-ru/cdk/directives';
209-
import {Component, NgModule} from '@angular/core';
210-
211-
@NgModule({
212-
// ..
213-
imports: [InputFilterModule],
214-
})
215-
export class AppModule {}
172+
import {InputFilter, FilterPredicate} from '@angular-ru/cdk/directives';
173+
import {Component} from '@angular/core';
216174

217175
@Component({
218176
//...
177+
imports: [InputFilter],
219178
template: `
220179
<div [formGroup]="form">
221180
<input

docs/cdk/flex-layout.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ $ npm install @angular-ru/cdk
1717
```
1818

1919
```typescript
20-
import {FlexLayoutModule} from '@angular-ru/cdk/flex-layout';
21-
import {NgModule} from '@angular/core';
20+
import {FlexLayout} from '@angular-ru/cdk/flex-layout';
2221

23-
@NgModule({
22+
@Component({
2423
imports: [
2524
// ...
26-
FlexLayoutModule,
25+
FlexLayout,
2726
],
2827
})
29-
export class AppModule {}
28+
export class AppComponent {}
3029
```

docs/cdk/http.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
## DataHttpClientModule
1+
## DataHttpClient
22

33
Custom http client, with the ability to customize requests, auto unsubscribe and additional request interceptors.
44

55
## Table of contents:
66

77
1. [📖 Changelog](https://github.com/Angular-RU/angular-ru-sdk/blob/master/CHANGELOG.md)
88
2. [📦 Advanced](#table-of-contents)
9-
109
- [@angular-ru/cdk/http/utils](https://github.com/Angular-RU/angular-ru-sdk/blob/master/libs/http/docs/utils.md)
1110
- [@angular-ru/cdk/http/decorators](https://github.com/Angular-RU/angular-ru-sdk/blob/master/libs/http/docs/decorators.md)
1211

@@ -17,21 +16,17 @@ Example, if your API base url placed here `https://my-server.com/api/***` and ha
1716
![](https://habrastorage.org/webt/af/bg/n9/afbgn985tehybqdpk2gs1ymq9se.jpeg)
1817

1918
```typescript
20-
import {HttpClientModule} from '@angular/common/http';
21-
import {DataHttpClientModule} from '@angular-ru/cdk/http';
22-
23-
@NgModule({
24-
imports: [
25-
// ...
26-
HttpClientModule,
27-
DataHttpClientModule.forRoot([ApiUsersClient], {
19+
import {provideHttpClient} from '@angular/common/http';
20+
import {provideDataHttpClientOptions} from '@angular-ru/cdk/http';
21+
22+
export const appConfig: ApplicationConfig = {
23+
providers: [
24+
provideHttpClient(),
25+
provideDataHttpClientOptions([ApiUsersClient], {
2826
hostUrl: 'https://my-server.com/api/',
2927
}),
3028
],
31-
declarations: [AppComponent],
32-
bootstrap: [AppComponent],
33-
})
34-
export class AppModule {}
29+
};
3530
```
3631

3732
#### Create your http client for your api controller
@@ -164,22 +159,21 @@ limits for maximum connections per host name (Chrome: 6)
164159
but if necessary, you can change it <br> for example, <b>limitConcurrency: 5</b> <br> This mean that maximum of 5
165160
requests can be executed in parallel. Next one immediately start only if one of the previous requests is completed
166161

167-
- `app.module.ts`
162+
- `app.config.ts`
168163

169164
```typescript
170-
import {DataHttpClientModule} from '@angular-ru/cdk/http';
165+
import {provideHttpClient} from '@angular/common/http';
166+
import {provideDataHttpClientOptions} from '@angular-ru/cdk/http';
171167

172-
@NgModule({
173-
imports: [
174-
// ...
175-
DataHttpClientModule.forRoot([ApiUsersClient], {
168+
export const appConfig: ApplicationConfig = {
169+
providers: [
170+
provideHttpClient(),
171+
provideDataHttpClientOptions([ApiUsersClient], {
176172
// ...
177173
limitConcurrency: 5,
178174
}),
179175
],
180-
// ...
181-
})
182-
export class AppModule {}
176+
};
183177
```
184178

185179
![](../assets/limit-concurrency-5.png)

0 commit comments

Comments
 (0)