@taiga-ui/addon-doc 4.52.0-canary.e444d19 → 4.52.0-canary.e53e79e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -43
- package/components/api/api-item-number.directive.d.ts +3 -3
- package/components/api/api-item.component.d.ts +10 -7
- package/components/{documentation/pipes → api}/inspect.pipe.d.ts +1 -1
- package/components/{documentation/pipes → api}/type-reference.pipe.d.ts +3 -3
- package/components/code/index.d.ts +4 -3
- package/components/copy/index.d.ts +1 -1
- package/components/demo/index.d.ts +3 -3
- package/components/doc-tab/index.d.ts +2 -2
- package/components/example/example.component.d.ts +8 -8
- package/components/example/example.options.d.ts +1 -3
- package/components/index.d.ts +0 -10
- package/components/internal/header/index.d.ts +3 -4
- package/components/internal/see-also/index.d.ts +2 -2
- package/components/internal/source-code/source-code.component.d.ts +7 -8
- package/components/main/main.component.d.ts +1 -2
- package/components/navigation/navigation.component.d.ts +2 -2
- package/components/page/page-tab.directive.d.ts +2 -2
- package/components/page/page.component.d.ts +10 -10
- package/components/page/page.providers.d.ts +2 -2
- package/fesm2022/taiga-ui-addon-doc-components.mjs +224 -626
- package/fesm2022/taiga-ui-addon-doc-components.mjs.map +1 -1
- package/fesm2022/taiga-ui-addon-doc-services.mjs +3 -3
- package/fesm2022/taiga-ui-addon-doc-tokens.mjs +2 -7
- package/fesm2022/taiga-ui-addon-doc-tokens.mjs.map +1 -1
- package/fesm2022/taiga-ui-addon-doc-utils.mjs +5 -5
- package/fesm2022/taiga-ui-addon-doc-utils.mjs.map +1 -1
- package/fesm2022/taiga-ui-addon-doc.mjs +1 -7
- package/fesm2022/taiga-ui-addon-doc.mjs.map +1 -1
- package/index.d.ts +2 -4
- package/package.json +13 -15
- package/tokens/doc-icons.d.ts +2 -3
- package/utils/inspect.d.ts +1 -1
- package/utils/provide-route-page-tab.d.ts +1 -1
- package/components/documentation/documentation-property-connector.directive.d.ts +0 -32
- package/components/documentation/documentation.component.d.ts +0 -23
- package/components/documentation/pipes/cleaner.pipe.d.ts +0 -7
- package/components/documentation/pipes/color.pipe.d.ts +0 -7
- package/components/documentation/pipes/opacity.pipe.d.ts +0 -7
- package/components/documentation/pipes/optional.pipe.d.ts +0 -7
- package/components/documentation/pipes/primitive-polymorpheus-content.pipe.d.ts +0 -7
- package/components/documentation/pipes/strip-optional.pipe.d.ts +0 -7
- package/directives/index.d.ts +0 -1
- package/directives/text-code/text-code.directive.d.ts +0 -9
- package/fesm2022/taiga-ui-addon-doc-directives.mjs +0 -33
- package/fesm2022/taiga-ui-addon-doc-directives.mjs.map +0 -1
package/README.md
CHANGED
|
@@ -10,13 +10,13 @@
|
|
|
10
10
|
|
|
11
11
|
Install main packages:
|
|
12
12
|
|
|
13
|
-
```
|
|
14
|
-
npm i @taiga-ui/{cdk,core,kit
|
|
13
|
+
```bash
|
|
14
|
+
npm i @taiga-ui/{cdk,core,kit}
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
Install doc:
|
|
18
18
|
|
|
19
|
-
```
|
|
19
|
+
```bash
|
|
20
20
|
npm i @taiga-ui/addon-doc
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -24,24 +24,22 @@ npm i @taiga-ui/addon-doc
|
|
|
24
24
|
|
|
25
25
|
> You can also see [community made guide](https://habr.com/ru/company/europlan/blog/559804/) in Russian
|
|
26
26
|
|
|
27
|
-
1. Include `
|
|
27
|
+
1. Include `TuiDocMain` in your App imports and use in your template:
|
|
28
28
|
|
|
29
29
|
```html
|
|
30
30
|
<tui-doc-main>You can add content here, it will be shown below navigation in the sidebar</tui-doc-main>
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
2. Configure languages to highlight in your
|
|
33
|
+
2. Configure languages to highlight in your root providers:
|
|
34
34
|
|
|
35
35
|
```typescript
|
|
36
36
|
import {Component} from '@angular/core';
|
|
37
|
-
import {
|
|
38
|
-
import {
|
|
39
|
-
import {HIGHLIGHT_OPTIONS, HighlightLanguage} from 'ngx-highlightjs';
|
|
37
|
+
import {TuiDocMain} from '@taiga-ui/addon-doc';
|
|
38
|
+
import {HIGHLIGHT_OPTIONS} from 'ngx-highlightjs';
|
|
40
39
|
import {App} from './app.component';
|
|
41
40
|
|
|
42
41
|
@Component({
|
|
43
|
-
|
|
44
|
-
imports: [TuiDocMainModule],
|
|
42
|
+
imports: [TuiDocMain],
|
|
45
43
|
providers: [
|
|
46
44
|
{
|
|
47
45
|
provide: HIGHLIGHT_OPTIONS,
|
|
@@ -81,10 +79,10 @@ npm i @taiga-ui/addon-doc
|
|
|
81
79
|
|
|
82
80
|
const appRoutes: Routes = [
|
|
83
81
|
{
|
|
84
|
-
path: '
|
|
85
|
-
|
|
82
|
+
path: 'doc-page-1',
|
|
83
|
+
loadComponent: async () => (await import('../doc-page-1')).DocPage,
|
|
86
84
|
data: {
|
|
87
|
-
title: '
|
|
85
|
+
title: 'Documentation page #1',
|
|
88
86
|
},
|
|
89
87
|
},
|
|
90
88
|
// ...
|
|
@@ -96,42 +94,34 @@ npm i @taiga-ui/addon-doc
|
|
|
96
94
|
|
|
97
95
|
5. Create pages.
|
|
98
96
|
|
|
99
|
-
_Module:_
|
|
100
|
-
|
|
101
|
-
```ts
|
|
102
|
-
import {TuiAddonDoc} from '@taiga-ui/addon-doc';
|
|
103
|
-
|
|
104
|
-
@Component({
|
|
105
|
-
standalone: true,
|
|
106
|
-
imports: [TuiAddonDoc, SuperComponent],
|
|
107
|
-
})
|
|
108
|
-
export class App {}
|
|
109
|
-
```
|
|
110
|
-
|
|
111
97
|
_Component:_
|
|
112
98
|
|
|
113
99
|
```ts
|
|
114
100
|
// ..
|
|
115
101
|
|
|
116
102
|
@Component({
|
|
117
|
-
|
|
118
|
-
selector: 'super',
|
|
103
|
+
selector: 'first-doc-page',
|
|
119
104
|
templateUrl: './super.component.html',
|
|
105
|
+
imports: [TuiAddonDoc],
|
|
120
106
|
})
|
|
121
|
-
export class
|
|
107
|
+
export class DocPage {
|
|
122
108
|
// Keys would be used as tabs for code example
|
|
123
109
|
readonly example = {
|
|
124
110
|
// import a file as a string
|
|
125
|
-
TypeScript: import('./examples/1/index.ts?raw'),
|
|
126
|
-
HTML: import('./examples/1/index.html
|
|
111
|
+
TypeScript: import('./examples/1/index.ts?raw', {with: {loader: 'text'}}),
|
|
112
|
+
HTML: import('./examples/1/index.html', {with: {loader: 'text'}}),
|
|
113
|
+
LESS: '.box { color: red }',
|
|
127
114
|
};
|
|
128
115
|
|
|
129
116
|
readonly inputVariants = ['input 1', 'input 2'];
|
|
130
117
|
}
|
|
131
118
|
```
|
|
132
119
|
|
|
133
|
-
> You can use any tool to import a file as a string. For example, you can use
|
|
134
|
-
>
|
|
120
|
+
> You can use any tool to import a file as a string. For example, you can use:
|
|
121
|
+
>
|
|
122
|
+
> - [Esbuild loaders](https://angular.dev/tools/cli/build-system-migration#file-extension-loader-customization)
|
|
123
|
+
> (recommended)
|
|
124
|
+
> - [Webpack Asset Modules](https://webpack.js.org/guides/asset-modules)
|
|
135
125
|
|
|
136
126
|
_Template:_
|
|
137
127
|
|
|
@@ -139,7 +129,6 @@ npm i @taiga-ui/addon-doc
|
|
|
139
129
|
<tui-doc-page
|
|
140
130
|
header="Super"
|
|
141
131
|
package="SUPER-PACKAGE"
|
|
142
|
-
deprecated
|
|
143
132
|
>
|
|
144
133
|
<ng-template pageTab>
|
|
145
134
|
<!-- default tab name would be used -->
|
|
@@ -158,17 +147,18 @@ npm i @taiga-ui/addon-doc
|
|
|
158
147
|
<tui-doc-demo>
|
|
159
148
|
<super-component [input]="input"></super-component>
|
|
160
149
|
</tui-doc-demo>
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
[
|
|
150
|
+
|
|
151
|
+
<table tuiDocAPI>
|
|
152
|
+
<tr
|
|
153
|
+
name="[input]"
|
|
154
|
+
tuiDocAPIItem
|
|
155
|
+
type="T"
|
|
156
|
+
[items]="inputVariants"
|
|
157
|
+
[(value)]="input"
|
|
168
158
|
>
|
|
169
|
-
Some input
|
|
170
|
-
</
|
|
171
|
-
</
|
|
159
|
+
Some input description
|
|
160
|
+
</tr>
|
|
161
|
+
</table>
|
|
172
162
|
</ng-template>
|
|
173
163
|
</tui-doc-page>
|
|
174
164
|
```
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as i0 from "@angular/core";
|
|
2
2
|
export declare class TuiDocAPINumberItem {
|
|
3
|
-
min: number | null
|
|
4
|
-
max: number | null
|
|
3
|
+
readonly min: import("@angular/core").InputSignal<number | null>;
|
|
4
|
+
readonly max: import("@angular/core").InputSignal<number | null>;
|
|
5
5
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocAPINumberItem, never>;
|
|
6
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<TuiDocAPINumberItem, "tr[tuiDocAPIItem][type=number]", never, { "min": { "alias": "min"; "required": false; }; "max": { "alias": "max"; "required": false; }; }, {}, never, never, true, never>;
|
|
6
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<TuiDocAPINumberItem, "tr[tuiDocAPIItem][type=number]", never, { "min": { "alias": "min"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
7
7
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { type OnInit } from '@angular/core';
|
|
2
2
|
import { TuiDocAPINumberItem } from './api-item-number.directive';
|
|
3
3
|
import * as i0 from "@angular/core";
|
|
4
4
|
export declare class TuiDocAPIItem<T> implements OnInit {
|
|
@@ -9,11 +9,14 @@ export declare class TuiDocAPIItem<T> implements OnInit {
|
|
|
9
9
|
private readonly alerts;
|
|
10
10
|
protected readonly icons: import("@taiga-ui/addon-doc/tokens").TuiDocIcons;
|
|
11
11
|
protected readonly numberItem: TuiDocAPINumberItem | null;
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
readonly
|
|
12
|
+
protected readonly isBananaBox: import("@angular/core").Signal<boolean>;
|
|
13
|
+
protected readonly isInput: import("@angular/core").Signal<boolean>;
|
|
14
|
+
protected readonly isOutput: import("@angular/core").Signal<boolean>;
|
|
15
|
+
readonly name: import("@angular/core").InputSignal<string>;
|
|
16
|
+
readonly type: import("@angular/core").InputSignal<string>;
|
|
17
|
+
readonly value: import("@angular/core").ModelSignal<T | undefined>;
|
|
18
|
+
readonly items: import("@angular/core").InputSignal<readonly T[]>;
|
|
19
|
+
protected readonly hasCleaner: import("@angular/core").Signal<boolean>;
|
|
17
20
|
ngOnInit(): void;
|
|
18
21
|
onValueChange(value: T): void;
|
|
19
22
|
emitEvent(event: unknown): void;
|
|
@@ -21,5 +24,5 @@ export declare class TuiDocAPIItem<T> implements OnInit {
|
|
|
21
24
|
private parseParams;
|
|
22
25
|
private setQueryParam;
|
|
23
26
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocAPIItem<any>, never>;
|
|
24
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocAPIItem<any>, "tr[tuiDocAPIItem]", never, { "name": { "alias": "name"; "required": false; }; "type": { "alias": "type"; "required": false; }; "value": { "alias": "value"; "required": false; }; "items": { "alias": "items"; "required": false; }; }, { "
|
|
27
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocAPIItem<any>, "tr[tuiDocAPIItem]", never, { "name": { "alias": "name"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "items": { "alias": "items"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, never, ["*"], true, never>;
|
|
25
28
|
}
|
|
@@ -4,5 +4,5 @@ export declare class TuiInspectPipe implements PipeTransform {
|
|
|
4
4
|
private readonly isE2E;
|
|
5
5
|
transform(value: unknown, depth?: number): string;
|
|
6
6
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiInspectPipe, never>;
|
|
7
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<TuiInspectPipe, "
|
|
7
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<TuiInspectPipe, "tuiInspect", true>;
|
|
8
8
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type PipeTransform } from '@angular/core';
|
|
2
2
|
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class
|
|
3
|
+
export declare class TuiTypeReferencePipe implements PipeTransform {
|
|
4
4
|
private readonly parser;
|
|
5
5
|
private readonly linkHandler;
|
|
6
6
|
transform(original: string): ReadonlyArray<{
|
|
@@ -8,6 +8,6 @@ export declare class TuiDocTypeReferencePipe implements PipeTransform {
|
|
|
8
8
|
extracted: string;
|
|
9
9
|
reference: string | null;
|
|
10
10
|
}>;
|
|
11
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<
|
|
12
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<
|
|
11
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<TuiTypeReferencePipe, never>;
|
|
12
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<TuiTypeReferencePipe, "tuiTypeReference", true>;
|
|
13
13
|
}
|
|
@@ -5,15 +5,16 @@ import * as i0 from "@angular/core";
|
|
|
5
5
|
export declare class TuiDocCode {
|
|
6
6
|
private readonly icons;
|
|
7
7
|
private readonly rawLoader$$;
|
|
8
|
+
private readonly texts;
|
|
8
9
|
protected readonly isServer: boolean;
|
|
9
10
|
protected readonly markdownCodeProcessor: TuiHandler<string, readonly string[]>;
|
|
10
11
|
protected readonly copy$: Subject<void>;
|
|
11
|
-
protected readonly copyText: import("@angular/core").Signal<string
|
|
12
|
+
protected readonly copyText: import("@angular/core").Signal<string>;
|
|
12
13
|
protected readonly icon: import("@angular/core").Signal<string>;
|
|
13
14
|
protected readonly processor: import("@angular/core").Signal<readonly string[] | readonly []>;
|
|
14
|
-
filename: string
|
|
15
|
+
readonly filename: import("@angular/core").InputSignal<string>;
|
|
15
16
|
set code(code: TuiRawLoaderContent);
|
|
16
17
|
get hasFilename(): boolean;
|
|
17
18
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocCode, never>;
|
|
18
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocCode, "tui-doc-code", never, { "filename": { "alias": "filename"; "required": false; }; "code": { "alias": "code"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
19
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocCode, "tui-doc-code", never, { "filename": { "alias": "filename"; "required": false; "isSignal": true; }; "code": { "alias": "code"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
19
20
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as i0 from "@angular/core";
|
|
2
2
|
export declare class TuiDocCopy {
|
|
3
3
|
private readonly copy$;
|
|
4
|
-
protected readonly texts: import("@angular/core").Signal<readonly [copy: string, copied: string]
|
|
4
|
+
protected readonly texts: import("@angular/core").Signal<readonly [copy: string, copied: string]>;
|
|
5
5
|
protected readonly copied: import("@angular/core").Signal<boolean>;
|
|
6
6
|
protected onClick(): void;
|
|
7
7
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocCopy, never>;
|
|
@@ -22,8 +22,8 @@ export declare class TuiDocDemo implements AfterViewInit {
|
|
|
22
22
|
protected expanded: boolean;
|
|
23
23
|
protected sandboxWidth: number;
|
|
24
24
|
protected readonly texts: [string, string, string];
|
|
25
|
-
control: AbstractControl | null
|
|
26
|
-
sticky: boolean
|
|
25
|
+
readonly control: import("@angular/core").InputSignal<AbstractControl<any, any> | null>;
|
|
26
|
+
readonly sticky: import("@angular/core").InputSignal<boolean>;
|
|
27
27
|
ngAfterViewInit(): void;
|
|
28
28
|
protected onResize(): void;
|
|
29
29
|
protected onMouseUp(): void;
|
|
@@ -38,5 +38,5 @@ export declare class TuiDocDemo implements AfterViewInit {
|
|
|
38
38
|
private createForm;
|
|
39
39
|
private getUrlTree;
|
|
40
40
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocDemo, never>;
|
|
41
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocDemo, "tui-doc-demo", never, { "control": { "alias": "control"; "required": false; }; "sticky": { "alias": "sticky"; "required": false; }; }, {}, ["template"], ["*"], true, never>;
|
|
41
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocDemo, "tui-doc-demo", never, { "control": { "alias": "control"; "required": false; "isSignal": true; }; "sticky": { "alias": "sticky"; "required": false; "isSignal": true; }; }, {}, ["template"], ["*"], true, never>;
|
|
42
42
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as i0 from "@angular/core";
|
|
2
2
|
export declare class TuiDocTab {
|
|
3
|
-
src: string
|
|
3
|
+
readonly src: import("@angular/core").InputSignal<string>;
|
|
4
4
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocTab, never>;
|
|
5
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocTab, "tui-doc-tab", never, { "src": { "alias": "src"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
5
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocTab, "tui-doc-tab", never, { "src": { "alias": "src"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
|
|
6
6
|
}
|
|
@@ -8,7 +8,7 @@ export declare class TuiDocExample {
|
|
|
8
8
|
private readonly clipboard;
|
|
9
9
|
private readonly alerts;
|
|
10
10
|
private readonly location;
|
|
11
|
-
private readonly copyTexts
|
|
11
|
+
private readonly copyTexts;
|
|
12
12
|
private readonly processContent;
|
|
13
13
|
private readonly rawLoader$$;
|
|
14
14
|
protected readonly fullscreenEnabled: boolean;
|
|
@@ -25,17 +25,17 @@ export declare class TuiDocExample {
|
|
|
25
25
|
protected readonly copy: import("@angular/core").Signal<string>;
|
|
26
26
|
protected readonly loading: import("@angular/core").WritableSignal<boolean>;
|
|
27
27
|
protected readonly processor: import("@angular/core").Signal<Record<string, string>>;
|
|
28
|
-
id: string | null
|
|
29
|
-
heading: PolymorpheusContent
|
|
30
|
-
description: PolymorpheusContent
|
|
31
|
-
fullsize: boolean
|
|
32
|
-
componentName: string
|
|
33
|
-
component
|
|
28
|
+
readonly id: import("@angular/core").InputSignal<string | null>;
|
|
29
|
+
readonly heading: import("@angular/core").InputSignal<PolymorpheusContent>;
|
|
30
|
+
readonly description: import("@angular/core").InputSignal<PolymorpheusContent>;
|
|
31
|
+
readonly fullsize: import("@angular/core").InputSignal<boolean>;
|
|
32
|
+
readonly componentName: import("@angular/core").InputSignal<string>;
|
|
33
|
+
readonly component: import("@angular/core").InputSignal<Promise<Type<unknown>> | undefined>;
|
|
34
34
|
set content(content: Record<string, TuiRawLoaderContent>);
|
|
35
35
|
protected readonly visible: (files: Record<string, string>) => boolean;
|
|
36
36
|
protected getTabTitle(fileName: string): PolymorpheusContent;
|
|
37
37
|
protected copyExampleLink(target: EventTarget | null): void;
|
|
38
38
|
protected edit(files: Record<string, string>): void;
|
|
39
39
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocExample, never>;
|
|
40
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocExample, "tui-doc-example", never, { "id": { "alias": "id"; "required": false; }; "heading": { "alias": "heading"; "required": false; }; "description": { "alias": "description"; "required": false; }; "fullsize": { "alias": "fullsize"; "required": false; }; "componentName": { "alias": "componentName"; "required": false; }; "component": { "alias": "component"; "required": false; }; "content": { "alias": "content"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
40
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocExample, "tui-doc-example", never, { "id": { "alias": "id"; "required": false; "isSignal": true; }; "heading": { "alias": "heading"; "required": false; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; "fullsize": { "alias": "fullsize"; "required": false; "isSignal": true; }; "componentName": { "alias": "componentName"; "required": false; "isSignal": true; }; "component": { "alias": "component"; "required": false; "isSignal": true; }; "content": { "alias": "content"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
41
41
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { InjectionToken, type Provider } from '@angular/core';
|
|
2
1
|
import { type TuiBooleanHandler } from '@taiga-ui/cdk/types';
|
|
3
2
|
import { type PolymorpheusContent } from '@taiga-ui/polymorpheus';
|
|
4
3
|
export interface TuiDocExampleOptions {
|
|
@@ -10,5 +9,4 @@ export declare const TUI_DOC_EXAMPLE_DEFAULT_OPTIONS: TuiDocExampleOptions;
|
|
|
10
9
|
/**
|
|
11
10
|
* Default parameters for DocExample component
|
|
12
11
|
*/
|
|
13
|
-
export declare const TUI_DOC_EXAMPLE_OPTIONS: InjectionToken<TuiDocExampleOptions
|
|
14
|
-
export declare function tuiDocExampleOptionsProvider(options: Partial<TuiDocExampleOptions>): Provider;
|
|
12
|
+
export declare const TUI_DOC_EXAMPLE_OPTIONS: import("@angular/core").InjectionToken<TuiDocExampleOptions>, tuiDocExampleOptionsProvider: (item: Partial<TuiDocExampleOptions> | (() => Partial<TuiDocExampleOptions>)) => import("@angular/core").FactoryProvider;
|
package/components/index.d.ts
CHANGED
|
@@ -5,16 +5,6 @@ export * from './code';
|
|
|
5
5
|
export * from './copy';
|
|
6
6
|
export * from './demo';
|
|
7
7
|
export * from './doc-tab';
|
|
8
|
-
export * from './documentation/documentation.component';
|
|
9
|
-
export * from './documentation/documentation-property-connector.directive';
|
|
10
|
-
export * from './documentation/pipes/cleaner.pipe';
|
|
11
|
-
export * from './documentation/pipes/color.pipe';
|
|
12
|
-
export * from './documentation/pipes/inspect.pipe';
|
|
13
|
-
export * from './documentation/pipes/opacity.pipe';
|
|
14
|
-
export * from './documentation/pipes/optional.pipe';
|
|
15
|
-
export * from './documentation/pipes/primitive-polymorpheus-content.pipe';
|
|
16
|
-
export * from './documentation/pipes/strip-optional.pipe';
|
|
17
|
-
export * from './documentation/pipes/type-reference.pipe';
|
|
18
8
|
export * from './example/example.component';
|
|
19
9
|
export * from './example/example.options';
|
|
20
10
|
export * from './example/example-get-tabs.pipe';
|
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
import * as i0 from "@angular/core";
|
|
2
2
|
export declare class TuiDocHeader {
|
|
3
|
-
private readonly stream$;
|
|
4
3
|
private readonly router;
|
|
4
|
+
private readonly routeEvents;
|
|
5
5
|
protected readonly icons: import("@taiga-ui/addon-doc/tokens").TuiDocIcons;
|
|
6
6
|
protected readonly logo: import("@taiga-ui/polymorpheus").PolymorpheusContent;
|
|
7
7
|
protected readonly menu: string;
|
|
8
|
-
protected readonly open: import("@angular/core").
|
|
9
|
-
|
|
10
|
-
protected onActiveZone(active: boolean): void;
|
|
8
|
+
protected readonly open: import("@angular/core").WritableSignal<boolean>;
|
|
9
|
+
constructor();
|
|
11
10
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocHeader, never>;
|
|
12
11
|
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocHeader, "header[tuiDocHeader]", never, {}, {}, never, ["*"], true, never>;
|
|
13
12
|
}
|
|
@@ -2,8 +2,8 @@ import * as i0 from "@angular/core";
|
|
|
2
2
|
export declare class TuiDocSeeAlso {
|
|
3
3
|
private readonly pages;
|
|
4
4
|
protected readonly text: string;
|
|
5
|
-
seeAlso: readonly string[]
|
|
5
|
+
readonly seeAlso: import("@angular/core").InputSignal<readonly string[]>;
|
|
6
6
|
protected getRouterLink(pageTitle: string): string;
|
|
7
7
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocSeeAlso, never>;
|
|
8
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocSeeAlso, "tui-doc-see-also", never, { "seeAlso": { "alias": "seeAlso"; "required": false; }; }, {}, never, never, true, never>;
|
|
8
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocSeeAlso, "tui-doc-see-also", never, { "seeAlso": { "alias": "seeAlso"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
9
9
|
}
|
|
@@ -4,13 +4,12 @@ export declare class TuiDocSourceCode {
|
|
|
4
4
|
protected readonly icons: import("@taiga-ui/addon-doc/tokens").TuiDocIcons;
|
|
5
5
|
protected readonly sourceCode: import("@taiga-ui/polymorpheus").PolymorpheusContent<TuiDocSourceCodePathOptions>;
|
|
6
6
|
protected readonly text: string;
|
|
7
|
-
header: string
|
|
8
|
-
package: string
|
|
9
|
-
type: string
|
|
10
|
-
path: string
|
|
11
|
-
protected
|
|
12
|
-
protected pathIsUrl
|
|
13
|
-
private getPathOptions;
|
|
7
|
+
readonly header: import("@angular/core").InputSignal<string>;
|
|
8
|
+
readonly package: import("@angular/core").InputSignal<string>;
|
|
9
|
+
readonly type: import("@angular/core").InputSignal<string>;
|
|
10
|
+
readonly path: import("@angular/core").InputSignal<string>;
|
|
11
|
+
protected readonly pathOptions: import("@angular/core").Signal<TuiDocSourceCodePathOptions>;
|
|
12
|
+
protected readonly pathIsUrl: import("@angular/core").Signal<boolean>;
|
|
14
13
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocSourceCode, never>;
|
|
15
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocSourceCode, "tui-doc-source-code", never, { "header": { "alias": "header"; "required": false; }; "package": { "alias": "package"; "required": false; }; "type": { "alias": "type"; "required": false; }; "path": { "alias": "path"; "required": false; }; }, {}, never, never, true, never>;
|
|
14
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocSourceCode, "tui-doc-source-code", never, { "header": { "alias": "header"; "required": false; "isSignal": true; }; "package": { "alias": "package"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; "isSignal": true; }; "path": { "alias": "path"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
16
15
|
}
|
|
@@ -6,9 +6,8 @@ export declare class TuiDocMain {
|
|
|
6
6
|
protected readonly darkMode: import("@angular/core").WritableSignal<boolean> & {
|
|
7
7
|
reset(): void;
|
|
8
8
|
};
|
|
9
|
-
protected readonly theme: import("@angular/core").Signal<"dark" | null>;
|
|
10
9
|
protected readonly icon: import("@angular/core").Signal<string>;
|
|
11
10
|
changeTextDirection(): void;
|
|
12
11
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocMain, never>;
|
|
13
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocMain, "tui-doc-main", never, {}, {}, never, ["tuiDocNavigation", "tuiDocHeader", "tuiOverContent"
|
|
12
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocMain, "tui-doc-main", never, {}, {}, never, ["tuiDocNavigation", "tuiDocHeader", "tuiOverContent"], true, never>;
|
|
14
13
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FormControl } from '@angular/forms';
|
|
2
2
|
import { type TuiDocRoutePage, type TuiDocRoutePages } from '@taiga-ui/addon-doc/types';
|
|
3
|
-
import {
|
|
3
|
+
import { TuiDrawer } from '@taiga-ui/kit/components/drawer';
|
|
4
4
|
import * as i0 from "@angular/core";
|
|
5
5
|
export declare class TuiDocNavigation {
|
|
6
6
|
private readonly searchInput?;
|
|
@@ -8,7 +8,7 @@ export declare class TuiDocNavigation {
|
|
|
8
8
|
private readonly doc;
|
|
9
9
|
protected open: import("@angular/core").WritableSignal<boolean>;
|
|
10
10
|
protected menuOpen: boolean;
|
|
11
|
-
protected readonly
|
|
11
|
+
protected readonly drawer: TuiDrawer | null;
|
|
12
12
|
protected readonly labels: readonly string[];
|
|
13
13
|
protected readonly items: readonly TuiDocRoutePages[];
|
|
14
14
|
protected readonly searchText: string;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { TemplateRef } from '@angular/core';
|
|
2
2
|
import * as i0 from "@angular/core";
|
|
3
3
|
export declare class TuiDocPageTabConnector {
|
|
4
|
-
pageTab
|
|
4
|
+
readonly pageTab: import("@angular/core").InputSignal<string | undefined>;
|
|
5
5
|
readonly template: TemplateRef<any>;
|
|
6
6
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocPageTabConnector, never>;
|
|
7
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<TuiDocPageTabConnector, "ng-template[pageTab]", never, { "pageTab": { "alias": "pageTab"; "required": false; }; }, {}, never, never, true, never>;
|
|
7
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<TuiDocPageTabConnector, "ng-template[pageTab]", never, { "pageTab": { "alias": "pageTab"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
8
8
|
}
|
|
@@ -7,16 +7,16 @@ export declare class TuiDocPage {
|
|
|
7
7
|
protected readonly defaultTabs: readonly string[];
|
|
8
8
|
protected readonly from: RegExp;
|
|
9
9
|
protected readonly to = "_";
|
|
10
|
-
header: string
|
|
11
|
-
package: string
|
|
12
|
-
type: string
|
|
13
|
-
tags: string[]
|
|
14
|
-
path: string
|
|
15
|
-
deprecated: boolean |
|
|
10
|
+
readonly header: import("@angular/core").InputSignal<string>;
|
|
11
|
+
readonly package: import("@angular/core").InputSignal<string>;
|
|
12
|
+
readonly type: import("@angular/core").InputSignal<string>;
|
|
13
|
+
readonly tags: import("@angular/core").InputSignal<string[]>;
|
|
14
|
+
readonly path: import("@angular/core").InputSignal<string>;
|
|
15
|
+
readonly deprecated: import("@angular/core").InputSignal<boolean | "">;
|
|
16
16
|
readonly tabConnectors: QueryList<TuiDocPageTabConnector>;
|
|
17
|
-
activeItemIndex: number
|
|
18
|
-
readonly seeAlso: readonly string[]
|
|
19
|
-
|
|
17
|
+
readonly activeItemIndex: import("@angular/core").ModelSignal<number>;
|
|
18
|
+
readonly seeAlso: import("@angular/core").WritableSignal<readonly string[]>;
|
|
19
|
+
readonly showSeeAlso: import("@angular/core").Signal<boolean>;
|
|
20
20
|
static ɵfac: i0.ɵɵFactoryDeclaration<TuiDocPage, never>;
|
|
21
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocPage, "tui-doc-page", never, { "header": { "alias": "header"; "required": false; }; "package": { "alias": "package"; "required": false; }; "type": { "alias": "type"; "required": false; }; "tags": { "alias": "tags"; "required": false; }; "path": { "alias": "path"; "required": false; }; "deprecated": { "alias": "deprecated"; "required": false; }; }, {}, ["tabConnectors"], ["*"], true, never>;
|
|
21
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<TuiDocPage, "tui-doc-page", never, { "header": { "alias": "header"; "required": false; "isSignal": true; }; "package": { "alias": "package"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; "isSignal": true; }; "tags": { "alias": "tags"; "required": false; "isSignal": true; }; "path": { "alias": "path"; "required": false; "isSignal": true; }; "deprecated": { "alias": "deprecated"; "required": false; "isSignal": true; }; "activeItemIndex": { "alias": "activeItemIndex"; "required": false; "isSignal": true; }; }, { "activeItemIndex": "activeItemIndexChange"; }, ["tabConnectors"], ["*"], true, never>;
|
|
22
22
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { InjectionToken, type Provider } from '@angular/core';
|
|
1
|
+
import { InjectionToken, type Provider, type WritableSignal } from '@angular/core';
|
|
2
2
|
import { type ActivatedRouteSnapshot } from '@angular/router';
|
|
3
3
|
import { type TuiHandler } from '@taiga-ui/cdk/types';
|
|
4
4
|
import { type PolymorpheusContent } from '@taiga-ui/polymorpheus';
|
|
@@ -6,5 +6,5 @@ export declare const TUI_DOC_TABS: InjectionToken<TuiHandler<ActivatedRouteSnaps
|
|
|
6
6
|
/**
|
|
7
7
|
* Array if related page titles
|
|
8
8
|
*/
|
|
9
|
-
export declare const PAGE_SEE_ALSO: InjectionToken<readonly string[]
|
|
9
|
+
export declare const PAGE_SEE_ALSO: InjectionToken<WritableSignal<readonly string[]>>;
|
|
10
10
|
export declare const PAGE_PROVIDERS: Provider[];
|