@taiga-ui/addon-doc 3.11.0 → 3.12.0

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.
Files changed (36) hide show
  1. package/README.md +8 -4
  2. package/bundles/taiga-ui-addon-doc.umd.js +238 -80
  3. package/bundles/taiga-ui-addon-doc.umd.js.map +1 -1
  4. package/components/demo/demo.component.d.ts +11 -3
  5. package/components/documentation/documentation-property-connector.directive.d.ts +1 -1
  6. package/components/documentation/documentation.component.d.ts +8 -9
  7. package/components/documentation/documentation.module.d.ts +16 -9
  8. package/components/documentation/pipes/cleaner.pipe.d.ts +7 -0
  9. package/components/documentation/pipes/content-tooltip.pipe.d.ts +7 -0
  10. package/components/documentation/pipes/opacity.pipe.d.ts +7 -0
  11. package/components/documentation/pipes/optional.pipe.d.ts +7 -0
  12. package/components/documentation/pipes/primitive-polymorpheus-content.pipe.d.ts +7 -0
  13. package/components/documentation/pipes/strip-optional.pipe.d.ts +7 -0
  14. package/components/documentation/pipes//321/201olor.pipe.d.ts +7 -0
  15. package/components/navigation/navigation.component.d.ts +1 -1
  16. package/directives/scroll-into-view/scroll-into-view.directive.d.ts +1 -1
  17. package/esm2015/components/demo/demo.component.js +62 -20
  18. package/esm2015/components/documentation/documentation-property-connector.directive.js +1 -1
  19. package/esm2015/components/documentation/documentation.component.js +36 -64
  20. package/esm2015/components/documentation/documentation.module.js +22 -1
  21. package/esm2015/components/documentation/pipes/cleaner.pipe.js +14 -0
  22. package/esm2015/components/documentation/pipes/content-tooltip.pipe.js +14 -0
  23. package/esm2015/components/documentation/pipes/opacity.pipe.js +26 -0
  24. package/esm2015/components/documentation/pipes/optional.pipe.js +14 -0
  25. package/esm2015/components/documentation/pipes/primitive-polymorpheus-content.pipe.js +15 -0
  26. package/esm2015/components/documentation/pipes/strip-optional.pipe.js +14 -0
  27. package/esm2015/components/documentation/pipes//321/201olor.pipe.js +35 -0
  28. package/esm2015/components/navigation/navigation.component.js +5 -3
  29. package/esm2015/directives/scroll-into-view/scroll-into-view.directive.js +5 -3
  30. package/esm2015/internal/see-also/see-also.component.js +1 -1
  31. package/esm2015/utils/coerce-value.js +1 -1
  32. package/fesm2015/taiga-ui-addon-doc.js +217 -80
  33. package/fesm2015/taiga-ui-addon-doc.js.map +1 -1
  34. package/internal/see-also/see-also.component.d.ts +1 -1
  35. package/package.json +9 -9
  36. package/utils/coerce-value.d.ts +1 -1
package/README.md CHANGED
@@ -11,7 +11,7 @@
11
11
  Install main packages:
12
12
 
13
13
  ```
14
- npm i @taiga-ui/{cdk,core,kit}
14
+ npm i @taiga-ui/{cdk,core,kit,addon-mobile}
15
15
  ```
16
16
 
17
17
  Install doc:
@@ -81,7 +81,7 @@ npm i @taiga-ui/addon-doc
81
81
  const appRoutes: Routes = [
82
82
  {
83
83
  path: 'super-page',
84
- loadChildren: '../super-page/super-page.module#SuperModule',
84
+ loadChildren: async () => (await import('../super-page/super-page.module')).SuperModule,
85
85
  data: {
86
86
  title: 'Super Page',
87
87
  },
@@ -100,11 +100,11 @@ npm i @taiga-ui/addon-doc
100
100
  ```typescript
101
101
  import {NgModule} from '@angular/core';
102
102
  import {RouterModule} from '@angular/router';
103
- import {generateRoutes, TuiAddonDocModule} from '@taiga-ui/addon-doc';
103
+ import {tuiGenerateRoutes, TuiAddonDocModule} from '@taiga-ui/addon-doc';
104
104
  import {SuperComponent} from './super.component';
105
105
 
106
106
  @NgModule({
107
- imports: [TuiAddonDocModule, RouterModule.forChild(generateRoutes(SuperComponent))],
107
+ imports: [TuiAddonDocModule, RouterModule.forChild(tuiGenerateRoutes(SuperComponent))],
108
108
  declarations: [SuperComponent],
109
109
  exports: [SuperComponent],
110
110
  })
@@ -123,6 +123,7 @@ npm i @taiga-ui/addon-doc
123
123
  export class SuperComponent {
124
124
  // Keys would be used as tabs for code example
125
125
  readonly example = {
126
+ // import a file as a string
126
127
  TypeScript: import('./examples/1/index.ts?raw'),
127
128
  HTML: import('./examples/1/index.html?raw'),
128
129
  };
@@ -131,6 +132,9 @@ npm i @taiga-ui/addon-doc
131
132
  }
132
133
  ```
133
134
 
135
+ > You can use any tool to import a file as a string. For example, you can use
136
+ > [Webpack Asset Modules](https://webpack.js.org/guides/asset-modules/).
137
+
134
138
  _Template:_
135
139
 
136
140
  ```html