@ng-doc/app 19.2.0 → 20.0.0-beta.1

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 (286) hide show
  1. package/classes/default-search-engine/index.d.ts +44 -1
  2. package/classes/root-page/index.d.ts +35 -1
  3. package/classes/search-engine/index.d.ts +11 -1
  4. package/components/api-list/index.d.ts +30 -1
  5. package/components/breadcrumb/index.d.ts +10 -1
  6. package/components/code/index.d.ts +16 -1
  7. package/components/copy-button/index.d.ts +15 -1
  8. package/components/demo/index.d.ts +22 -1
  9. package/components/demo-displayer/index.d.ts +16 -1
  10. package/components/demo-pane/index.d.ts +21 -1
  11. package/components/fullscreen-button/index.d.ts +9 -1
  12. package/components/heading-anchor/index.d.ts +12 -1
  13. package/components/image-viewer/index.d.ts +19 -1
  14. package/components/kind-icon/index.d.ts +11 -1
  15. package/components/link/index.d.ts +9 -1
  16. package/components/mermaid-viewer/index.d.ts +20 -1
  17. package/components/navbar/index.d.ts +33 -1
  18. package/components/page/index.d.ts +19 -1
  19. package/components/page-header/index.d.ts +9 -1
  20. package/components/page-link/index.d.ts +22 -1
  21. package/components/page-navigation/index.d.ts +11 -1
  22. package/components/page-wrapper/index.d.ts +26 -1
  23. package/components/playground/index.d.ts +143 -7
  24. package/components/root/index.d.ts +60 -1
  25. package/components/search/index.d.ts +18 -1
  26. package/components/search-dialog/index.d.ts +28 -1
  27. package/components/search-result/index.d.ts +14 -1
  28. package/components/sidebar/index.d.ts +15 -1
  29. package/components/tabs/index.d.ts +12 -1
  30. package/components/theme-toggle/index.d.ts +19 -1
  31. package/components/toc/index.d.ts +38 -2
  32. package/constants/index.d.ts +3 -1
  33. package/defaults/default-processors/index.d.ts +5 -1
  34. package/defaults/default-skeleton/index.d.ts +5 -1
  35. package/directives/code-highlighter/index.d.ts +17 -1
  36. package/directives/route-active/index.d.ts +13 -1
  37. package/fesm2022/ng-doc-app-classes-default-search-engine.mjs.map +1 -1
  38. package/fesm2022/ng-doc-app-classes-root-page.mjs.map +1 -1
  39. package/fesm2022/ng-doc-app-classes-search-engine.mjs.map +1 -1
  40. package/fesm2022/ng-doc-app-classes.mjs.map +1 -1
  41. package/fesm2022/ng-doc-app-components-api-list.mjs +5 -8
  42. package/fesm2022/ng-doc-app-components-api-list.mjs.map +1 -1
  43. package/fesm2022/ng-doc-app-components-breadcrumb.mjs +6 -8
  44. package/fesm2022/ng-doc-app-components-breadcrumb.mjs.map +1 -1
  45. package/fesm2022/ng-doc-app-components-code.mjs +9 -14
  46. package/fesm2022/ng-doc-app-components-code.mjs.map +1 -1
  47. package/fesm2022/ng-doc-app-components-copy-button.mjs +5 -5
  48. package/fesm2022/ng-doc-app-components-copy-button.mjs.map +1 -1
  49. package/fesm2022/ng-doc-app-components-demo-displayer.mjs +6 -7
  50. package/fesm2022/ng-doc-app-components-demo-displayer.mjs.map +1 -1
  51. package/fesm2022/ng-doc-app-components-demo-pane.mjs +10 -12
  52. package/fesm2022/ng-doc-app-components-demo-pane.mjs.map +1 -1
  53. package/fesm2022/ng-doc-app-components-demo.mjs +10 -12
  54. package/fesm2022/ng-doc-app-components-demo.mjs.map +1 -1
  55. package/fesm2022/ng-doc-app-components-fullscreen-button.mjs +4 -4
  56. package/fesm2022/ng-doc-app-components-fullscreen-button.mjs.map +1 -1
  57. package/fesm2022/ng-doc-app-components-heading-anchor.mjs +6 -6
  58. package/fesm2022/ng-doc-app-components-heading-anchor.mjs.map +1 -1
  59. package/fesm2022/ng-doc-app-components-image-viewer.mjs +5 -6
  60. package/fesm2022/ng-doc-app-components-image-viewer.mjs.map +1 -1
  61. package/fesm2022/ng-doc-app-components-kind-icon.mjs +4 -4
  62. package/fesm2022/ng-doc-app-components-kind-icon.mjs.map +1 -1
  63. package/fesm2022/ng-doc-app-components-link.mjs +4 -4
  64. package/fesm2022/ng-doc-app-components-link.mjs.map +1 -1
  65. package/fesm2022/ng-doc-app-components-mermaid-viewer.mjs +4 -4
  66. package/fesm2022/ng-doc-app-components-mermaid-viewer.mjs.map +1 -1
  67. package/fesm2022/ng-doc-app-components-navbar.mjs +17 -37
  68. package/fesm2022/ng-doc-app-components-navbar.mjs.map +1 -1
  69. package/fesm2022/ng-doc-app-components-page-header.mjs +5 -6
  70. package/fesm2022/ng-doc-app-components-page-header.mjs.map +1 -1
  71. package/fesm2022/ng-doc-app-components-page-link.mjs +6 -6
  72. package/fesm2022/ng-doc-app-components-page-link.mjs.map +1 -1
  73. package/fesm2022/ng-doc-app-components-page-navigation.mjs +5 -8
  74. package/fesm2022/ng-doc-app-components-page-navigation.mjs.map +1 -1
  75. package/fesm2022/ng-doc-app-components-page-wrapper.mjs +4 -6
  76. package/fesm2022/ng-doc-app-components-page-wrapper.mjs.map +1 -1
  77. package/fesm2022/ng-doc-app-components-page.mjs +9 -24
  78. package/fesm2022/ng-doc-app-components-page.mjs.map +1 -1
  79. package/fesm2022/ng-doc-app-components-playground.mjs +38 -50
  80. package/fesm2022/ng-doc-app-components-playground.mjs.map +1 -1
  81. package/fesm2022/ng-doc-app-components-root.mjs +15 -20
  82. package/fesm2022/ng-doc-app-components-root.mjs.map +1 -1
  83. package/fesm2022/ng-doc-app-components-search-dialog.mjs +7 -10
  84. package/fesm2022/ng-doc-app-components-search-dialog.mjs.map +1 -1
  85. package/fesm2022/ng-doc-app-components-search-result.mjs +6 -8
  86. package/fesm2022/ng-doc-app-components-search-result.mjs.map +1 -1
  87. package/fesm2022/ng-doc-app-components-search.mjs +9 -32
  88. package/fesm2022/ng-doc-app-components-search.mjs.map +1 -1
  89. package/fesm2022/ng-doc-app-components-sidebar.mjs +15 -25
  90. package/fesm2022/ng-doc-app-components-sidebar.mjs.map +1 -1
  91. package/fesm2022/ng-doc-app-components-tabs.mjs +6 -17
  92. package/fesm2022/ng-doc-app-components-tabs.mjs.map +1 -1
  93. package/fesm2022/ng-doc-app-components-theme-toggle.mjs +4 -6
  94. package/fesm2022/ng-doc-app-components-theme-toggle.mjs.map +1 -1
  95. package/fesm2022/ng-doc-app-components-toc.mjs +13 -18
  96. package/fesm2022/ng-doc-app-components-toc.mjs.map +1 -1
  97. package/fesm2022/ng-doc-app-components.mjs.map +1 -1
  98. package/fesm2022/ng-doc-app-constants.mjs.map +1 -1
  99. package/fesm2022/ng-doc-app-defaults-default-processors.mjs.map +1 -1
  100. package/fesm2022/ng-doc-app-defaults-default-skeleton.mjs +1 -1
  101. package/fesm2022/ng-doc-app-defaults-default-skeleton.mjs.map +1 -1
  102. package/fesm2022/ng-doc-app-defaults.mjs.map +1 -1
  103. package/fesm2022/ng-doc-app-directives-code-highlighter.mjs +3 -3
  104. package/fesm2022/ng-doc-app-directives-code-highlighter.mjs.map +1 -1
  105. package/fesm2022/ng-doc-app-directives-route-active.mjs +17 -25
  106. package/fesm2022/ng-doc-app-directives-route-active.mjs.map +1 -1
  107. package/fesm2022/ng-doc-app-directives.mjs.map +1 -1
  108. package/fesm2022/ng-doc-app-helpers.mjs.map +1 -1
  109. package/fesm2022/ng-doc-app-interfaces.mjs.map +1 -1
  110. package/fesm2022/ng-doc-app-pipes-decode-uri-component.mjs +3 -3
  111. package/fesm2022/ng-doc-app-pipes-decode-uri-component.mjs.map +1 -1
  112. package/fesm2022/ng-doc-app-pipes-extract-value.mjs +3 -3
  113. package/fesm2022/ng-doc-app-pipes-extract-value.mjs.map +1 -1
  114. package/fesm2022/ng-doc-app-pipes-filter-by-text.mjs +3 -3
  115. package/fesm2022/ng-doc-app-pipes-filter-by-text.mjs.map +1 -1
  116. package/fesm2022/ng-doc-app-pipes-sanitize-html.mjs +8 -8
  117. package/fesm2022/ng-doc-app-pipes-sanitize-html.mjs.map +1 -1
  118. package/fesm2022/ng-doc-app-pipes.mjs.map +1 -1
  119. package/fesm2022/ng-doc-app-processors-page-processor.mjs +4 -4
  120. package/fesm2022/ng-doc-app-processors-page-processor.mjs.map +1 -1
  121. package/fesm2022/ng-doc-app-processors-processors-link.mjs.map +1 -1
  122. package/fesm2022/ng-doc-app-processors-processors-tooltip.mjs +7 -7
  123. package/fesm2022/ng-doc-app-processors-processors-tooltip.mjs.map +1 -1
  124. package/fesm2022/ng-doc-app-processors-processors.mjs.map +1 -1
  125. package/fesm2022/ng-doc-app-processors.mjs.map +1 -1
  126. package/fesm2022/ng-doc-app-providers-mermaid.mjs.map +1 -1
  127. package/fesm2022/ng-doc-app-providers-ng-doc-app.mjs.map +1 -1
  128. package/fesm2022/ng-doc-app-providers-page-skeleton.mjs.map +1 -1
  129. package/fesm2022/ng-doc-app-providers-playground-demo.mjs.map +1 -1
  130. package/fesm2022/ng-doc-app-providers-search-engine.mjs.map +1 -1
  131. package/fesm2022/ng-doc-app-providers-type-control.mjs.map +1 -1
  132. package/fesm2022/ng-doc-app-providers.mjs.map +1 -1
  133. package/fesm2022/ng-doc-app-services-highlighter.mjs +3 -3
  134. package/fesm2022/ng-doc-app-services-highlighter.mjs.map +1 -1
  135. package/fesm2022/ng-doc-app-services-sidebar.mjs +6 -13
  136. package/fesm2022/ng-doc-app-services-sidebar.mjs.map +1 -1
  137. package/fesm2022/ng-doc-app-services-store.mjs +3 -3
  138. package/fesm2022/ng-doc-app-services-store.mjs.map +1 -1
  139. package/fesm2022/ng-doc-app-services-theme.mjs +6 -12
  140. package/fesm2022/ng-doc-app-services-theme.mjs.map +1 -1
  141. package/fesm2022/ng-doc-app-services.mjs.map +1 -1
  142. package/fesm2022/ng-doc-app-tokens.mjs.map +1 -1
  143. package/fesm2022/ng-doc-app-type-controls-boolean-control.mjs +4 -4
  144. package/fesm2022/ng-doc-app-type-controls-boolean-control.mjs.map +1 -1
  145. package/fesm2022/ng-doc-app-type-controls-number-control.mjs +5 -7
  146. package/fesm2022/ng-doc-app-type-controls-number-control.mjs.map +1 -1
  147. package/fesm2022/ng-doc-app-type-controls-string-control.mjs +5 -7
  148. package/fesm2022/ng-doc-app-type-controls-string-control.mjs.map +1 -1
  149. package/fesm2022/ng-doc-app-type-controls-type-alias-control.mjs +6 -8
  150. package/fesm2022/ng-doc-app-type-controls-type-alias-control.mjs.map +1 -1
  151. package/fesm2022/ng-doc-app-type-controls.mjs.map +1 -1
  152. package/fesm2022/ng-doc-app-types.mjs.map +1 -1
  153. package/fesm2022/ng-doc-app.mjs.map +1 -1
  154. package/helpers/index.d.ts +49 -7
  155. package/interfaces/index.d.ts +221 -13
  156. package/package.json +27 -27
  157. package/pipes/decode-uri-component/index.d.ts +10 -1
  158. package/pipes/extract-value/index.d.ts +11 -1
  159. package/pipes/filter-by-text/index.d.ts +10 -1
  160. package/pipes/sanitize-html/index.d.ts +14 -1
  161. package/processors/page-processor/index.d.ts +26 -1
  162. package/processors/processors/index.d.ts +32 -10
  163. package/processors/processors/link/index.d.ts +6 -1
  164. package/processors/processors/tooltip/index.d.ts +17 -1
  165. package/providers/mermaid/index.d.ts +10 -1
  166. package/providers/ng-doc-app/index.d.ts +25 -1
  167. package/providers/page-skeleton/index.d.ts +13 -1
  168. package/providers/playground-demo/index.d.ts +20 -1
  169. package/providers/search-engine/index.d.ts +15 -1
  170. package/providers/type-control/index.d.ts +18 -1
  171. package/services/highlighter/index.d.ts +29 -1
  172. package/services/sidebar/index.d.ts +37 -1
  173. package/services/store/index.d.ts +13 -1
  174. package/services/theme/index.d.ts +27 -1
  175. package/styles/themes/dark.css +22 -22
  176. package/tokens/index.d.ts +63 -8
  177. package/type-controls/boolean-control/index.d.ts +16 -1
  178. package/type-controls/number-control/index.d.ts +13 -1
  179. package/type-controls/string-control/index.d.ts +14 -1
  180. package/type-controls/type-alias-control/index.d.ts +16 -1
  181. package/types/index.d.ts +7 -1
  182. package/classes/default-search-engine/default-search-engine.d.ts +0 -40
  183. package/classes/root-page/root-page.d.ts +0 -32
  184. package/classes/search-engine/search-engine.d.ts +0 -8
  185. package/components/api-list/api-list.component.d.ts +0 -28
  186. package/components/breadcrumb/breadcrumb.component.d.ts +0 -7
  187. package/components/code/code.component.d.ts +0 -14
  188. package/components/copy-button/copy-button.component.d.ts +0 -12
  189. package/components/demo/demo.component.d.ts +0 -20
  190. package/components/demo-displayer/demo-displayer.component.d.ts +0 -13
  191. package/components/demo-pane/demo-pane.component.d.ts +0 -19
  192. package/components/fullscreen-button/fullscreen-button.component.d.ts +0 -6
  193. package/components/heading-anchor/heading-anchor.component.d.ts +0 -9
  194. package/components/image-viewer/image-viewer.component.d.ts +0 -16
  195. package/components/kind-icon/kind-icon.component.d.ts +0 -8
  196. package/components/link/link.component.d.ts +0 -6
  197. package/components/mermaid-viewer/mermaid-viewer.component.d.ts +0 -17
  198. package/components/navbar/navbar.component.d.ts +0 -31
  199. package/components/page/page.component.d.ts +0 -16
  200. package/components/page-header/page-header.component.d.ts +0 -6
  201. package/components/page-link/page-link.component.d.ts +0 -19
  202. package/components/page-navigation/page-navigation.component.d.ts +0 -8
  203. package/components/page-wrapper/page-wrapper.component.d.ts +0 -22
  204. package/components/playground/base-playground.d.ts +0 -28
  205. package/components/playground/playground-demo/playground-demo.component.d.ts +0 -33
  206. package/components/playground/playground-form.d.ts +0 -5
  207. package/components/playground/playground-properties/playground-properties.component.d.ts +0 -35
  208. package/components/playground/playground-property/playground-property.component.d.ts +0 -20
  209. package/components/playground/playground-property-control.d.ts +0 -7
  210. package/components/playground/playground.component.d.ts +0 -30
  211. package/components/root/root.component.d.ts +0 -57
  212. package/components/search/search.component.d.ts +0 -15
  213. package/components/search-dialog/search-dialog.component.d.ts +0 -24
  214. package/components/search-result/search-result.component.d.ts +0 -11
  215. package/components/sidebar/sidebar-category/sidebar-category.component.d.ts +0 -20
  216. package/components/sidebar/sidebar-item/sidebar-item.component.d.ts +0 -12
  217. package/components/sidebar/sidebar.component.d.ts +0 -11
  218. package/components/tabs/tabs.component.d.ts +0 -9
  219. package/components/theme-toggle/theme-toggle.component.d.ts +0 -17
  220. package/components/toc/toc-element/toc-element.component.d.ts +0 -11
  221. package/components/toc/toc.component.d.ts +0 -25
  222. package/constants/store-keys.d.ts +0 -1
  223. package/defaults/default-processors/default-processors.d.ts +0 -2
  224. package/defaults/default-skeleton/default-skeleton.d.ts +0 -2
  225. package/directives/code-highlighter/code-highlighter.directive.d.ts +0 -14
  226. package/directives/route-active/route-active.directive.d.ts +0 -14
  227. package/helpers/as-boolean.d.ts +0 -5
  228. package/helpers/create-component.d.ts +0 -8
  229. package/helpers/format-html.d.ts +0 -5
  230. package/helpers/generate-toc.d.ts +0 -7
  231. package/helpers/is-dark-os-theme.d.ts +0 -4
  232. package/helpers/is-external-link.d.ts +0 -5
  233. package/helpers/is-playground-property.d.ts +0 -6
  234. package/interfaces/context.d.ts +0 -10
  235. package/interfaces/demo-assets.d.ts +0 -9
  236. package/interfaces/navigation.d.ts +0 -19
  237. package/interfaces/page-processor.d.ts +0 -27
  238. package/interfaces/page-skeleton.d.ts +0 -53
  239. package/interfaces/processor-options.d.ts +0 -7
  240. package/interfaces/provided-type-control.d.ts +0 -7
  241. package/interfaces/search-result.d.ts +0 -15
  242. package/interfaces/tab.d.ts +0 -6
  243. package/interfaces/theme.d.ts +0 -13
  244. package/interfaces/toc-item.d.ts +0 -7
  245. package/interfaces/type-control-provider-options.d.ts +0 -15
  246. package/interfaces/type-control.d.ts +0 -26
  247. package/pipes/decode-uri-component/decode-uri-component.pipe.d.ts +0 -7
  248. package/pipes/extract-value/extract-value.pipe.d.ts +0 -8
  249. package/pipes/filter-by-text/filter-by-text.pipe.d.ts +0 -7
  250. package/pipes/sanitize-html/sanitize-html.pipe.d.ts +0 -10
  251. package/processors/page-processor/page-processor.component.d.ts +0 -23
  252. package/processors/processors/blockquote.processor.d.ts +0 -3
  253. package/processors/processors/code.processor.d.ts +0 -3
  254. package/processors/processors/demo-pane.processor.d.ts +0 -3
  255. package/processors/processors/demo.processor.d.ts +0 -3
  256. package/processors/processors/heading-anchor.processor.d.ts +0 -3
  257. package/processors/processors/icon.processor.d.ts +0 -3
  258. package/processors/processors/image.processor.d.ts +0 -3
  259. package/processors/processors/link/link.processor.d.ts +0 -3
  260. package/processors/processors/mermaid.processor.d.ts +0 -3
  261. package/processors/processors/playground.processor.d.ts +0 -3
  262. package/processors/processors/tabs.processor.d.ts +0 -3
  263. package/processors/processors/tooltip/tooltip.processor.d.ts +0 -15
  264. package/providers/mermaid/provide-mermaid.d.ts +0 -7
  265. package/providers/ng-doc-app/provide-ng-doc-app.d.ts +0 -21
  266. package/providers/page-skeleton/provide-page-skeleton.d.ts +0 -9
  267. package/providers/playground-demo/provide-playground-demo.d.ts +0 -17
  268. package/providers/search-engine/provide-search-engine.d.ts +0 -12
  269. package/providers/type-control/provide-type-control.d.ts +0 -15
  270. package/services/highlighter/highlighter.service.d.ts +0 -24
  271. package/services/sidebar/sidebar.service.d.ts +0 -34
  272. package/services/store/store.service.d.ts +0 -10
  273. package/services/theme/theme.service.d.ts +0 -24
  274. package/tokens/context.d.ts +0 -3
  275. package/tokens/mermaid.d.ts +0 -3
  276. package/tokens/page-processor.d.ts +0 -15
  277. package/tokens/page-skeleton.d.ts +0 -3
  278. package/tokens/route-prefix.d.ts +0 -2
  279. package/tokens/shiki-theme.d.ts +0 -6
  280. package/tokens/theme.d.ts +0 -28
  281. package/tokens/type-control.d.ts +0 -3
  282. package/type-controls/boolean-control/boolean-control.component.d.ts +0 -13
  283. package/type-controls/number-control/number-control.component.d.ts +0 -10
  284. package/type-controls/string-control/string-control.component.d.ts +0 -11
  285. package/type-controls/type-alias-control/type-alias-control.component.d.ts +0 -13
  286. package/types/typed-form.d.ts +0 -4
