@ng-doc/builder 22.0.0-beta.2 → 22.0.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.
- package/README.md +19 -28
- package/application/index.js +2 -2
- package/application/index.js.map +1 -1
- package/application/schema.json +1 -2
- package/builders.json +23 -13
- package/classes/observable-map.d.ts +1 -0
- package/classes/observable-map.js +14 -3
- package/classes/observable-map.js.map +1 -1
- package/classes/observable-set.js +2 -1
- package/classes/observable-set.js.map +1 -1
- package/dev-server/index.js +5 -3
- package/dev-server/index.js.map +1 -1
- package/engine/builders/api-list/api-list-component.builder.js +4 -4
- package/engine/builders/api-list/api-list-component.builder.js.map +1 -1
- package/engine/builders/api-list/api-page-template.builder.js +2 -2
- package/engine/builders/api-list/api-page-template.builder.js.map +1 -1
- package/engine/builders/global/keywords.builder.d.ts +1 -4
- package/engine/builders/global/keywords.builder.js +5 -9
- package/engine/builders/global/keywords.builder.js.map +1 -1
- package/engine/builders/global/search-indexes.builder.js +1 -1
- package/engine/builders/global/search-indexes.builder.js.map +1 -1
- package/engine/builders/helpers/create-entry-metadata.js +2 -1
- package/engine/builders/helpers/create-entry-metadata.js.map +1 -1
- package/engine/builders/helpers/create-import-path.js.map +1 -1
- package/engine/builders/helpers/get-entry-relative-path.js.map +1 -1
- package/engine/builders/page/demo-assets.builder.js +8 -5
- package/engine/builders/page/demo-assets.builder.js.map +1 -1
- package/engine/builders/page/playground.builder.js +1 -0
- package/engine/builders/page/playground.builder.js.map +1 -1
- package/engine/builders/shared/content.builder.js +3 -3
- package/engine/builders/shared/content.builder.js.map +1 -1
- package/engine/builders/shared/page-component.builder.js +16 -6
- package/engine/builders/shared/page-component.builder.js.map +1 -1
- package/engine/builders/shared/page-wrapper.builder.js +8 -5
- package/engine/builders/shared/page-wrapper.builder.js.map +1 -1
- package/engine/core/operators/distinct-pending.js.map +1 -1
- package/engine/core/operators/factory.js +1 -4
- package/engine/core/operators/factory.js.map +1 -1
- package/engine/core/operators/merge-factory.js +19 -17
- package/engine/core/operators/merge-factory.js.map +1 -1
- package/engine/core/operators/when-builders-done.js.map +1 -1
- package/engine/core/triggers/on-dependencies-change.d.ts +1 -1
- package/engine/core/triggers/on-dependencies-change.js +2 -2
- package/engine/core/triggers/on-dependencies-change.js.map +1 -1
- package/generator/artifacts/index.d.ts +317 -0
- package/generator/bootstrap/bin.d.ts +18 -0
- package/generator/bootstrap/bin.js +7274 -0
- package/generator/bootstrap/candidate-output-committer.d.ts +12 -0
- package/generator/bootstrap/cli.d.ts +42 -0
- package/generator/bootstrap/cli.js +7123 -0
- package/generator/bootstrap/constants.d.ts +4 -0
- package/generator/bootstrap/index.d.ts +111 -0
- package/generator/bootstrap/index.js +5020 -0
- package/generator/bootstrap/prerender-command.d.ts +31 -0
- package/generator/bootstrap/process-tree.d.ts +49 -0
- package/generator/build-metafile.json +11701 -0
- package/generator/build-provenance.json +119 -0
- package/generator/compiler/assemble.d.ts +41 -0
- package/generator/compiler/classify.d.ts +161 -0
- package/generator/compiler/closure-store.d.ts +55 -0
- package/generator/compiler/common.d.ts +32 -0
- package/generator/compiler/describe.d.ts +21 -0
- package/generator/compiler/dry-run.d.ts +108 -0
- package/generator/compiler/fast-start.d.ts +104 -0
- package/generator/compiler/fold.d.ts +116 -0
- package/generator/compiler/index.d.ts +111 -0
- package/generator/compiler/index.js +17759 -0
- package/generator/compiler/link.d.ts +38 -0
- package/generator/compiler/memo.d.ts +44 -0
- package/generator/compiler/plan.d.ts +92 -0
- package/generator/compiler/progress.d.ts +54 -0
- package/generator/compiler/render.d.ts +27 -0
- package/generator/compiler/retention.d.ts +181 -0
- package/generator/compiler/semantic-closure.d.ts +46 -0
- package/generator/compiler/targeted.d.ts +280 -0
- package/generator/content/content-compiler.d.ts +118 -0
- package/generator/content/highlight-cache.d.ts +139 -0
- package/generator/content/html-pipeline.d.ts +170 -0
- package/generator/content/html-pool.d.ts +239 -0
- package/generator/content/html-worker.js +1598 -0
- package/generator/content-module-ids.d.ts +8 -0
- package/generator/contracts.d.ts +1063 -0
- package/generator/contracts.js +15 -0
- package/generator/discovery/index.d.ts +77 -0
- package/generator/graph/index.d.ts +211 -0
- package/generator/graph/unit-index.d.ts +216 -0
- package/generator/kernel/canonical.d.ts +57 -0
- package/generator/kernel/flags.d.ts +49 -0
- package/generator/kernel/footprint.d.ts +88 -0
- package/generator/kernel/observations.d.ts +68 -0
- package/generator/kernel/paths.d.ts +22 -0
- package/generator/kernel/runtime-identity.d.ts +11 -0
- package/generator/outputs/index.d.ts +67 -0
- package/generator/package.json +3 -0
- package/generator/progress/ci.d.ts +22 -0
- package/generator/progress/detect.d.ts +60 -0
- package/generator/progress/events.d.ts +126 -0
- package/generator/progress/format.d.ts +83 -0
- package/generator/progress/gate.d.ts +49 -0
- package/generator/progress/host.d.ts +29 -0
- package/generator/progress/lines.d.ts +42 -0
- package/generator/progress/live.d.ts +115 -0
- package/generator/progress/model.d.ts +85 -0
- package/generator/progress/reporter.d.ts +87 -0
- package/generator/progress/settings.d.ts +60 -0
- package/generator/semantic/angular.d.ts +9 -0
- package/generator/semantic/api-enumeration.d.ts +19 -0
- package/generator/semantic/api-summary.d.ts +33 -0
- package/generator/semantic/dependencies.d.ts +20 -0
- package/generator/semantic/derived-classes.d.ts +58 -0
- package/generator/semantic/documentation-cache.d.ts +23 -0
- package/generator/semantic/fragments.d.ts +28 -0
- package/generator/semantic/owned-roots.d.ts +59 -0
- package/generator/semantic/program-builder.d.ts +55 -0
- package/generator/semantic/program-index.d.ts +124 -0
- package/generator/semantic/program-inputs.d.ts +26 -0
- package/generator/semantic/program-observations.d.ts +158 -0
- package/generator/semantic/program-retention.d.ts +147 -0
- package/generator/semantic/program-state.d.ts +196 -0
- package/generator/semantic/program-verify.d.ts +22 -0
- package/generator/semantic/recorder.d.ts +89 -0
- package/generator/semantic/rendering.d.ts +34 -0
- package/generator/semantic/semantic-closure.d.ts +129 -0
- package/generator/semantic/semantic-service.d.ts +186 -0
- package/generator/semantic/type-text.d.ts +5 -0
- package/generator/session/build-session.d.ts +206 -0
- package/generator/session/input-verification.d.ts +38 -0
- package/generator/session/parcel-event-source.d.ts +22 -0
- package/generator/session/progress.d.ts +72 -0
- package/generator/session/unchanged-saves.d.ts +63 -0
- package/generator/session/watch-inputs.d.ts +6 -0
- package/generator/session/watch-signals.d.ts +10 -0
- package/generator/templates/api/base.html.nunj +26 -0
- package/generator/templates/api/class-declaration.html.nunj +57 -0
- package/generator/templates/api/details/class-declaration.html.nunj +47 -0
- package/generator/templates/api/details/enum-declaration.html.nunj +0 -0
- package/generator/templates/api/details/function-declaration.html.nunj +14 -0
- package/generator/templates/api/details/helpers/decorators.html.nunj +14 -0
- package/generator/templates/api/details/helpers/extends.html.nunj +6 -0
- package/generator/templates/api/details/helpers/selectors.html.nunj +12 -0
- package/generator/templates/api/details/helpers/type-parameters.html.nunj +14 -0
- package/generator/templates/api/details/interface-declaration.html.nunj +27 -0
- package/generator/templates/api/details/type-alias-declaration.html.nunj +14 -0
- package/generator/templates/api/details/variable-declaration.html.nunj +0 -0
- package/generator/templates/api/details.html.nunj +9 -0
- package/generator/templates/api/enum-declaration.html.nunj +12 -0
- package/generator/templates/api/function-declaration.html.nunj +35 -0
- package/generator/templates/api/interface-declaration.html.nunj +37 -0
- package/generator/templates/api/type-alias-declaration.html.nunj +16 -0
- package/generator/templates/api/variable-declaration.html.nunj +8 -0
- package/generator/templates/api-header.html.nunj +11 -0
- package/generator/templates/api-list.ts.nunj +22 -0
- package/generator/templates/api-page-content.html.nunj +1 -0
- package/generator/templates/api-scope.ts.nunj +22 -0
- package/generator/templates/category.ts.nunj +22 -0
- package/generator/templates/code.html.nunj +3 -0
- package/generator/templates/context.ts.nunj +55 -0
- package/generator/templates/demo-assets.ts.nunj +25 -0
- package/generator/templates/helpers/accessor.html.nunj +76 -0
- package/generator/templates/helpers/accessors.html.nunj +7 -0
- package/generator/templates/helpers/badge.html.nunj +4 -0
- package/generator/templates/helpers/call-signature.html.nunj +70 -0
- package/generator/templates/helpers/code.html.nunj +3 -0
- package/generator/templates/helpers/constructor.html.nunj +32 -0
- package/generator/templates/helpers/declaration-modifiers.html.nunj +45 -0
- package/generator/templates/helpers/decorators.html.nunj +11 -0
- package/generator/templates/helpers/members.html.nunj +29 -0
- package/generator/templates/helpers/method.html.nunj +89 -0
- package/generator/templates/helpers/methods.html.nunj +7 -0
- package/generator/templates/helpers/modifier.html.nunj +4 -0
- package/generator/templates/helpers/no-content.html.nunj +3 -0
- package/generator/templates/helpers/overload.html.nunj +57 -0
- package/generator/templates/helpers/parameters.html.nunj +44 -0
- package/generator/templates/helpers/properties.html.nunj +61 -0
- package/generator/templates/helpers/status.html.nunj +33 -0
- package/generator/templates/helpers/tag.html.nunj +4 -0
- package/generator/templates/helpers/type.html.nunj +11 -0
- package/generator/templates/index.ts.nunj +2 -0
- package/generator/templates/page-header.html.nunj +5 -0
- package/generator/templates/page-wrapper.ts.nunj +64 -0
- package/generator/templates/page.ts.nunj +97 -0
- package/generator/templates/parts/examples.html.nunj +11 -0
- package/generator/templates/parts/member-examples.html.nunj +12 -0
- package/generator/templates/parts/member-remarks.html.nunj +8 -0
- package/generator/templates/parts/page-tags.html.nunj +10 -0
- package/generator/templates/parts/remarks.html.nunj +10 -0
- package/generator/templates/parts/see-also.html.nunj +23 -0
- package/generator/templates/parts/usage-notes.html.nunj +8 -0
- package/generator/templates/playgrounds.ts.nunj +63 -0
- package/generator/templates/routes.ts.nunj +49 -0
- package/generator/templates/symbol/decorators.html.nunj +12 -0
- package/generator/templates/symbol/details.html.nunj +62 -0
- package/generator/templates/symbol/extended-by.html.nunj +17 -0
- package/generator/templates/symbol/header.html.nunj +22 -0
- package/generator/templates/symbol/members.html.nunj +301 -0
- package/generator/templates/symbol/page.html.nunj +76 -0
- package/generator/templates/symbol/see-also.html.nunj +16 -0
- package/generator/vite/angular/ANALOG-LICENSE +21 -0
- package/generator/vite/angular/analog-provenance.json +880 -0
- package/generator/vite/angular/index.d.ts +14 -0
- package/generator/vite/angular/index.js +7300 -0
- package/generator/vite/angular-compatibility.d.ts +6 -0
- package/generator/vite/angular-composition.d.ts +68 -0
- package/generator/vite/angular-version.d.ts +38 -0
- package/generator/vite/application-builder.js +331 -0
- package/generator/vite/application-builder.schema.json +46 -0
- package/generator/vite/application.d.ts +91 -0
- package/generator/vite/assets.d.ts +11 -0
- package/generator/vite/bounded-close.d.ts +33 -0
- package/generator/vite/component-updates.d.ts +21 -0
- package/generator/vite/configuration.d.ts +3 -0
- package/generator/vite/dev-server-builder.js +334 -0
- package/generator/vite/dev-server-builder.schema.json +27 -0
- package/generator/vite/dev-styles.d.ts +65 -0
- package/generator/vite/diagnostics.d.ts +4 -0
- package/generator/vite/external-probes.d.ts +40 -0
- package/generator/vite/host-updates.d.ts +145 -0
- package/generator/vite/index.d.ts +13 -0
- package/generator/vite/index.js +11589 -0
- package/generator/vite/lease.d.ts +6 -0
- package/generator/vite/lifecycle.d.ts +119 -0
- package/generator/vite/mime.d.ts +2 -0
- package/generator/vite/missing-paths.d.ts +44 -0
- package/generator/vite/options.d.ts +87 -0
- package/generator/vite/output-watch.d.ts +41 -0
- package/generator/vite/paths.d.ts +7 -0
- package/generator/vite/plugin.d.ts +3 -0
- package/generator/vite/prerender-entry.js +395 -0
- package/generator/vite/prerender-runtime.d.ts +66 -0
- package/generator/vite/prerender.d.ts +27 -0
- package/generator/vite/production.d.ts +66 -0
- package/generator/vite/progress.d.ts +33 -0
- package/generator/vite/restore-theme.js +13 -0
- package/generator/vite/route-inventory.d.ts +24 -0
- package/generator/vite/ssr-renderer-control.d.ts +1 -0
- package/generator/vite/ssr-renderer-entry.js +444 -0
- package/generator/vite/ssr-renderer-protocol.d.ts +101 -0
- package/generator/vite/ssr-renderer.d.ts +74 -0
- package/generator/vite/theme-index.d.ts +13 -0
- package/generator/vite/tsconfig-paths.d.ts +64 -0
- package/generator/vite/vite-event-source.d.ts +198 -0
- package/generator/vite/vite-version.d.ts +26 -0
- package/generator/vite/watch-inputs.d.ts +39 -0
- package/generator/worker/entry.d.ts +1 -0
- package/generator/worker/entry.js +614 -0
- package/generator/worker/index.d.ts +156 -0
- package/generator/worker/index.js +1030 -0
- package/generator/worker/protocol.d.ts +160 -0
- package/helpers/angular/get-component-decorator.js +6 -6
- package/helpers/angular/get-component-decorator.js.map +1 -1
- package/helpers/angular/get-directive-decorator.js +3 -3
- package/helpers/angular/get-directive-decorator.js.map +1 -1
- package/helpers/angular/get-pipe-decorator.js +3 -3
- package/helpers/angular/get-pipe-decorator.js.map +1 -1
- package/helpers/build-indexes.js +5 -2
- package/helpers/build-indexes.js.map +1 -1
- package/helpers/construct-page-keyword.js +2 -1
- package/helpers/construct-page-keyword.js.map +1 -1
- package/helpers/extract-selectors.d.ts +1 -1
- package/helpers/extract-selectors.js +5 -3
- package/helpers/extract-selectors.js.map +1 -1
- package/helpers/filter-useless-members.d.ts +1 -1
- package/helpers/format-code.d.ts +2 -1
- package/helpers/format-code.js +13 -4
- package/helpers/format-code.js.map +1 -1
- package/helpers/import-fresh-esm.js.map +1 -1
- package/helpers/index.d.ts +2 -0
- package/helpers/index.js +2 -0
- package/helpers/index.js.map +1 -1
- package/helpers/keyword-heading-title.d.ts +7 -0
- package/helpers/keyword-heading-title.js +21 -0
- package/helpers/keyword-heading-title.js.map +1 -0
- package/helpers/markdown-to-html.js +3 -3
- package/helpers/markdown-to-html.js.map +1 -1
- package/helpers/navigation-title-order.d.ts +8 -0
- package/helpers/navigation-title-order.js +15 -0
- package/helpers/navigation-title-order.js.map +1 -0
- package/helpers/playground/get-playground-inputs.js +8 -4
- package/helpers/playground/get-playground-inputs.js.map +1 -1
- package/helpers/playground/get-playground-template-inputs.js +2 -1
- package/helpers/playground/get-playground-template-inputs.js.map +1 -1
- package/helpers/presentation.d.ts +7 -7
- package/helpers/presentation.js +23 -23
- package/helpers/presentation.js.map +1 -1
- package/helpers/print.js +32 -5
- package/helpers/print.js.map +1 -1
- package/helpers/process-snippets.d.ts +1 -1
- package/helpers/process-snippets.js +3 -3
- package/helpers/process-snippets.js.map +1 -1
- package/helpers/snippets-from-asset.d.ts +1 -1
- package/helpers/snippets-from-asset.js +2 -2
- package/helpers/snippets-from-asset.js.map +1 -1
- package/helpers/sort-navigation-entities.js +2 -1
- package/helpers/sort-navigation-entities.js.map +1 -1
- package/helpers/stable-generated-id.d.ts +2 -0
- package/helpers/stable-generated-id.js +12 -0
- package/helpers/stable-generated-id.js.map +1 -0
- package/helpers/text-order.d.ts +8 -0
- package/helpers/text-order.js +26 -0
- package/helpers/text-order.js.map +1 -0
- package/helpers/typescript/member/get-inherited-parent.d.ts +1 -1
- package/helpers/typescript/member/get-inherited-parent.js +2 -2
- package/helpers/typescript/member/get-inherited-parent.js.map +1 -1
- package/helpers/typescript/node/sort-by-nodes-name.d.ts +4 -2
- package/helpers/typescript/node/sort-by-nodes-name.js +6 -3
- package/helpers/typescript/node/sort-by-nodes-name.js.map +1 -1
- package/helpers/typescript/property/get-property-assignment.js.map +1 -1
- package/package.json +86 -29
- package/parsers/helpers/number.d.ts +1 -1
- package/parsers/helpers/number.js +2 -2
- package/parsers/helpers/number.js.map +1 -1
- package/parsers/helpers/param-value.d.ts +1 -1
- package/parsers/helpers/param-value.js +2 -2
- package/parsers/helpers/param-value.js.map +1 -1
- package/parsers/helpers/param.js +3 -3
- package/parsers/helpers/param.js.map +1 -1
- package/parsers/parse-code-block-params.d.ts +1 -1
- package/parsers/parse-code-block-params.js +22 -16
- package/parsers/parse-code-block-params.js.map +1 -1
- package/parsers/parse-snippet.js +10 -10
- package/parsers/parse-snippet.js.map +1 -1
- package/schematics/collection.json +34 -23
- package/schematics/migrate-to-vite/analyze.d.ts +76 -0
- package/schematics/migrate-to-vite/analyze.js +816 -0
- package/schematics/migrate-to-vite/analyze.js.map +1 -0
- package/schematics/migrate-to-vite/index.d.ts +9 -0
- package/schematics/migrate-to-vite/index.js +585 -0
- package/schematics/migrate-to-vite/index.js.map +1 -0
- package/schematics/migrate-to-vite/legacy-folder.d.ts +84 -0
- package/schematics/migrate-to-vite/legacy-folder.js +340 -0
- package/schematics/migrate-to-vite/legacy-folder.js.map +1 -0
- package/schematics/migrate-to-vite/report.d.ts +32 -0
- package/schematics/migrate-to-vite/report.js +97 -0
- package/schematics/migrate-to-vite/report.js.map +1 -0
- package/schematics/migrate-to-vite/schema.d.ts +13 -0
- package/schematics/migrate-to-vite/schema.js +3 -0
- package/schematics/migrate-to-vite/schema.js.map +1 -0
- package/schematics/migrate-to-vite/schema.json +31 -0
- package/schematics/migrate-to-vite/setup/dependencies.d.ts +64 -0
- package/schematics/migrate-to-vite/setup/dependencies.js +183 -0
- package/schematics/migrate-to-vite/setup/dependencies.js.map +1 -0
- package/schematics/migrate-to-vite/setup/index.d.ts +6 -0
- package/schematics/migrate-to-vite/setup/index.js +13 -0
- package/schematics/migrate-to-vite/setup/index.js.map +1 -0
- package/schematics/migrate-to-vite/setup/json-file.d.ts +51 -0
- package/schematics/migrate-to-vite/setup/json-file.js +115 -0
- package/schematics/migrate-to-vite/setup/json-file.js.map +1 -0
- package/schematics/migrate-to-vite/setup/source.d.ts +30 -0
- package/schematics/migrate-to-vite/setup/source.js +202 -0
- package/schematics/migrate-to-vite/setup/source.js.map +1 -0
- package/schematics/migrate-to-vite/setup/targets.d.ts +51 -0
- package/schematics/migrate-to-vite/setup/targets.js +48 -0
- package/schematics/migrate-to-vite/setup/targets.js.map +1 -0
- package/schematics/migrate-to-vite/setup/vite-config.d.ts +100 -0
- package/schematics/migrate-to-vite/setup/vite-config.js +175 -0
- package/schematics/migrate-to-vite/setup/vite-config.js.map +1 -0
- package/schematics/migrate-to-vite/setup/workspace.d.ts +100 -0
- package/schematics/migrate-to-vite/setup/workspace.js +225 -0
- package/schematics/migrate-to-vite/setup/workspace.js.map +1 -0
- package/schematics/migrate-to-vite/state.d.ts +65 -0
- package/schematics/migrate-to-vite/state.js +92 -0
- package/schematics/migrate-to-vite/state.js.map +1 -0
- package/schematics/migrate-to-vite/testing/fixtures.d.ts +18 -0
- package/schematics/migrate-to-vite/testing/fixtures.js +279 -0
- package/schematics/migrate-to-vite/testing/fixtures.js.map +1 -0
- package/schematics/migrate-to-vite/update-note.d.ts +6 -0
- package/schematics/migrate-to-vite/update-note.js +23 -0
- package/schematics/migrate-to-vite/update-note.js.map +1 -0
- package/schematics/migration.json +5 -0
- package/schematics/migrations/standalone-pages/index.js +7 -6
- package/schematics/migrations/standalone-pages/index.js.map +1 -1
- package/schematics/vite-setup/index.d.ts +20 -0
- package/schematics/vite-setup/index.js +206 -0
- package/schematics/vite-setup/index.js.map +1 -0
- package/schematics/vite-setup/schema.d.ts +7 -0
- package/schematics/vite-setup/schema.js +3 -0
- package/schematics/vite-setup/schema.js.map +1 -0
- package/schematics/vite-setup/schema.json +19 -0
- package/scripts/restore-theme.js +9 -2
- package/templates/context.ts.nunj +3 -0
- package/templates/helpers/badge.html.nunj +1 -1
- package/templates/helpers/status.html.nunj +4 -8
- package/templates/page-wrapper.ts.nunj +24 -1
- package/templates/page.ts.nunj +25 -0
- package/templates/parts/page-tags.html.nunj +1 -1
- package/templates/playgrounds.ts.nunj +8 -9
- package/templates/routes.ts.nunj +6 -1
- package/templates/symbol/decorators.html.nunj +12 -0
- package/templates/symbol/details.html.nunj +62 -0
- package/templates/symbol/extended-by.html.nunj +17 -0
- package/templates/symbol/header.html.nunj +22 -0
- package/templates/symbol/members.html.nunj +301 -0
- package/templates/symbol/page.html.nunj +76 -0
- package/templates/symbol/see-also.html.nunj +16 -0
- package/engine/.cache/apps/ng-doc/docs/api-documentation/auto-generation/ng-doc.page.mjs +0 -20
- package/engine/.cache/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.mjs +0 -20
- package/engine/.cache/apps/ng-doc/docs/api-documentation/rendering-api/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/icons/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/layout/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/page-processors/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/page-skeleton/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/search/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/themes/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/develop/ng-doc.page.mjs +0 -36
- package/engine/.cache/apps/ng-doc/docs/getting-started/configuration/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/installation/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/migrations/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/getting-started/ssr/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/what-is-ng-doc/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/ng-doc.api.mjs +0 -42
- package/engine/.cache/apps/ng-doc/docs/recipes/ignoring-file-lines/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/recipes/performance/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/writing-content/blockquotes/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/code-blocks/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/demo-and-demo-pane/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/writing-content/images-videos-and-embeds/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/keywords/ng-doc.page.mjs +0 -17
- package/engine/.cache/apps/ng-doc/docs/writing-content/mermaid-diagrams/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/nunjucks/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/pages-and-categories/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/playground/ng-doc.page.mjs +0 -33
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
{% import "helpers/code.html.nunj" as codeMacro %}
|
|
2
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
3
|
+
{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
|
|
4
|
+
{% import "helpers/parameters.html.nunj" as parametersMacro %}
|
|
5
|
+
{% import "helpers/decorators.html.nunj" as decoratorsMacro %}
|
|
6
|
+
{% import "helpers/no-content.html.nunj" as noContentMacro %}
|
|
7
|
+
{% import "helpers/overload.html.nunj" as overloadMacro %}
|
|
8
|
+
{% import "helpers/status.html.nunj" as statusMacro %}
|
|
9
|
+
|
|
10
|
+
{% macro render(method, origin) %}
|
|
11
|
+
{% set parameters = method.getParameters() %}
|
|
12
|
+
{% set methodChain = method | getMethodChain %}
|
|
13
|
+
{% set inheritedFrom = method | getInheritedParent(origin) %}
|
|
14
|
+
{% set overriddenMember = method | getOverriddenMember %}
|
|
15
|
+
{% set implementedMember = method | getImplementedMember %}
|
|
16
|
+
{% set docNode = methodChain | firstNodeWithComment %}
|
|
17
|
+
{% set overloads = method.getOverloads() if method.getOverloads else [] %}
|
|
18
|
+
{% set returnsTag = docNode | getJsDocTag('returns') %}
|
|
19
|
+
|
|
20
|
+
<table class="{{ statusMacro.class(method) }}">
|
|
21
|
+
<thead>
|
|
22
|
+
<tr>
|
|
23
|
+
<th indexable="false">
|
|
24
|
+
{{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
|
|
25
|
+
{{ tagsMacro.render(method, 'modifier') }}
|
|
26
|
+
<h3 dataSlugType="member">{{ method.getName() }}()</h3>
|
|
27
|
+
<div class="ng-doc-node-details">
|
|
28
|
+
{%- if inheritedFrom %}
|
|
29
|
+
inherited from <code>{{ inheritedFrom.getName() }}</code>
|
|
30
|
+
{%- elseif overriddenMember %}
|
|
31
|
+
overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
|
|
32
|
+
{%- elseif implementedMember %}
|
|
33
|
+
implements
|
|
34
|
+
<code>{{ (implementedMember | getMemberParent).getName() }}</code>
|
|
35
|
+
{%- endif %}
|
|
36
|
+
</div>
|
|
37
|
+
</th>
|
|
38
|
+
</tr>
|
|
39
|
+
</thead>
|
|
40
|
+
<tbody>
|
|
41
|
+
<tr>
|
|
42
|
+
<td>
|
|
43
|
+
<div class="ng-doc-api-status">
|
|
44
|
+
{{ statusMacro.render(method) }}
|
|
45
|
+
</div>
|
|
46
|
+
|
|
47
|
+
{% set description = docNode | getJsDocDescription %}
|
|
48
|
+
|
|
49
|
+
{{ description if description else noContentMacro.render('No documentation has been provided.') }}
|
|
50
|
+
|
|
51
|
+
{% include "parts/member-remarks.html.nunj" %}
|
|
52
|
+
</td>
|
|
53
|
+
</tr>
|
|
54
|
+
<tr>
|
|
55
|
+
<td>
|
|
56
|
+
<h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Presentation</h5>
|
|
57
|
+
{{ codeMacro.render(method | methodPresentation, "typescript", false) }}
|
|
58
|
+
</td>
|
|
59
|
+
</tr>
|
|
60
|
+
<tr>
|
|
61
|
+
<td>
|
|
62
|
+
{%- if parameters.length %}
|
|
63
|
+
<h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Parameters</h5>
|
|
64
|
+
{{ parametersMacro.render(parameters, docNode) }}
|
|
65
|
+
{%- endif %}
|
|
66
|
+
<h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Returns</h5>
|
|
67
|
+
|
|
68
|
+
<div class="ng-doc-returns">
|
|
69
|
+
{{ typeMacro.returnType(method) }}
|
|
70
|
+
{%- if returnsTag.length %}
|
|
71
|
+
<span> - </span>
|
|
72
|
+
{{ returnsTag | markdownToHtml }}
|
|
73
|
+
{%- endif %}
|
|
74
|
+
</div>
|
|
75
|
+
</td>
|
|
76
|
+
</tr>
|
|
77
|
+
|
|
78
|
+
{% include "parts/member-examples.html.nunj" %}
|
|
79
|
+
|
|
80
|
+
{% if overloads.length %}
|
|
81
|
+
<tr>
|
|
82
|
+
<td>
|
|
83
|
+
{{ overloadMacro.render(overloads) }}
|
|
84
|
+
</td>
|
|
85
|
+
</tr>
|
|
86
|
+
{% endif %}
|
|
87
|
+
</tbody>
|
|
88
|
+
</table>
|
|
89
|
+
{% endmacro %}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{% import "helpers/no-content.html.nunj" as noContentMacro %}
|
|
2
|
+
{% import "helpers/parameters.html.nunj" as parametersMacro %}
|
|
3
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
4
|
+
{% import "helpers/code.html.nunj" as codeMacro %}
|
|
5
|
+
|
|
6
|
+
{% macro render(overloads) %}
|
|
7
|
+
{% for overload in overloads %}
|
|
8
|
+
{% set docNode = overload %}
|
|
9
|
+
{% set parameters = overload.getParameters() %}
|
|
10
|
+
{% set returnsTag = docNode | getJsDocTag('returns') %}
|
|
11
|
+
|
|
12
|
+
<table class="ng-doc-overload-table">
|
|
13
|
+
<thead indexable="false">
|
|
14
|
+
<tr>
|
|
15
|
+
<th>Overload #{{ loop.index }}</th>
|
|
16
|
+
</tr>
|
|
17
|
+
</thead>
|
|
18
|
+
<tbody>
|
|
19
|
+
<tr>
|
|
20
|
+
<td>
|
|
21
|
+
{% set description = docNode | getJsDocDescription %}
|
|
22
|
+
|
|
23
|
+
{{ description if description else noContentMacro.render('No documentation has been provided.') }}
|
|
24
|
+
|
|
25
|
+
{% include "parts/member-remarks.html.nunj" %}
|
|
26
|
+
</td>
|
|
27
|
+
</tr>
|
|
28
|
+
<tr>
|
|
29
|
+
<td>
|
|
30
|
+
<h5 class="no-anchor" indexable="false">Presentation</h5>
|
|
31
|
+
{{ codeMacro.render(overload | methodPresentation, "typescript", false) }}
|
|
32
|
+
</td>
|
|
33
|
+
</tr>
|
|
34
|
+
<tr>
|
|
35
|
+
<td>
|
|
36
|
+
{%- if parameters.length %}
|
|
37
|
+
<h5 class="no-anchor" indexable="false">Parameters</h5>
|
|
38
|
+
{{ parametersMacro.render(parameters, docNode) }}
|
|
39
|
+
{%- endif %}
|
|
40
|
+
<h5 class="no-anchor" indexable="false">Returns</h5>
|
|
41
|
+
<div class="ng-doc-returns">
|
|
42
|
+
{{ typeMacro.returnType(overload) }}
|
|
43
|
+
{%- if returnsTag.length %}
|
|
44
|
+
<span> - </span>
|
|
45
|
+
{{ returnsTag | markdownToHtml }}
|
|
46
|
+
{%- endif %}
|
|
47
|
+
</div>
|
|
48
|
+
</td>
|
|
49
|
+
</tr>
|
|
50
|
+
|
|
51
|
+
{% include "parts/member-examples.html.nunj" %}
|
|
52
|
+
|
|
53
|
+
</tbody>
|
|
54
|
+
</table>
|
|
55
|
+
{% endfor %}
|
|
56
|
+
{% endmacro %}
|
|
57
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
2
|
+
{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
|
|
3
|
+
{% import "helpers/decorators.html.nunj" as decoratorsMacro %}
|
|
4
|
+
|
|
5
|
+
{% macro render(parameters, origin, slugger) %}
|
|
6
|
+
<table class="ng-doc-api-table">
|
|
7
|
+
<thead>
|
|
8
|
+
<tr indexable="false">
|
|
9
|
+
<th>Name</th>
|
|
10
|
+
<th>Type</th>
|
|
11
|
+
<th>Description</th>
|
|
12
|
+
</tr>
|
|
13
|
+
</thead>
|
|
14
|
+
<tbody>
|
|
15
|
+
{%- for param in parameters %}
|
|
16
|
+
{% set paramChain = param | getPropertyChain %}
|
|
17
|
+
{% set inheritedFrom = param | getInheritedParent(origin) %}
|
|
18
|
+
{% set overriddenMember = param | getOverriddenMember %}
|
|
19
|
+
{% set implementedMember = param | getImplementedMember %}
|
|
20
|
+
{% set docNode = paramChain | firstNodeWithComment %}
|
|
21
|
+
|
|
22
|
+
<tr {{ 'dataSlug="'+param.getName()+'" dataSlugType="member"' if slugger }}>
|
|
23
|
+
<td indexable="false">
|
|
24
|
+
{{ decoratorsMacro.render(param.getDecorators(), true) if param.getDecorators }}
|
|
25
|
+
{{ tagsMacro.render(param, "badge") }}{{ param.getName() }}
|
|
26
|
+
<div class="ng-doc-node-details">
|
|
27
|
+
{%- if inheritedFrom %}
|
|
28
|
+
inherited from <code>{{ inheritedFrom.getName() }}</code>
|
|
29
|
+
{%- elseif overriddenMember %}
|
|
30
|
+
overrides
|
|
31
|
+
<code>{{ (overriddenMember | getMemberParent).getName() }}</code>
|
|
32
|
+
{%- elseif implementedMember %}
|
|
33
|
+
implements
|
|
34
|
+
<code>{{ (implementedMember | getMemberParent).getName() }}</code>
|
|
35
|
+
{%- endif %}
|
|
36
|
+
</div>
|
|
37
|
+
</td>
|
|
38
|
+
<td>{{ typeMacro.type(param) }}</td>
|
|
39
|
+
<td>{{ origin | getJsDocParam(param.getName()) }}</td>
|
|
40
|
+
</tr>
|
|
41
|
+
{%- endfor %}
|
|
42
|
+
</tbody>
|
|
43
|
+
</table>
|
|
44
|
+
{% endmacro %}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
2
|
+
{% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
|
|
3
|
+
{% import "helpers/decorators.html.nunj" as decoratorsMacro %}
|
|
4
|
+
{% import "helpers/status.html.nunj" as statusMacro %}
|
|
5
|
+
{% set examplesColSpan = 3 %}
|
|
6
|
+
|
|
7
|
+
{# mode='inheritedFrom' (classes/interfaces) or mode='definedIn' (type aliases) #}
|
|
8
|
+
{% macro render(properties, origin, mode='inheritedFrom') %}
|
|
9
|
+
<table class="ng-doc-api-table sticky first-colum-highlighted">
|
|
10
|
+
<thead>
|
|
11
|
+
<tr indexable="false">
|
|
12
|
+
<th class="ng-doc-api-table-name">Name</th>
|
|
13
|
+
<th class="ng-doc-api-table-type">Type</th>
|
|
14
|
+
<th class="ng-doc-api-table-description">Description</th>
|
|
15
|
+
</tr>
|
|
16
|
+
</thead>
|
|
17
|
+
<tbody>
|
|
18
|
+
{%- for property in properties %}
|
|
19
|
+
{% set propertyChain = property | getPropertyChain %}
|
|
20
|
+
{% set definedIn = property | getDefinedInParent(origin) %}
|
|
21
|
+
{% set definedInHasName = definedIn | isNamed %}
|
|
22
|
+
{% set inheritedFrom = property | getInheritedParent(origin) %}
|
|
23
|
+
{% set overriddenMember = property | getOverriddenMember %}
|
|
24
|
+
{% set implementedMember = property | getImplementedMember %}
|
|
25
|
+
{% set docNode = propertyChain | firstNodeWithComment %}
|
|
26
|
+
|
|
27
|
+
<tr class="{{ statusMacro.class(property) }}" dataSlug="{{ property.getName() }}" dataSlugType="member">
|
|
28
|
+
<td indexable="false">
|
|
29
|
+
{{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
|
|
30
|
+
<span>{{ property.getName() }}{{ tagsMacro.render(property, "badge") }}</span>
|
|
31
|
+
<div class="ng-doc-node-details">
|
|
32
|
+
{%- if mode == 'definedIn' and definedIn and definedInHasName %}
|
|
33
|
+
defined in <code>{{ definedIn.getName() }}</code>
|
|
34
|
+
{%- elseif mode == 'inheritedFrom' and inheritedFrom %}
|
|
35
|
+
inherited from <code>{{ inheritedFrom.getName() }}</code>
|
|
36
|
+
{%- elseif overriddenMember %}
|
|
37
|
+
overrides
|
|
38
|
+
<code>{{ (overriddenMember | getMemberParent).getName() }}</code>
|
|
39
|
+
{%- elseif implementedMember %}
|
|
40
|
+
implements
|
|
41
|
+
<code>{{ (implementedMember | getMemberParent).getName() }}</code>
|
|
42
|
+
{%- endif %}
|
|
43
|
+
</div>
|
|
44
|
+
</td>
|
|
45
|
+
<td class="ng-doc-api-table-type">{{ typeMacro.type(property) }}</td>
|
|
46
|
+
<td>
|
|
47
|
+
<div class="ng-doc-api-status">
|
|
48
|
+
{{ statusMacro.render(property) }}
|
|
49
|
+
</div>
|
|
50
|
+
{{ docNode | getJsDocDescription }}
|
|
51
|
+
|
|
52
|
+
{% include "parts/member-remarks.html.nunj" %}
|
|
53
|
+
</td>
|
|
54
|
+
</tr>
|
|
55
|
+
|
|
56
|
+
{% include "parts/member-examples.html.nunj" %}
|
|
57
|
+
|
|
58
|
+
{%- endfor %}
|
|
59
|
+
</tbody>
|
|
60
|
+
</table>
|
|
61
|
+
{% endmacro %}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{% macro render(member) %}
|
|
2
|
+
{% set deprecated = member | getJsDocTag('deprecated') %}
|
|
3
|
+
{% if deprecated %}
|
|
4
|
+
<ng-doc-blockquote type="warning" icon="activity" label="Deprecated">
|
|
5
|
+
{{ deprecated }}
|
|
6
|
+
</ng-doc-blockquote>
|
|
7
|
+
{% endif %}
|
|
8
|
+
|
|
9
|
+
{% set experimental = member | getJsDocTag('experimental') %}
|
|
10
|
+
{% if experimental %}
|
|
11
|
+
<ng-doc-blockquote type="alert" icon="activity" label="Experimental">
|
|
12
|
+
{{ experimental }}
|
|
13
|
+
</ng-doc-blockquote>
|
|
14
|
+
{% endif %}
|
|
15
|
+
|
|
16
|
+
{% set alpha = member | getJsDocTag('alpha') %}
|
|
17
|
+
{% if alpha %}
|
|
18
|
+
<ng-doc-blockquote type="alert" icon="activity" label="Alpha">
|
|
19
|
+
{{ alpha }}
|
|
20
|
+
</ng-doc-blockquote>
|
|
21
|
+
{% endif %}
|
|
22
|
+
|
|
23
|
+
{% set beta = member | getJsDocTag('beta') %}
|
|
24
|
+
{% if beta %}
|
|
25
|
+
<ng-doc-blockquote type="warning" icon="activity" label="Beta">
|
|
26
|
+
{{ beta }}
|
|
27
|
+
</ng-doc-blockquote>
|
|
28
|
+
{% endif %}
|
|
29
|
+
{% endmacro %}
|
|
30
|
+
|
|
31
|
+
{% macro class(member) -%}
|
|
32
|
+
{{ "ng-doc-deprecated" if member | hasJsDocTag('deprecated') }} {{ "ng-doc-alpha" if member | hasJsDocTag('alpha') }} {{ "ng-doc-beta" if member | hasJsDocTag('beta') }} {{ "ng-doc-experimental" if member | hasJsDocTag('experimental') }}
|
|
33
|
+
{%- endmacro %}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{% macro type(node) -%}
|
|
2
|
+
<code indexable="false">{{ node | displayType | escape }}</code>
|
|
3
|
+
{%- endmacro %}
|
|
4
|
+
|
|
5
|
+
{%- macro returnType(node) -%}
|
|
6
|
+
<code indexable="false">{{ node | displayReturnType | escape }}</code>
|
|
7
|
+
{%- endmacro %}
|
|
8
|
+
|
|
9
|
+
{% macro render(type) -%}
|
|
10
|
+
<code indexable="false">{{ type | escape }}</code>
|
|
11
|
+
{%- endmacro %}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import {ChangeDetectionStrategy, Component} from '@angular/core';
|
|
3
|
+
import {Routes} from '@angular/router';
|
|
4
|
+
import {NgDocPageWrapperComponent} from '@ng-doc/app';
|
|
5
|
+
import {NgDocPageType} from '@ng-doc/core';
|
|
6
|
+
{%- if headerContentSourceImport %}
|
|
7
|
+
import {ɵwithNgDocContent} from '@ng-doc/app';
|
|
8
|
+
import headerContentSource from '{{ headerContentSourceImport }}';
|
|
9
|
+
{%- endif %}
|
|
10
|
+
|
|
11
|
+
{%- if headerContentSourceImport %}
|
|
12
|
+
const headerContent: string = '';
|
|
13
|
+
{%- else %}
|
|
14
|
+
const headerContent: string = `{{ headerContent | toTemplateString }}`
|
|
15
|
+
{%- endif %}
|
|
16
|
+
|
|
17
|
+
@Component({
|
|
18
|
+
selector: 'ng-doc-page-wrapper-{{ id }}',
|
|
19
|
+
template: `<ng-doc-page-wrapper [routes]="routes" [headerContent]="headerContent"{%- if headerContentSourceImport %} [headerContentSource]="headerContentSource"{%- endif %} [hasBreadcrumb]="hasBreadcrumb" [pageType]="pageType"></ng-doc-page-wrapper>`,
|
|
20
|
+
imports: [NgDocPageWrapperComponent],
|
|
21
|
+
changeDetection: ChangeDetectionStrategy.OnPush,
|
|
22
|
+
})
|
|
23
|
+
export class PageWrapperComponent {
|
|
24
|
+
routes = routes[0].children!;
|
|
25
|
+
headerContent = headerContent;
|
|
26
|
+
{%- if headerContentSourceImport %}
|
|
27
|
+
headerContentSource = headerContentSource;
|
|
28
|
+
{%- endif %}
|
|
29
|
+
pageType: NgDocPageType = '{{ pageType }}';
|
|
30
|
+
hasBreadcrumb = {{ hasBreadcrumb }};
|
|
31
|
+
}
|
|
32
|
+
{%- if headerContentSourceImport %}
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
// The router shows the page only once its header has loaded, so the previous page stays on
|
|
36
|
+
// screen instead of an empty page.
|
|
37
|
+
const routes: Routes = [ɵwithNgDocContent({
|
|
38
|
+
{%- else %}
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
const routes: Routes = [{
|
|
42
|
+
{%- endif %}
|
|
43
|
+
path: '',
|
|
44
|
+
component: PageWrapperComponent,
|
|
45
|
+
title: `{{ metadata.title | toTemplateString }}`,
|
|
46
|
+
children: [
|
|
47
|
+
{%- for importPath, entry in entries %}
|
|
48
|
+
{
|
|
49
|
+
path: '{{ entry.route }}',
|
|
50
|
+
loadChildren: () => import('./{{ importPath }}'),
|
|
51
|
+
title: `{{ entry.title | toTemplateString }}`,
|
|
52
|
+
data: {
|
|
53
|
+
icon: '{{ entry.entry.icon }}',
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
{%- endfor %}
|
|
57
|
+
]
|
|
58
|
+
{%- if headerContentSourceImport %}
|
|
59
|
+
}, headerContentSource)]
|
|
60
|
+
{%- else %}
|
|
61
|
+
}]
|
|
62
|
+
{%- endif %}
|
|
63
|
+
|
|
64
|
+
export default routes;
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import {ChangeDetectionStrategy, Component} from '@angular/core';
|
|
3
|
+
import {Routes} from '@angular/router';
|
|
4
|
+
import {NgDocDemoAssets, NgDocPageComponent, NgDocRootPage} from '@ng-doc/app';
|
|
5
|
+
import {isRoute, NgDocPage, NgDocPageType} from '@ng-doc/core';
|
|
6
|
+
{%- if entryPath %}
|
|
7
|
+
import entry from '{{ metadata.outDir | createImportPath(entryPath) }}';
|
|
8
|
+
{%- endif %}
|
|
9
|
+
{%- if playgroundsPath %}
|
|
10
|
+
import {PLAYGROUND_COMPONENTS, PLAYGROUND_PROVIDERS} from '{{ metadata.outDir | createImportPath(playgroundsPath) }}';
|
|
11
|
+
{%- endif %}
|
|
12
|
+
{%- if demoAssetsPath %}
|
|
13
|
+
import demoAssets from '{{ metadata.outDir | createImportPath(demoAssetsPath) }}';
|
|
14
|
+
{%- endif %}
|
|
15
|
+
{%- if contentSourceImport %}
|
|
16
|
+
import {ɵwithNgDocContent} from '@ng-doc/app';
|
|
17
|
+
import pageContentSource from '{{ contentSourceImport }}';
|
|
18
|
+
{%- endif %}
|
|
19
|
+
|
|
20
|
+
{%- if contentSourceImport %}
|
|
21
|
+
const pageContent: string = '';
|
|
22
|
+
{%- else %}
|
|
23
|
+
const pageContent: string = `{{ content | toTemplateString }}`
|
|
24
|
+
{%- endif %}
|
|
25
|
+
|
|
26
|
+
@Component({
|
|
27
|
+
selector: 'ng-doc-page-{{ id }}',
|
|
28
|
+
template: `<ng-doc-page></ng-doc-page>`,
|
|
29
|
+
changeDetection: ChangeDetectionStrategy.OnPush,
|
|
30
|
+
imports: [
|
|
31
|
+
NgDocPageComponent,
|
|
32
|
+
{%- if entryPath and entryHasImports %}
|
|
33
|
+
...entry.imports,
|
|
34
|
+
{%- endif %}
|
|
35
|
+
{%- if playgroundsPath %}
|
|
36
|
+
...PLAYGROUND_COMPONENTS,
|
|
37
|
+
{%- endif %}
|
|
38
|
+
],
|
|
39
|
+
providers: [
|
|
40
|
+
{provide: NgDocRootPage, useExisting: PageComponent},
|
|
41
|
+
{%- if playgroundsPath %}
|
|
42
|
+
PLAYGROUND_PROVIDERS,
|
|
43
|
+
{%- endif %}
|
|
44
|
+
{%- if entryPath %}
|
|
45
|
+
(entry.providers ?? []),
|
|
46
|
+
{%- endif %}
|
|
47
|
+
],
|
|
48
|
+
})
|
|
49
|
+
export class PageComponent extends NgDocRootPage {
|
|
50
|
+
readonly pageType: NgDocPageType = '{{ pageType }}';
|
|
51
|
+
readonly pageContent: string = pageContent;
|
|
52
|
+
{%- if contentSourceImport %}
|
|
53
|
+
readonly pageContentSource = pageContentSource;
|
|
54
|
+
{%- endif %}
|
|
55
|
+
{%- if editSourceFileUrl %}
|
|
56
|
+
readonly editSourceFileUrl: string = '{{ editSourceFileUrl }}';
|
|
57
|
+
{%- endif %}
|
|
58
|
+
{%- if viewSourceFileUrl %}
|
|
59
|
+
readonly viewSourceFileUrl: string = '{{ viewSourceFileUrl }}';
|
|
60
|
+
{%- endif -%}
|
|
61
|
+
{%- if entryPath %}
|
|
62
|
+
readonly page?: NgDocPage = entry;
|
|
63
|
+
{%- endif %}
|
|
64
|
+
{%- if demoAssetsPath %}
|
|
65
|
+
readonly demoAssets: NgDocDemoAssets = demoAssets;
|
|
66
|
+
{%- endif %}
|
|
67
|
+
|
|
68
|
+
constructor() {
|
|
69
|
+
super();
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
{%- if contentSourceImport %}
|
|
73
|
+
|
|
74
|
+
// The router shows the page only once its content has loaded, so the previous page stays on
|
|
75
|
+
// screen instead of an empty page.
|
|
76
|
+
const routes: Routes = [ɵwithNgDocContent({
|
|
77
|
+
{%- if entryPath %}
|
|
78
|
+
...(isRoute(entry.route) ? entry.route : {}),
|
|
79
|
+
{%- endif %}
|
|
80
|
+
path: '',
|
|
81
|
+
component: PageComponent,
|
|
82
|
+
title: `{{ metadata.title | toTemplateString }}`,
|
|
83
|
+
}, pageContentSource)]
|
|
84
|
+
{%- else %}
|
|
85
|
+
|
|
86
|
+
const routes: Routes = [{
|
|
87
|
+
{%- if entryPath %}
|
|
88
|
+
...(isRoute(entry.route) ? entry.route : {}),
|
|
89
|
+
{%- endif %}
|
|
90
|
+
path: '',
|
|
91
|
+
component: PageComponent,
|
|
92
|
+
title: `{{ metadata.title | toTemplateString }}`,
|
|
93
|
+
}]
|
|
94
|
+
{%- endif %}
|
|
95
|
+
|
|
96
|
+
export default routes;
|
|
97
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{%- set examples = docNode | getJsDocTags('example') -%}
|
|
2
|
+
|
|
3
|
+
{% if examples.length -%}
|
|
4
|
+
<tr indexable="false">
|
|
5
|
+
<td {% if examplesColSpan %}colspan="{{ examplesColSpan }}"{% endif %}>
|
|
6
|
+
<h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Example usage</h5>
|
|
7
|
+
{% for example in examples -%}
|
|
8
|
+
{{ example }}
|
|
9
|
+
{%- endfor %}
|
|
10
|
+
</td>
|
|
11
|
+
</tr>
|
|
12
|
+
{%- endif %}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{% import "helpers/tag.html.nunj" as tagMacro %}
|
|
2
|
+
|
|
3
|
+
<div class="ng-doc-page-tags">
|
|
4
|
+
{% set declarationType = declaration | getDeclarationType %}
|
|
5
|
+
|
|
6
|
+
{{ tagMacro.render(scope.name, "ng-doc-scope") }}
|
|
7
|
+
<span class="ng-doc-inline-delimiter" indexable="false">/</span>
|
|
8
|
+
{{ tagMacro.render("Type alias" if declarationType == "TypeAlias" else declarationType, declarationType) if declarationType }}
|
|
9
|
+
</div>
|
|
10
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{%- set seeDocs = docNode | getJsDocTags('see') %}
|
|
2
|
+
|
|
3
|
+
{% set derivedClasses %}
|
|
4
|
+
{%- if declaration.getDerivedClasses %}
|
|
5
|
+
{%- set derived = declaration.getDerivedClasses() %}
|
|
6
|
+
{%- for cls in derived %}
|
|
7
|
+
<li><code>{{ cls.getName() }}</code> (extended)</li>
|
|
8
|
+
{%- endfor %}
|
|
9
|
+
{%- endif %}
|
|
10
|
+
{% endset %}
|
|
11
|
+
|
|
12
|
+
{%- if seeDocs.length or derivedClasses | trim %}
|
|
13
|
+
<section indexable="false">
|
|
14
|
+
<h2>See Also</h2>
|
|
15
|
+
|
|
16
|
+
<ul class="ng-doc-see-also">
|
|
17
|
+
{{ derivedClasses }}
|
|
18
|
+
{%- for see in seeDocs %}
|
|
19
|
+
<li>{{ see }}</li>
|
|
20
|
+
{%- endfor %}
|
|
21
|
+
</ul>
|
|
22
|
+
</section>
|
|
23
|
+
{%- endif %}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
// @ts-nocheck
|
|
2
|
+
import {ChangeDetectionStrategy, Component, viewChild, ViewContainerRef} from '@angular/core';
|
|
3
|
+
import {NgDocBasePlayground, providePlaygroundDemo} from '@ng-doc/app';
|
|
4
|
+
// noinspection ES6UnusedImports
|
|
5
|
+
import pageEntity from '{{ entryImportPath }}';
|
|
6
|
+
import {CommonModule} from '@angular/common';
|
|
7
|
+
|
|
8
|
+
{%- set components = [] %}
|
|
9
|
+
{%- set index = 1 %}
|
|
10
|
+
{%- set playgrounds = playgroundMetadata %}
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
{%- for id, metadata in playgrounds -%}
|
|
14
|
+
|
|
15
|
+
{%- for selector, template in metadata.templateForComponents %}
|
|
16
|
+
{%- set comp = {id: id, name: 'PlaygroundComponent' + index, selector: selector } %}
|
|
17
|
+
{%- set components = (components.push(comp), components) %}
|
|
18
|
+
|
|
19
|
+
@Component({
|
|
20
|
+
selector: 'ng-doc-playground-{{ index }}',
|
|
21
|
+
{#- Two pages with the same playground would otherwise compile to identical components, which
|
|
22
|
+
Angular gives the same component ID (NG0912). The page route keeps them apart. #}
|
|
23
|
+
host: {'data-ng-doc-playground-page': '{{ pageRoute }}'},
|
|
24
|
+
template: `
|
|
25
|
+
{{ template }}
|
|
26
|
+
`,
|
|
27
|
+
imports: [
|
|
28
|
+
CommonModule,
|
|
29
|
+
{%- if hasImports %}
|
|
30
|
+
...pageEntity.imports,
|
|
31
|
+
{%- endif %}
|
|
32
|
+
{%- if metadata.standalone %}
|
|
33
|
+
pageEntity.playgrounds['{{ id }}'].target,
|
|
34
|
+
{%- endif %}
|
|
35
|
+
],
|
|
36
|
+
changeDetection: ChangeDetectionStrategy.OnPush,
|
|
37
|
+
})
|
|
38
|
+
export class {{ comp.name }} extends NgDocBasePlayground {
|
|
39
|
+
static readonly selector: string = '{{ comp.selector }}';
|
|
40
|
+
|
|
41
|
+
readonly target = pageEntity.playgrounds['{{ id }}'].target;
|
|
42
|
+
|
|
43
|
+
readonly playground = viewChild(pageEntity.playgrounds['{{ id }}'].target);
|
|
44
|
+
|
|
45
|
+
readonly viewContainerRef = viewChild(pageEntity.playgrounds['{{ id }}'].target, {read: ViewContainerRef});
|
|
46
|
+
|
|
47
|
+
readonly configData: any = pageEntity.playgrounds['{{ id }}'].data;
|
|
48
|
+
}
|
|
49
|
+
{%- set index = index + 1 -%}
|
|
50
|
+
{%- endfor %}
|
|
51
|
+
{%- endfor %}
|
|
52
|
+
|
|
53
|
+
export const PLAYGROUND_COMPONENTS = [
|
|
54
|
+
{%- for comp in components %}
|
|
55
|
+
{{ comp.name }},
|
|
56
|
+
{%- endfor %}
|
|
57
|
+
];
|
|
58
|
+
|
|
59
|
+
export const PLAYGROUND_PROVIDERS = [
|
|
60
|
+
{%- for comp in components %}
|
|
61
|
+
providePlaygroundDemo('{{ comp.id }}', {{ comp.name }}),
|
|
62
|
+
{%- endfor %}
|
|
63
|
+
];
|