@@ -1,12 +1,34 @@
1
- export * from './blockquote.processor';
2
- export * from './code.processor';
3
- export * from './demo.processor';
4
- export * from './demo-pane.processor';
5
- export * from './heading-anchor.processor';
6
- export * from './icon.processor';
7
- export * from './image.processor';
8
- export * from './mermaid.processor';
9
- export * from './playground.processor';
10
- export * from './tabs.processor';
1
+ import { NgDocPageProcessor } from '@ng-doc/app/interfaces';
2
+ import { NgDocBlockquoteComponent, NgDocIconComponent } from '@ng-doc/ui-kit';
3
+ import { NgDocCodeComponent } from '@ng-doc/app/components/code';
4
+ import { NgDocDemoComponent } from '@ng-doc/app/components/demo';
5
+ import { NgDocDemoPaneComponent } from '@ng-doc/app/components/demo-pane';
6
+ import { NgDocHeadingAnchorComponent } from '@ng-doc/app/components/heading-anchor';
7
+ import { NgDocImageViewerComponent } from '@ng-doc/app/components/image-viewer';
8
+ import { NgDocMermaidViewerComponent } from '@ng-doc/app/components/mermaid-viewer';
9
+ import { NgDocPlaygroundComponent } from '@ng-doc/app/components/playground';
10
+ import { NgDocTabsComponent } from '@ng-doc/app/components/tabs';
11
11
  export * from '@ng-doc/app/processors/processors/link';
12
12
  export * from '@ng-doc/app/processors/processors/tooltip';
13
+
14
+ declare const blockquoteProcessor: NgDocPageProcessor<NgDocBlockquoteComponent>;
15
+
16
+ declare const codeProcessor: NgDocPageProcessor<NgDocCodeComponent>;
17
+
18
+ declare const demoProcessor: NgDocPageProcessor<NgDocDemoComponent>;
19
+
20
+ declare const demoPaneProcessor: NgDocPageProcessor<NgDocDemoPaneComponent>;
21
+
22
+ declare const headingAnchorProcessor: NgDocPageProcessor<NgDocHeadingAnchorComponent>;
23
+
24
+ declare const iconProcessor: NgDocPageProcessor<NgDocIconComponent>;
25
+
26
+ declare const imageProcessor: NgDocPageProcessor<NgDocImageViewerComponent>;
27
+
28
+ declare const mermaidProcessor: NgDocPageProcessor<NgDocMermaidViewerComponent>;
29
+
30
+ declare const playgroundProcessor: NgDocPageProcessor<NgDocPlaygroundComponent>;
31
+
32
+ declare const tabsProcessor: NgDocPageProcessor<NgDocTabsComponent>;
33
+
34
+ export { blockquoteProcessor, codeProcessor, demoPaneProcessor, demoProcessor, headingAnchorProcessor, iconProcessor, imageProcessor, mermaidProcessor, playgroundProcessor, tabsProcessor };
@@ -1 +1,6 @@
1
- export * from './link.processor';
1
+ import { NgDocPageLinkComponent } from '@ng-doc/app/components/page-link';
2
+ import { NgDocPageProcessor } from '@ng-doc/app/interfaces';
3
+
4
+ declare const linkProcessor: NgDocPageProcessor<NgDocPageLinkComponent>;
5
+
6
+ export { linkProcessor };
@@ -1 +1,17 @@
1
- export * from './tooltip.processor';
1
+ import * as i0 from '@angular/core';
2
+ import { AfterViewInit } from '@angular/core';
3
+ import { NgDocPageProcessor } from '@ng-doc/app/interfaces';
4
+
5
+ declare class NgDocTooltipWrapperComponent implements AfterViewInit {
6
+ private readonly changeDetectorRef;
7
+ content?: string;
8
+ protected tooltipElement: HTMLElement | null;
9
+ private contentProjection?;
10
+ constructor();
11
+ ngAfterViewInit(): void;
12
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocTooltipWrapperComponent, never>;
13
+ static ɵcmp: i0.ɵɵComponentDeclaration<NgDocTooltipWrapperComponent, "ng-doc-tooltip-wrapper", never, { "content": { "alias": "content"; "required": false; }; }, {}, never, ["*"], true, never>;
14
+ }
15
+ declare const tooltipProcessor: NgDocPageProcessor<NgDocTooltipWrapperComponent>;
16
+
17
+ export { tooltipProcessor };
@@ -1 +1,10 @@
1
- export * from './provide-mermaid';
1
+ import { Provider } from '@angular/core';
2
+ import { MermaidConfig } from 'mermaid';
3
+
4
+ /**
5
+ * Provides Mermaid instance.
6
+ * @param config
7
+ */
8
+ declare function provideMermaid(config?: MermaidConfig): Provider;
9
+
10
+ export { provideMermaid };
@@ -1 +1,25 @@
1
- export * from './provide-ng-doc-app';
1
+ import { EnvironmentProviders, Provider } from '@angular/core';
2
+ import { NgDocHighlighterConfig } from '@ng-doc/app/services/highlighter';
3
+ import { NgDocUiConfig } from '@ng-doc/ui-kit';
4
+
5
+ /**
6
+ * NgDoc application config.
7
+ */
8
+ interface NgDocApplicationConfig {
9
+ /**
10
+ * UI Kit configuration.
11
+ */
12
+ uiKit?: NgDocUiConfig;
13
+ /**
14
+ * Shiki theme.
15
+ */
16
+ shiki?: NgDocHighlighterConfig;
17
+ }
18
+ /**
19
+ * Provides the NgDoc application configuration.
20
+ * @param config - The optional application configuration.
21
+ */
22
+ declare function provideNgDocApp(config?: NgDocApplicationConfig): Array<EnvironmentProviders | Provider>;
23
+
24
+ export { provideNgDocApp };
25
+ export type { NgDocApplicationConfig };
@@ -1 +1,13 @@
1
- export * from './provide-page-skeleton';
1
+ import * as _angular_core from '@angular/core';
2
+ import { NgDocPageSkeleton } from '@ng-doc/app/interfaces';
3
+
4
+ /**
5
+ * Provides the skeleton components for the page.
6
+ * @param skeleton - The skeleton for the page.
7
+ */
8
+ declare function providePageSkeleton(skeleton: NgDocPageSkeleton): {
9
+ provide: _angular_core.InjectionToken<NgDocPageSkeleton>;
10
+ useValue: NgDocPageSkeleton;
11
+ }[];
12
+
13
+ export { providePageSkeleton };
@@ -1 +1,20 @@
1
- export * from './provide-playground-demo';
1
+ import { Provider, InjectionToken } from '@angular/core';
2
+ import { Constructor } from '@ng-doc/core/types';
3
+
4
+ /**
5
+ *
6
+ * @param type
7
+ * @param control
8
+ * @param options
9
+ * @param playgroundId
10
+ * @param selector
11
+ * @param component
12
+ */
13
+ declare function providePlaygroundDemo(playgroundId: string, component: Constructor<unknown>): Provider;
14
+ /**
15
+ * Returns the token for the given playground id.
16
+ * @param playgroundId
17
+ */
18
+ declare function getPlaygroundDemoToken<T>(playgroundId: string): InjectionToken<T[]> | undefined;
19
+
20
+ export { getPlaygroundDemoToken, providePlaygroundDemo };
@@ -1 +1,15 @@
1
- export * from './provide-search-engine';
1
+ import { Provider } from '@angular/core';
2
+ import { NgDocSearchEngine } from '@ng-doc/app/classes/search-engine';
3
+ import { Constructor } from '@ng-doc/core/types';
4
+
5
+ /**
6
+ * Provides the `NgDocSearchEngine` to enable search in the documentation.
7
+ *
8
+ * You can create and provide your own `NgDocSearchEngine` if you want to handle the search yourself.
9
+ * @param engine - The search engine class.
10
+ * @param args - The arguments for the search engine class.
11
+ * @returns The provider for the search engine.
12
+ */
13
+ declare function provideSearchEngine<E extends Constructor<NgDocSearchEngine>>(engine: E, ...args: ConstructorParameters<E>): Provider;
14
+
15
+ export { provideSearchEngine };
@@ -1 +1,18 @@
1
- export * from './provide-type-control';
1
+ import { Provider, InjectionToken } from '@angular/core';
2
+ import { NgDocTypeControl, NgDocTypeControlProviderOptions, NgDocProvidedTypeControl } from '@ng-doc/app/interfaces';
3
+ import { Constructor } from '@ng-doc/core/types';
4
+
5
+ /**
6
+ *
7
+ * @param type
8
+ * @param control
9
+ * @param options
10
+ */
11
+ declare function provideTypeControl(type: string, control: Constructor<NgDocTypeControl>, options?: NgDocTypeControlProviderOptions): Provider;
12
+ /**
13
+ * Returns token for type control based on provided type
14
+ * @param type - type for searched control (e.g. `string`)
15
+ */
16
+ declare function getTokenForType(type: string): InjectionToken<NgDocProvidedTypeControl> | undefined;
17
+
18
+ export { getTokenForType, provideTypeControl };
@@ -1 +1,29 @@
1
- export * from './highlighter.service';
1
+ import * as _ng_doc_app_tokens from '@ng-doc/app/tokens';
2
+ import { HighlighterGeneric } from '@shikijs/core/types';
3
+ import { ThemeInput } from 'shiki';
4
+ import * as i0 from '@angular/core';
5
+
6
+ interface NgDocHighlighterConfig {
7
+ /**
8
+ * Themes sources.
9
+ */
10
+ themes?: ThemeInput[];
11
+ /**
12
+ * Theme that will be used for rendering the code blocks.
13
+ */
14
+ theme?: {
15
+ light: string;
16
+ dark: string;
17
+ };
18
+ }
19
+ declare class NgDocHighlighterService {
20
+ highlighter?: HighlighterGeneric<string, string>;
21
+ protected readonly theme: _ng_doc_app_tokens.NgDocShikiTheme;
22
+ initialize(config?: NgDocHighlighterConfig): Promise<void>;
23
+ highlight(code: string): string;
24
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocHighlighterService, never>;
25
+ static ɵprov: i0.ɵɵInjectableDeclaration<NgDocHighlighterService>;
26
+ }
27
+
28
+ export { NgDocHighlighterService };
29
+ export type { NgDocHighlighterConfig };
@@ -1 +1,37 @@
1
- export * from './sidebar.service';
1
+ import { Router } from '@angular/router';
2
+ import { NgDocScrollService } from '@ng-doc/ui-kit/services/scroll';
3
+ import { BehaviorSubject, Observable } from 'rxjs';
4
+ import * as i0 from '@angular/core';
5
+
6
+ /**
7
+ * Service for sidebar, it can be used to hide/show sidebar or to check if sidebar is collapsable.
8
+ */
9
+ declare class NgDocSidebarService {
10
+ protected readonly expanded: BehaviorSubject<boolean>;
11
+ protected readonly document: Document;
12
+ protected readonly window: Window;
13
+ protected readonly router: Router;
14
+ protected readonly scroll: NgDocScrollService;
15
+ constructor();
16
+ get isMobile(): boolean;
17
+ /**
18
+ * Indicates if sidebar is visible, based on the show/hide methods.
19
+ */
20
+ isExpanded(): Observable<boolean>;
21
+ /**
22
+ * Show sidebar, and block scrolling.
23
+ */
24
+ show(): void;
25
+ /**
26
+ * Hide sidebar, and unblock scrolling.
27
+ */
28
+ hide(): void;
29
+ /**
30
+ * Toggle sidebar visibility.
31
+ */
32
+ toggle(): void;
33
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocSidebarService, never>;
34
+ static ɵprov: i0.ɵɵInjectableDeclaration<NgDocSidebarService>;
35
+ }
36
+
37
+ export { NgDocSidebarService };
@@ -1 +1,13 @@
1
- export * from './store.service';
1
+ import * as i0 from '@angular/core';
2
+
3
+ declare class NgDocStoreService {
4
+ protected readonly localStorage: Storage;
5
+ set(key: string, data: string): void;
6
+ set<T>(key: string, data: T, serialize: (v: T) => string): void;
7
+ get(key: string): string | null;
8
+ get<T>(key: string, deserialize: (v: string | null) => T): T;
9
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocStoreService, never>;
10
+ static ɵprov: i0.ɵɵInjectableDeclaration<NgDocStoreService>;
11
+ }
12
+
13
+ export { NgDocStoreService };
@@ -1 +1,27 @@
1
- export * from './theme.service';
1
+ import { NgDocStoreService } from '@ng-doc/app/services/store';
2
+ import { Subject, Observable } from 'rxjs';
3
+ import * as i0 from '@angular/core';
4
+
5
+ /**
6
+ * Service for managing themes.
7
+ */
8
+ declare class NgDocThemeService {
9
+ protected readonly document: Document;
10
+ protected readonly store: NgDocStoreService;
11
+ protected readonly change$: Subject<string | null>;
12
+ protected readonly documentElement: HTMLElement;
13
+ /**
14
+ * Returns the current theme.
15
+ */
16
+ get currentTheme(): string | null;
17
+ themeChanges(): Observable<string | null>;
18
+ /**
19
+ * Sets the theme by id.
20
+ * @param id - Theme id. If not provided, the theme will be removed.
21
+ */
22
+ set(id?: string): void;
23
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocThemeService, never>;
24
+ static ɵprov: i0.ɵɵInjectableDeclaration<NgDocThemeService>;
25
+ }
26
+
27
+ export { NgDocThemeService };
@@ -1,17 +1,17 @@
1
1
  @media (prefers-color-scheme: dark) {
2
2
  :root[data-theme=auto] {
3
3
  --ng-doc-base-rgb: 43 43 43;
4
- --ng-doc-base-0: rgb(30.25, 30.25, 30.25);
5
- --ng-doc-base-1: rgb(38.25, 38.25, 38.25);
6
- --ng-doc-base-2: rgb(45.25, 45.25, 45.25);
7
- --ng-doc-base-3: rgb(53.25, 53.25, 53.25);
8
- --ng-doc-base-4: rgb(62.25, 62.25, 62.25);
9
- --ng-doc-base-5: rgb(72.25, 72.25, 72.25);
10
- --ng-doc-base-6: rgb(81.25, 81.25, 81.25);
11
- --ng-doc-base-7: rgb(91.25, 91.25, 91.25);
12
- --ng-doc-base-8: rgb(101.25, 101.25, 101.25);
13
- --ng-doc-base-9: rgb(112.25, 112.25, 112.25);
14
- --ng-doc-base-10: rgb(123.25, 123.25, 123.25);
4
+ --ng-doc-base-0: rgb(40.85, 40.85, 40.85);
5
+ --ng-doc-base-1: rgb(48.45, 48.45, 48.45);
6
+ --ng-doc-base-2: rgb(55.1, 55.1, 55.1);
7
+ --ng-doc-base-3: rgb(62.7, 62.7, 62.7);
8
+ --ng-doc-base-4: rgb(71.25, 71.25, 71.25);
9
+ --ng-doc-base-5: rgb(80.75, 80.75, 80.75);
10
+ --ng-doc-base-6: rgb(89.3, 89.3, 89.3);
11
+ --ng-doc-base-7: rgb(98.8, 98.8, 98.8);
12
+ --ng-doc-base-8: rgb(108.3, 108.3, 108.3);
13
+ --ng-doc-base-9: rgb(118.75, 118.75, 118.75);
14
+ --ng-doc-base-10: rgb(129.2, 129.2, 129.2);
15
15
  --ng-doc-heading-color: #e3e3e3;
16
16
  --ng-doc-text: #a9a9a9;
17
17
  --ng-doc-text-muted: var(--ng-doc-base-10);
@@ -37,17 +37,17 @@
37
37
 
38
38
  :root[data-theme=dark] {
39
39
  --ng-doc-base-rgb: 43 43 43;
40
- --ng-doc-base-0: rgb(30.25, 30.25, 30.25);
41
- --ng-doc-base-1: rgb(38.25, 38.25, 38.25);
42
- --ng-doc-base-2: rgb(45.25, 45.25, 45.25);
43
- --ng-doc-base-3: rgb(53.25, 53.25, 53.25);
44
- --ng-doc-base-4: rgb(62.25, 62.25, 62.25);
45
- --ng-doc-base-5: rgb(72.25, 72.25, 72.25);
46
- --ng-doc-base-6: rgb(81.25, 81.25, 81.25);
47
- --ng-doc-base-7: rgb(91.25, 91.25, 91.25);
48
- --ng-doc-base-8: rgb(101.25, 101.25, 101.25);
49
- --ng-doc-base-9: rgb(112.25, 112.25, 112.25);
50
- --ng-doc-base-10: rgb(123.25, 123.25, 123.25);
40
+ --ng-doc-base-0: rgb(40.85, 40.85, 40.85);
41
+ --ng-doc-base-1: rgb(48.45, 48.45, 48.45);
42
+ --ng-doc-base-2: rgb(55.1, 55.1, 55.1);
43
+ --ng-doc-base-3: rgb(62.7, 62.7, 62.7);
44
+ --ng-doc-base-4: rgb(71.25, 71.25, 71.25);
45
+ --ng-doc-base-5: rgb(80.75, 80.75, 80.75);
46
+ --ng-doc-base-6: rgb(89.3, 89.3, 89.3);
47
+ --ng-doc-base-7: rgb(98.8, 98.8, 98.8);
48
+ --ng-doc-base-8: rgb(108.3, 108.3, 108.3);
49
+ --ng-doc-base-9: rgb(118.75, 118.75, 118.75);
50
+ --ng-doc-base-10: rgb(129.2, 129.2, 129.2);
51
51
  --ng-doc-heading-color: #e3e3e3;
52
52
  --ng-doc-text: #a9a9a9;
53
53
  --ng-doc-text-muted: var(--ng-doc-base-10);
package/tokens/index.d.ts CHANGED
@@ -1,8 +1,63 @@
1
- export * from './context';
2
- export * from './mermaid';
3
- export * from './page-processor';
4
- export * from './page-skeleton';
5
- export * from './route-prefix';
6
- export * from './shiki-theme';
7
- export * from './theme';
8
- export * from './type-control';
1
+ import { InjectionToken, Provider } from '@angular/core';
2
+ import { NgDocContext, NgDocPageProcessor, NgDocPageSkeleton, NgDocTheme, NgDocTypeControl } from '@ng-doc/app/interfaces';
3
+ import { Mermaid } from 'mermaid';
4
+
5
+ declare const NG_DOC_CONTEXT: InjectionToken<NgDocContext>;
6
+
7
+ declare const NG_DOC_MERMAID: InjectionToken<Mermaid>;
8
+
9
+ declare const NG_DOC_PAGE_PROCESSOR: InjectionToken<NgDocPageProcessor<unknown>>;
10
+ declare const NG_DOC_PAGE_CUSTOM_PROCESSOR: InjectionToken<NgDocPageProcessor<unknown>>;
11
+ /**
12
+ * Provide a main processor to replace html nodes with an Angular component.
13
+ * Main processors are run before custom processors.
14
+ * @param processors - The processor to provide.
15
+ */
16
+ declare function provideMainPageProcessor(processors: NgDocPageProcessor<unknown> | Array<NgDocPageProcessor<unknown>>): Provider[];
17
+ /**
18
+ * Provide a processor to replace html nodes with an Angular component.
19
+ * @param processors - The processor to provide.
20
+ */
21
+ declare function providePageProcessor<T>(processors: NgDocPageProcessor<T> | Array<NgDocPageProcessor<T>>): Provider[];
22
+
23
+ declare const NG_DOC_PAGE_SKELETON: InjectionToken<NgDocPageSkeleton>;
24
+
25
+ declare const NG_DOC_ROUTE_PREFIX: InjectionToken<string>;
26
+
27
+ interface NgDocShikiTheme {
28
+ light: string;
29
+ dark: string;
30
+ }
31
+ declare const NG_DOC_SHIKI_THEME: InjectionToken<NgDocShikiTheme>;
32
+
33
+ /**
34
+ * Token that can be used to provide custom theme.
35
+ * You must compile your theme to CSS and add it to `assets` so that NgDoc can load it dynamically.
36
+ *
37
+ * You always should provide custom themes in root of your application with `multi: true` parameter.
38
+ *
39
+ * For example
40
+ * ```typescript
41
+ * @NgModule({
42
+ * declarations: [AppComponent],
43
+ * imports: [],
44
+ * providers: [
45
+ * {provide: NG_DOC_THEME, useValue: {id: 'CustomTheme', path: '/assets/themes/custom.css'}, multi: true}
46
+ * ],
47
+ * bootstrap: [AppComponent],
48
+ * })
49
+ * export class AppModule {}
50
+ * ```
51
+ */
52
+ declare const NG_DOC_THEME: InjectionToken<NgDocTheme>;
53
+ /**
54
+ * Default theme for application if user didn't change it manually.
55
+ *
56
+ * You can provide this token in the root of you application, to set theme by default.
57
+ */
58
+ declare const NG_DOC_DEFAULT_THEME_ID: InjectionToken<string>;
59
+
60
+ declare const NG_DOC_TYPE_CONTROL: InjectionToken<NgDocTypeControl>;
61
+
62
+ export { NG_DOC_CONTEXT, NG_DOC_DEFAULT_THEME_ID, NG_DOC_MERMAID, NG_DOC_PAGE_CUSTOM_PROCESSOR, NG_DOC_PAGE_PROCESSOR, NG_DOC_PAGE_SKELETON, NG_DOC_ROUTE_PREFIX, NG_DOC_SHIKI_THEME, NG_DOC_THEME, NG_DOC_TYPE_CONTROL, provideMainPageProcessor, providePageProcessor };
63
+ export type { NgDocShikiTheme };
@@ -1 +1,16 @@
1
- export * from './boolean-control.component';
1
+ import { NgDocTypeControl } from '@ng-doc/app/interfaces';
2
+ import { DIControl } from 'di-controls';
3
+ import * as i0 from '@angular/core';
4
+
5
+ declare class NgDocBooleanControlComponent extends DIControl<boolean | undefined> implements NgDocTypeControl<boolean | undefined> {
6
+ default?: boolean;
7
+ name: string;
8
+ description: string;
9
+ constructor();
10
+ get defaultValue(): boolean | undefined;
11
+ updateModel(obj: boolean | null | undefined): void;
12
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocBooleanControlComponent, never>;
13
+ static ɵcmp: i0.ɵɵComponentDeclaration<NgDocBooleanControlComponent, "ng-doc-boolean-control", never, {}, {}, never, never, true, never>;
14
+ }
15
+
16
+ export { NgDocBooleanControlComponent };
@@ -1 +1,13 @@
1
- export * from './number-control.component';
1
+ import { NgDocTypeControl } from '@ng-doc/app/interfaces';
2
+ import { DIControl } from 'di-controls';
3
+ import * as i0 from '@angular/core';
4
+
5
+ declare class NgDocNumberControlComponent extends DIControl<number> implements NgDocTypeControl<number> {
6
+ default?: number;
7
+ constructor();
8
+ changeModel(value: number | null): void;
9
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocNumberControlComponent, never>;
10
+ static ɵcmp: i0.ɵɵComponentDeclaration<NgDocNumberControlComponent, "ng-doc-number-control", never, { "default": { "alias": "default"; "required": false; }; }, {}, never, never, true, never>;
11
+ }
12
+
13
+ export { NgDocNumberControlComponent };
@@ -1 +1,14 @@
1
- export * from './string-control.component';
1
+ import { NgDocTypeControl } from '@ng-doc/app/interfaces';
2
+ import { DIControl } from 'di-controls';
3
+ import * as i0 from '@angular/core';
4
+
5
+ declare class NgDocStringControlComponent extends DIControl<string> implements NgDocTypeControl<string> {
6
+ default?: string;
7
+ constructor();
8
+ changeModel(value: string | null): void;
9
+ writeValue(value: string | null): void;
10
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocStringControlComponent, never>;
11
+ static ɵcmp: i0.ɵɵComponentDeclaration<NgDocStringControlComponent, "ng-doc-string-control", never, { "default": { "alias": "default"; "required": false; }; }, {}, never, never, true, never>;
12
+ }
13
+
14
+ export { NgDocStringControlComponent };
@@ -1 +1,16 @@
1
- export * from './type-alias-control.component';
1
+ import { NgDocTypeControl } from '@ng-doc/app/interfaces';
2
+ import { DIControl } from 'di-controls';
3
+ import * as i0 from '@angular/core';
4
+
5
+ declare class NgDocTypeAliasControlComponent<T> extends DIControl<T> implements NgDocTypeControl<T> {
6
+ default?: T;
7
+ options?: string[];
8
+ isManual?: boolean;
9
+ constructor();
10
+ typeOf(value: unknown): string;
11
+ changeModel(value: T | null): void;
12
+ static ɵfac: i0.ɵɵFactoryDeclaration<NgDocTypeAliasControlComponent<any>, never>;
13
+ static ɵcmp: i0.ɵɵComponentDeclaration<NgDocTypeAliasControlComponent<any>, "ng-doc-type-alias-control", never, { "default": { "alias": "default"; "required": false; }; }, {}, never, never, true, never>;
14
+ }
15
+
16
+ export { NgDocTypeAliasControlComponent };
package/types/index.d.ts CHANGED
@@ -1 +1,7 @@
1
- export * from './typed-form';
1
+ import { AbstractControl, FormArray, FormGroup, FormControl } from '@angular/forms';
2
+
3
+ type NgDocFormPartialValue<T extends AbstractControl> = T extends FormArray<infer FA> ? Array<NgDocFormPartialValue<FA>> : T extends FormGroup<infer FG> ? Partial<{
4
+ [K in keyof FG]: NgDocFormPartialValue<FG[K]>;
5
+ }> : T extends FormControl<infer FC> ? FC : never;
6
+
7
+ export type { NgDocFormPartialValue };
@@ -1,40 +0,0 @@
1
- import { NgDocSearchEngine } from '@ng-doc/app/classes/search-engine';
2
- import { NgDocSearchResult } from '@ng-doc/app/interfaces';
3
- import * as stemmer from '@orama/stemmers';
4
- import { Observable } from 'rxjs';
5
- /**
6
- * Options for the `NgDocDefaultSearchEngine`.
7
- */
8
- export interface NgDocDefaultSearchEngineOptions {
9
- /**
10
- * The language to use for the search engine.
11
- */
12
- stemmer?: typeof stemmer.stemmer;
13
- /**
14
- * Specifies the maximum distance (following the Levenshtein algorithm) between the term and the searchable property.
15
- * (doesn't work with `exact` option)
16
- */
17
- tolerance?: number;
18
- /**
19
- * If `true`, finds all the document with an exact match of the term property.
20
- */
21
- exact?: boolean;
22
- /**
23
- * Number of results to return (default: 10).
24
- */
25
- limit?: number;
26
- }
27
- /**
28
- * Search engine for the documentation, it loads the index and provides a search method.
29
- */
30
- export declare class NgDocDefaultSearchEngine extends NgDocSearchEngine {
31
- private options?;
32
- private db$;
33
- constructor(options?: NgDocDefaultSearchEngineOptions | undefined);
34
- /**
35
- * Search the documentation for the given query.
36
- * @param query The query to search for.
37
- */
38
- search(query: string): Observable<NgDocSearchResult[]>;
39
- private request;
40
- }
@@ -1,32 +0,0 @@
1
- import { NgDocDemoAssets } from '@ng-doc/app/interfaces';
2
- import { NgDocPage } from '@ng-doc/core/interfaces';
3
- import { NgDocPageType } from '@ng-doc/core/types';
4
- /**
5
- * Base class for NgDoc page
6
- */
7
- export declare abstract class NgDocRootPage {
8
- /**
9
- * The type of the page
10
- */
11
- abstract readonly pageType: NgDocPageType;
12
- /**
13
- * Html content of the page
14
- */
15
- abstract readonly pageContent: string;
16
- /**
17
- * Edit URL that can be used to edit the page source file in the repository
18
- */
19
- abstract readonly editSourceFileUrl?: string;
20
- /**
21
- * View URL that can be used to view the page source file in the repository
22
- */
23
- abstract readonly viewSourceFileUrl?: string;
24
- /**
25
- * The page dependencies file
26
- */
27
- readonly page?: NgDocPage;
28
- /**
29
- * The page demo assets that have code examples of the demo components
30
- */
31
- readonly demoAssets?: NgDocDemoAssets;
32
- }
@@ -1,8 +0,0 @@
1
- import { NgDocSearchResult } from '@ng-doc/app/interfaces';
2
- import { Observable } from 'rxjs';
3
- /**
4
- * Abstract search engine class, that can be used to implement a custom search engine.
5
- */
6
- export declare abstract class NgDocSearchEngine {
7
- abstract search(query: string): Observable<NgDocSearchResult[]>;
8
- }
@@ -1,28 +0,0 @@
1
- import { OnInit, Signal, WritableSignal } from '@angular/core';
2
- import { FormControl, FormGroup } from '@angular/forms';
3
- import { NgDocApiList } from '@ng-doc/core/interfaces';
4
- import * as i0 from "@angular/core";
5
- interface ApiFilterForm {
6
- filter: FormControl<string | null>;
7
- scope: FormControl<string | null>;
8
- type: FormControl<string | null>;
9
- }
10
- export declare class NgDocApiListComponent implements OnInit {
11
- title: import("@angular/core").InputSignal<string>;
12
- segment: import("@angular/core").InputSignal<string | undefined>;
13
- apiList: WritableSignal<NgDocApiList[]>;
14
- filteredApiList: Signal<NgDocApiList[]>;
15
- filter: Signal<any>;
16
- scopes: Signal<string[]>;
17
- types: Signal<string[]>;
18
- protected formGroup: FormGroup<ApiFilterForm>;
19
- private readonly formBuilder;
20
- private readonly route;
21
- private readonly router;
22
- private readonly httpClient;
23
- constructor();
24
- ngOnInit(): void;
25
- static ɵfac: i0.ɵɵFactoryDeclaration<NgDocApiListComponent, never>;
26
- static ɵcmp: i0.ɵɵComponentDeclaration<NgDocApiListComponent, "ng-doc-api-list", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; "segment": { "alias": "segment"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
27
- }
28
- export {};
@@ -1,7 +0,0 @@
1
- import { NgDocPageBreadcrumbs } from '@ng-doc/app/interfaces';
2
- import * as i0 from "@angular/core";
3
- export declare class NgDocBreadcrumbComponent implements NgDocPageBreadcrumbs {
4
- breadcrumbs: string[];
5
- static ɵfac: i0.ɵɵFactoryDeclaration<NgDocBreadcrumbComponent, never>;
6
- static ɵcmp: i0.ɵɵComponentDeclaration<NgDocBreadcrumbComponent, "ng-doc-breadcrumb", never, { "breadcrumbs": { "alias": "breadcrumbs"; "required": false; }; }, {}, never, never, true, never>;
7
- }