NgDoc API
423 declarations in 5 scopes.
Group by
Class 32
- JSDocNo description@ng-doc/builder
- NgDocActionsNo description@ng-doc/builder
- NgDocApiNo description@ng-doc/builder
- NgDocApiListIndexServiceLoads the API lists of every API entry once, for the search palette.@ng-doc/app
- NgDocComponentContentNo description@ng-doc/ui-kit
- NgDocContentScrollIntentCaptures the public initial-navigation facts that are unavailable after component activation.@ng-doc/app
- NgDocContentStateRequest-local content failures observed by the SSR readiness boundary.@ng-doc/app
- NgDocDefaultSearchEngineSearch engine for the documentation, it loads the index and provides a search method.@ng-doc/app
- NgDocDialogServiceOpens dialogs: overlays centered in the viewport that block page scrolling.@ng-doc/ui-kit
- NgDocDisplayValueHostNo description@ng-doc/ui-kit
- NgDocFocusUtilsNo description@ng-doc/ui-kit
- NgDocFullscreenRouteServiceTells whether a page shows one of its fullscreen routes: a child route of the page (see route.children of NgDocPage), which ng-doc-page shows on its own, on…@ng-doc/app
- NgDocHighlighterServiceHighlights code with Shiki. provideNgDocApp initializes it before the application renders.@ng-doc/app
- NgDocHtmlParserNo description@ng-doc/core
- NgDocIconRegistryLoads SVG icons and keeps them for the lifetime of the application.@ng-doc/ui-kit
- NgDocInputHostNo description@ng-doc/ui-kit
- NgDocListHostNo description@ng-doc/ui-kit
- NgDocNotifyServiceShows short notifications at the bottom of the viewport. A new notification replaces the current one, and each closes after two seconds.@ng-doc/ui-kit
- NgDocOverlayRefA handle to an opened overlay (a dropdown, a tooltip or a dialog).@ng-doc/ui-kit
- NgDocOverlayServiceOpens NgDoc overlays: a container component inside a CDK overlay.@ng-doc/ui-kit
- NgDocOverlayStrategyA scroll strategy that closes the overlay when an element that contains its origin scrolls. Tooltips use it.@ng-doc/ui-kit
- NgDocOverlayUtilsNo description@ng-doc/ui-kit
- NgDocPositionUtilsNo description@ng-doc/ui-kit
- NgDocPreloadingStrategyThe router preloading strategy of NgDoc: it loads a lazy route only when the reader is about to open one of its pages, as NgDocRoutePreloader decides, instead…@ng-doc/app
- NgDocRootPageBase class for NgDoc page@ng-doc/app
- NgDocRoutePreloaderPreloads the pages that the reader is about to open, so that opening them shows them at once.@ng-doc/app
- NgDocScrollServiceBlocks and unblocks the scrolling of the page, for example while a sidebar covers it.@ng-doc/ui-kit
- NgDocSearchEngineAbstract search engine class, that can be used to implement a custom search engine.@ng-doc/app
- NgDocShortcutsServiceKeyboard shortcuts of the documentation.@ng-doc/app
- NgDocSidebarServiceService for sidebar, it can be used to hide/show sidebar or to check if sidebar is collapsable.@ng-doc/app
- NgDocStoreServiceReads and writes NgDoc settings (for example the theme) in the browser's local storage.@ng-doc/app
- NgDocThemeServiceService for managing themes.@ng-doc/app
Component 84
- DialogOutletComponentShows the projected router outlet in a dialog while one of its routes is active, and navigates back to the parent route when the dialog closes.@ng-doc/ui-kit
- MagnifierControllerComponentButtons that pan, zoom and reset an ng-doc-magnifier.@ng-doc/ui-kit
- NgDocApiListComponentThe index of API declarations: a filter that matches names and descriptions, grouping by kind or by scope, and a kind filter with counts.@ng-doc/app
- NgDocBlockquoteComponentA callout. A Markdown blockquote whose first word is a bold type name, such as Note, renders as this component.@ng-doc/ui-kit
- NgDocBooleanControlComponentThe playground control of boolean inputs: a checkbox labelled with the input name.@ng-doc/app
- NgDocBreadcrumbComponentThe breadcrumbs of a page: a navigation landmark that lists the categories above the page and marks the page itself as the current one.@ng-doc/app
- NgDocButtonComponentNgDocButtonComponent is a reusable button component with customizable properties. It can be used as a regular button, a flat button, or a text button.@ng-doc/ui-kit
- NgDocButtonIconComponentA square button that holds a single icon.@ng-doc/ui-kit
- NgDocButtonToggleComponentButton that checks its value in the host control (for example ngDocRadioGroup) when clicked, and unchecks it when clicked again.@ng-doc/ui-kit
- NgDocCheckboxComponentA checkbox control; project its label.@ng-doc/ui-kit
- NgDocClearControlComponentButton that clears the value of its host control and of the input of the surrounding input host. It is shown only while there is a value to clear.@ng-doc/ui-kit
- NgDocCodeComponentRenders a code block: a header with the file name, the language and the highlighted lines (shown when the block has a name or an icon), line numbers and a…@ng-doc/app
- NgDocComboboxComponentA select with an optional text field. Its options are an ng-doc-list in a template marked with the ngDocData directive.@ng-doc/ui-kit
- NgDocComboboxHostComponentConnects a text field, a dropdown and a list into a combobox.@ng-doc/ui-kit
- NgDocCommandPaletteComponentThe search palette: a search field with scopes (all, guides, API and actions), a list of results grouped by type (guides first, then the API), a preview of…@ng-doc/app
- NgDocCopyButtonComponentAn icon button that copies a text to the clipboard and confirms it in a tooltip. Project the icon into it.@ng-doc/app
- NgDocDataListComponentKeyboard-navigable list of options built from items.@ng-doc/ui-kit
- NgDocDataListGroupComponentData list whose options are grouped by itemGroupFn, with a header per group.@ng-doc/ui-kit
- NgDocDemoAppComponentThe root of the demo application, which shows one demo per page with only Angular and that demo loaded.@ng-doc/app
- NgDocDemoComponentRenders a demo of the page in a panel: a toolbar with Preview and source tabs, the preview width, copy and fullscreen controls, over the demo on a dot-grid…@ng-doc/app
- NgDocDemoDisplayerComponentA demo on the dot-grid stage with a copy button and a toggle that reveals its code below it (the rows of a playground use it).@ng-doc/app
- NgDocDemoFrameComponentShows a demo page of the demo application in an iframe, as tall as the demo's content: the demo page reports its height with postMessage, and only messages…@ng-doc/app
- NgDocDemoHostComponentShows the demo of a demo page: the component in the route's ngDocDemo data, with the inputs of the inputs query parameter (the JSON of the inputs option of…@ng-doc/app
- NgDocDemoPaneComponentRenders a demo of the page in front of its source files, which the reader reveals by dragging the pane's resizer.@ng-doc/app
- NgDocDotComponentA small coloured dot, for example to mark a state next to a label.@ng-doc/ui-kit
- NgDocDropdownComponentRenders its content in an overlay connected to an origin: the origin input, or the surrounding ngDocDropdownOrigin.@ng-doc/ui-kit
- NgDocExpanderComponentComponent helps to expand or collapse content@ng-doc/ui-kit
- NgDocFloatedBorderComponentNo description@ng-doc/ui-kit
- NgDocFloatedContentComponentContent that floats over the edge of its container, aligned to one side.@ng-doc/ui-kit
- NgDocFocusControlComponentSurrounds its content with two focus traps.@ng-doc/ui-kit
- NgDocFullscreenButtonComponentA link that opens a demo's fullscreen route in a new tab.@ng-doc/app
- NgDocFullscreenToggleComponentAn icon button that shows an element fullscreen with the browser Fullscreen API, or leaves fullscreen.@ng-doc/app
- NgDocHeadingAnchorComponentButton next to a heading that copies the link to the heading.@ng-doc/app
- NgDocIconComponentShows an SVG icon from the UI Kit assets or from the application's custom icons.@ng-doc/ui-kit
- NgDocImageViewerComponentWraps an image of the page: clicking it, or pressing Enter or Space on it, opens the image at its natural size, scaled down to fit the window.@ng-doc/app
- NgDocInputWrapperComponentThe frame of a text field: it draws the border and the focus state around an ngDocInputString or ngDocInputNumber input, holds content at its left and right,…@ng-doc/ui-kit
- NgDocKindIconComponentA word chip for a declaration kind (Class, Component, Type alias, ...) or a value type (string, boolean, ...), coloured by the kind.@ng-doc/app
- NgDocLabelComponentA label with a caption above its content.@ng-doc/ui-kit
- NgDocLineComponentHorizontal divider line.@ng-doc/ui-kit
- NgDocLinkComponentRouter link to a path of the application.@ng-doc/app
- NgDocListComponentKeyboard navigation for the options inside it: arrow keys move the active option and Enter selects it.@ng-doc/ui-kit
- NgDocMagnifierComponentLets the user pan its content by dragging and zoom it with the mouse wheel. Use ng-doc-magnifier-controller for buttons that do the same.@ng-doc/ui-kit
- NgDocMembersComponentThe members table of an API page in the symbol view.@ng-doc/app
- NgDocMermaidViewerComponentRenders a Mermaid graph in a zoomable, pannable viewer. The graph is rendered in the browser only, again when it changes and when the theme changes.@ng-doc/app
- NgDocNavbarComponentNavbar of the NgDoc application: the header bar above the sidebar and the page.@ng-doc/app
- NgDocNumberControlComponentThe playground control of number inputs.@ng-doc/app
- NgDocOptionComponentOption of a list. Clicking it, or pressing Enter while it is active, checks it in its host control; an option that contains a link follows the link instead.@ng-doc/ui-kit
- NgDocOptionGroupComponentGroup of options with a header. The header is hidden while the group has no options.@ng-doc/ui-kit
- NgDocOverlayContainerComponentThe default overlay container: renders the content with the pointer and the open animation.@ng-doc/ui-kit
- NgDocOverlayPointerComponentFrames overlay content and draws the arrow that points at the origin.@ng-doc/ui-kit
- NgDocPageComponentA generated page: its rendered content, the page actions (copy link, edit and view the source), the table of contents it fills in, and the outlet of its…@ng-doc/app
- NgDocPageHeaderComponentThe header of a documentation page: the rendered header HTML, or the header of an asynchronous content source.@ng-doc/app
- NgDocPageLinkComponentA link in the page content. Links inside the application navigate with the router; other links open in a new tab and, outside code, show an external-link icon.@ng-doc/app
- NgDocPageNavigationComponentLinks to the previous and the next page, as two cards at the bottom of a guide.@ng-doc/app
- NgDocPageProcessorComponentRenders HTML into its host element and replaces the nodes that the page processors (NG_DOC_PAGE_PROCESSOR, NG_DOC_PAGE_CUSTOM_PROCESSOR) select with Angular…@ng-doc/app
- NgDocPageWrapperComponentLayout of a generated page: the breadcrumbs, the page header, the tabs of a page with several routes, the page itself, the previous and next page links, and…@ng-doc/app
- NgDocPaneComponentTwo panes side by side with a resizer between them. Drag the resizer, click it or use the arrow keys on it to reveal the back pane; Enter or Space toggles it.@ng-doc/ui-kit
- NgDocPlaygroundComponentA playground: an inspector with a control per input and content slot of its target, and a demo per selector (or the pipe) rendered with the chosen values.@ng-doc/app
- NgDocPlaygroundDemoComponentOne demo of a playground: it creates the generated playground class of its selector (or pipe), passes it the form's values and shows the code of the current…@ng-doc/app
- NgDocPlaygroundPropertiesComponentThe playground inspector: the demos, and beside them (below them in a container narrower than 640px) the Recreate setting and a control per input and content…@ng-doc/app
- NgDocPlaygroundPropertyComponentOne row of the playground inspector: the input's name with its type chip, and the type control that edits it, bound to the input's form control.@ng-doc/app
- NgDocRootComponentRoot layout of the NgDoc application: the navbar, the sidebar, the page and the footer.@ng-doc/app
- NgDocSearchComponentThe search button of the navbar.@ng-doc/app
- NgDocSearchResultComponentA list of pages grouped by their type (guides and API).@ng-doc/app
- NgDocSelectionComponentHighlight that slides to the selected ngDocSelectionOrigin of the closest ngDocSelectionHost, for example the underline of the active tab or the thumb of a…@ng-doc/ui-kit
- NgDocSidebarCategoryComponentA category of the sidebar: a header row that expands and collapses the pages below it.@ng-doc/app
- NgDocSidebarComponentNo description@ng-doc/app
- NgDocSidebarItemComponentA page link in the sidebar, with the status badges of the page.@ng-doc/app
- NgDocSidenavComponentLayout with a side panel next to the projected content.@ng-doc/ui-kit
- NgDocSpinnerComponentCircular loading indicator.@ng-doc/ui-kit
- NgDocStringControlComponentThe playground control of string inputs.@ng-doc/app
- NgDocTabComponentOne tab of an ng-doc-tab-group: its label, its id and the content of its panel.@ng-doc/ui-kit
- NgDocTabGroupComponentTabs as a segmented control over one panel.@ng-doc/ui-kit
- NgDocTabRouteComponentA link of an ng-doc-tab-routes-group; the active one is underlined and marked current.@ng-doc/ui-kit
- NgDocTabRoutesGroupComponentNo description@ng-doc/ui-kit
- NgDocTabsComponentTabs of a page: grouped code blocks, or any content that Markdown wraps in <ng-doc-tab group="…" name="…"> elements.@ng-doc/app
- NgDocTagComponentA small label.@ng-doc/ui-kit
- NgDocTextComponentText with the UI Kit typography, optionally with content on its left or right side (ngDocTextLeft, ngDocTextRight).@ng-doc/ui-kit
- NgDocThemeToggleComponentButton that switches the theme in turn: Auto (follows the system), Light and Dark.@ng-doc/app
- NgDocTocComponentThe "On this page" rail: the headings of the page, the section the reader is in, the reading progress, and the Back to top, Copy link and Edit this page…@ng-doc/app
- NgDocTocElementComponentOne entry of the table of contents: a link to a heading of the page.@ng-doc/app
- NgDocToggleComponentSwitch control. It works with forms (ngModel, reactive forms, [formField]) and with host controls; the circle can be clicked or dragged.@ng-doc/ui-kit
- NgDocTypeAliasControlComponentThe playground control of union type aliases and enums: a select that shows the value (or the name of an enum member) and whether it is the default.@ng-doc/app
- NgDocWrapperComponentWraps an input and its controls; the border takes the focus color while it holds focus.@ng-doc/ui-kit
Directive 29
- NgDocAutofocusDirectiveFocuses the host when it is created, if the host can take keyboard focus.@ng-doc/ui-kit
- NgDocBaseInputBase class of the directives that turn a native input into a UI Kit control (ngDocInputString, ngDocInputNumber).@ng-doc/ui-kit
- NgDocBasePlaygroundBase class of the playground classes the builder generates, one per playground and selector.@ng-doc/app
- NgDocCheckedChangeDirectiveBinds the checked state of a native checkbox: true, false, or null for the indeterminate state.@ng-doc/ui-kit
- NgDocCodeHighlighterDirectiveRenders the given Angular HTML code, highlighted by NgDocHighlighterService, into its host element.@ng-doc/app
- NgDocCustomNavbarDirectiveDirective uses for providing custom navbar, you should mark element with this directive and the NgDocRootComponent will use it as a navbar@ng-doc/app
- NgDocCustomSidebarDirectiveDirective uses for providing custom sidebar, you should mark element with this directive and the NgDocRootComponent will use it as a sidebar@ng-doc/app
- NgDocDataDirectiveKeeps its template unrendered, so that a parent can query it (with read: TemplateRef) and render it somewhere else, for example in a dropdown.@ng-doc/ui-kit
- NgDocDropdownHandlerDirectiveOpens the dropdown on ArrowDown and closes it on Escape while the host has focus.@ng-doc/ui-kit
- NgDocDropdownOriginDirectiveNo description@ng-doc/ui-kit
- NgDocEventSwitcherDirectiveRe-dispatches the given events of the host on another element, for example the events of an overlay on its origin.@ng-doc/ui-kit
- NgDocFocusableDirectivePuts the host into the tab order (tabindex="0") or takes it out (tabindex="-1").@ng-doc/ui-kit
- NgDocFocusCatcherDirectiveTracks whether focus is inside the host element.@ng-doc/ui-kit
- NgDocFullscreenDirectiveShows its host element fullscreen with the browser Fullscreen API.@ng-doc/ui-kit
- NgDocHotkeyDirectiveEmits when a key that matches the given keyboard event properties is released anywhere in the document, except while the reader types in a field.@ng-doc/ui-kit
- NgDocInputNumberDirectiveDirective turns a native input into a control whose model is a number@ng-doc/ui-kit
- NgDocInputStringDirectiveDirective converts any input data or model to text@ng-doc/ui-kit
- NgDocMembersFilterDirectiveAdds the member tabs, the name filter and the expandable method rows to the members table of an API page.@ng-doc/app
- NgDocOptionGroupHeaderDirectiveMarks the header content of an option group.@ng-doc/ui-kit
- NgDocPaneBackDirectiveMarks the content behind an ng-doc-pane (the left side, revealed by dragging).@ng-doc/ui-kit
- NgDocPaneFrontDirectiveMarks the content in front of an ng-doc-pane (the right side).@ng-doc/ui-kit
- NgDocRadioGroupDirectiveHost control for a group of state controls (for example ng-doc-button-toggle): the group's model is the value of the checked control, so only one control is…@ng-doc/ui-kit
- NgDocRotatorDirectiveDirective rotates host with transition@ng-doc/ui-kit
- NgDocRouteActiveDirectiveAdds classes to its host element while the router URL matches a link.@ng-doc/app
- NgDocSelectionHostDirectiveTracks which of its ngDocSelectionOrigin elements is selected, so that an ng-doc-selection inside it can highlight that element.@ng-doc/ui-kit
- NgDocSelectionOriginDirectiveElement that the ng-doc-selection of the closest ngDocSelectionHost highlights while ngDocSelectionOrigin is true.@ng-doc/ui-kit
- NgDocTextLeftDirectiveUsing to display content on the left side@ng-doc/ui-kit
- NgDocTextRightDirectiveUsing to display content on the right side@ng-doc/ui-kit
- NgDocTooltipDirectiveShows its content in a tooltip while the pointer rests on the host.@ng-doc/ui-kit
Function 52
- asArrayNo description@ng-doc/core
- asBooleanNo description@ng-doc/app
- buildPlaygroundDemoPipeTemplateNo description@ng-doc/core
- buildPlaygroundDemoTemplateNo description@ng-doc/core
- capitalizeNo description@ng-doc/core
- createComponentNo description@ng-doc/app
- escapeHtmlNo description@ng-doc/core
- escapeRegexpNo description@ng-doc/core
- extractFunctionDefaultsExtracts the default values of a function parameters. It returns an array of the default values because after minification the parameter names are lost.@ng-doc/core
- extractValueNo description@ng-doc/core
- extractValueOrThrowNo description@ng-doc/core
- formatHtmlNo description@ng-doc/app
- fromSubscribeNo description@ng-doc/ui-kit
- generateTocGenerate table of contents, only for headings with id@ng-doc/app
- getAssignedInputsNo description@ng-doc/core
- getPlaygroundDemoTokenReturns the token for the given playground id.@ng-doc/app
- getTokenForTypeReturns token for type control based on provided type@ng-doc/app
- isDarkOsThemeCheck if the OS theme is dark@ng-doc/app
- isExternalLinkNo description@ng-doc/app
- isIterableNo description@ng-doc/core
- isKeyboardEventNo description@ng-doc/core
- isNodeTagNo description@ng-doc/core
- isPlaygroundPropertyNo description@ng-doc/app
- isPresentNo description@ng-doc/core
- isRouteNo description@ng-doc/core
- isSameObjectNo description@ng-doc/core
- kebabCaseNo description@ng-doc/core
- mergeOverlayConfigsNo description@ng-doc/ui-kit
- ngDocKeywordsLoaderLoads keywords from an external NgDoc documentation.@ng-doc/keywords-loaders
- ngDocKindLabelThe label a kind chip shows for a kind.@ng-doc/app
- ngDocSyntaxThemeCreates NgDoc's syntax highlighting theme: every token colour is a --ng-doc-syntax-* CSS variable, so highlighted code follows the light, dark and user themes…@ng-doc/core
- ngKeywordsLoaderLoads keywords from Angular documentation.@ng-doc/keywords-loaders
- objectKeysNo description@ng-doc/core
- observableStateNo description@ng-doc/ui-kit
- provideMainPageProcessorProvide a main processor to replace html nodes with an Angular component. Main processors are run before custom processors.@ng-doc/app
- provideMermaidProvides Mermaid instance.@ng-doc/app
- provideNgDocAppProvides the NgDoc application configuration.@ng-doc/app
- provideNgDocTitleBuilds the browser tab title of every navigation with a function that receives the categories, the page, the tab and the API declaration of the route, so…@ng-doc/app
- provideNgDocUiKitConfigProvides Base UI Kit configuration for the application root module.@ng-doc/ui-kit
- providePageProcessorProvide a processor to replace html nodes with an Angular component.@ng-doc/app
- providePageSkeletonProvides the skeleton components for the page.@ng-doc/app
- providePlaygroundDemoNo description@ng-doc/app
- provideSearchEngineProvides the NgDocSearchEngine to enable search in the documentation.@ng-doc/app
- provideTypeControlNo description@ng-doc/app
- resolvePlaygroundOptionResolves an option of a playground property.@ng-doc/app
- rxjsKeywordsLoaderNo description@ng-doc/keywords-loaders
- stringifyStringify data to JSON. If data is undefined, return string 'undefined'.@ng-doc/core
- toElementNo description@ng-doc/ui-kit
- uidNo description@ng-doc/core
- uniqueReturns only unique items from the given arrays@ng-doc/core
- validatePayloadChecks that a loaded content module has the expected shape and id.@ng-doc/app
- withNgDocContentReadyWaits for content loading and processing before returning an SSR application.@ng-doc/app
Injectable 3
- NgDocCacheInterceptorCaches GET responses of requests that opt in with the NgDocCacheInterceptor.TOKEN query parameter.@ng-doc/ui-kit
- NgDocContentAnchorControllerCoordinates one missed router anchor with the accepted asynchronous content pass.@ng-doc/app
- NgDocContentControllerOwns one body or header content source for one component instance.@ng-doc/app
Interface 96
- ConstructableNo description@ng-doc/builder
- JSDocMetadataNo description@ng-doc/core
- NgDocActionOutputNo description@ng-doc/builder
- NgDocApiNo description@ng-doc/core
- NgDocApiConfigurationThe configuration for the API pages.@ng-doc/builder
- NgDocApiListNo description@ng-doc/core
- NgDocApiListDeclarationA declaration of an API list, with the scope it belongs to.@ng-doc/app
- NgDocApiListItemNo description@ng-doc/core
- NgDocApiScopeNo description@ng-doc/core
- NgDocApplicationConfigNgDoc application config.@ng-doc/app
- NgDocAssetNo description@ng-doc/builder
- NgDocBaseDemoOptionsNo description@ng-doc/core
- NgDocBaseEntityBase interface for the NgDoc file entity@ng-doc/core
- NgDocBuildCategorySchemaNo description@ng-doc/builder
- NgDocBuilderContextNo description@ng-doc/builder
- NgDocBuilderOutputNo description@ng-doc/builder
- NgDocBuildPageSchemaThe interface describes the possible parameters for generating the page, the generator can be called by the command below 123@ng-doc/builder
- NgDocCategoryNo description@ng-doc/core
- NgDocCodeBlockParamsNo description@ng-doc/builder
- NgDocCommandPaletteDataData of the search palette dialog.@ng-doc/app
- NgDocConfigurationNgDoc configuration interface, that configure NgDoc library@ng-doc/builder
- NgDocContentFailureA content source that failed to load or to render.@ng-doc/app
- NgDocContentModuleImmutable linked HTML shared by file and virtual documentation transports.@ng-doc/core
- NgDocContentRenderFailureA failed processing pass of one content version.@ng-doc/app
- NgDocContentSourceRuntime loading boundary. Functions and request state never belong in generator caches.@ng-doc/core
- NgDocContextApplication context@ng-doc/app
- NgDocContextWithImplicitNo description@ng-doc/ui-kit
- NgDocDefaultSearchEngineOptionsOptions for the NgDocDefaultSearchEngine.@ng-doc/app
- NgDocDemoActionOptionsPossible options for demo action@ng-doc/core
- NgDocDemoApplicationConfigurationThe configuration of the demo pages.@ng-doc/builder
- NgDocDemoAssetNo description@ng-doc/app
- NgDocDemoAssetsNo description@ng-doc/app
- NgDocDialogConfigNo description@ng-doc/ui-kit
- NgDocGlobalKeywordGlobal keyword configuration.@ng-doc/core
- NgDocGuideConfigurationThe configuration for the guide page@ng-doc/builder
- NgDocHighlighterConfigShiki configuration of the code highlighter.@ng-doc/app
- NgDocHighlightPositionNo description@ng-doc/ui-kit
- NgDocInitialContentScrollIntentThe fragment of the application's first navigation, kept until a page replays or drops it.@ng-doc/app
- NgDocKeywordNo description@ng-doc/core
- NgDocKeywordsConfigurationThe configuration for the global keywords.@ng-doc/builder
- NgDocKeywordsLoaderOptionsList of possible options for the NgDoc keywords loader.@ng-doc/keywords-loaders
- NgDocListItemNo description@ng-doc/ui-kit
- NgDocMigrateToViteSchemaThe options of ng g@ng-doc/builder
- NgDocNavigationNavigation item interface@ng-doc/app
- NgDocOverlayConfigNo description@ng-doc/ui-kit
- NgDocOverlayContainerThe component an overlay renders its content in.@ng-doc/ui-kit
- NgDocOverlayHostNo description@ng-doc/ui-kit
- NgDocOverlayPropertiesNo description@ng-doc/ui-kit
- NgDocPagePage configuration interface, that should be used to describe configuration of the page@ng-doc/core
- NgDocPageAnchorNo description@ng-doc/core
- NgDocPageBreadcrumbsInterface for page breadcrumb implementation@ng-doc/app
- NgDocPageIndexInterface for a page index that builder generates.@ng-doc/core
- NgDocPageInfoNo description@ng-doc/core
- NgDocPageKeywordNo description@ng-doc/builder
- NgDocPageNavigationInterface for page navigation implementation@ng-doc/app
- NgDocPageProcessorInterface to create a processor that will be used to replace html nodes with an Angular component.@ng-doc/app
- NgDocPageSkeletonPage skeleton that should be used to create different parts of the page.@ng-doc/app
- NgDocPageTocInterface for page table of content implementation@ng-doc/app
- NgDocPathAnchorNo description@ng-doc/builder
- NgDocPlaygroundConfigPlayground configuration@ng-doc/core
- NgDocPlaygroundContentConfiguration of playground's dynamic content@ng-doc/core
- NgDocPlaygroundControlConfigPlayground control configuration@ng-doc/core
- NgDocPlaygroundFormNo description@ng-doc/app
- NgDocPlaygroundMetadataNo description@ng-doc/builder
- NgDocPlaygroundOptionAn option of a playground property that is shown by a name other than its value@ng-doc/core
- NgDocPlaygroundOptionsList of possible playground options@ng-doc/core
- NgDocPlaygroundPropertyPlayground property data@ng-doc/core
- NgDocPlaygroundPropertyControlNo description@ng-doc/app
- NgDocPositionNo description@ng-doc/ui-kit
- NgDocProcessorOptionsNo description@ng-doc/app
- NgDocProvidedTypeControlNo description@ng-doc/app
- NgDocRendererOptionsNo description@ng-doc/builder
- NgDocRepoConfigThe repository configuration interface.@ng-doc/builder
- NgDocResolvedPlaygroundOptionAn option of a playground property, resolved to the value it sets and the text it shows.@ng-doc/app
- NgDocSchemaNo description@ng-doc/builder
- NgDocScopedKeywordNo description@ng-doc/core
- NgDocSearchResultResults of a search query.@ng-doc/app
- NgDocShikiLanguageA Shiki (TextMate) language registration: a grammar and the name that code blocks use for it.@ng-doc/builder
- NgDocShikiThemeNo description@ng-doc/app
- NgDocShortcutA keyboard shortcut registered with the NgDocShortcutsService.@ng-doc/app
- NgDocSidebarItemStatusA status badge of a sidebar item, from the page's JSDoc status tag.@ng-doc/app
- NgDocSnippetNo description@ng-doc/builder
- NgDocSnippetConfigNo description@ng-doc/builder
- NgDocSubscribableNo description@ng-doc/ui-kit
- NgDocSyntaxThemeA Shiki (TextMate) syntax highlighting theme.@ng-doc/core
- NgDocSyntaxThemeRuleA TextMate token colour rule of a syntax highlighting theme.@ng-doc/core
- NgDocTabNo description@ng-doc/app
- NgDocTitleContextThe parts of the current route that provideNgDocTitle passes to its function.@ng-doc/app
- NgDocTocItemNo description@ng-doc/app
- NgDocTypeControlInterface describing Type Control.@ng-doc/app
- NgDocTypeControlProviderOptionsOptions for the type control provider@ng-doc/app
- NgDocUiConfigNo description@ng-doc/ui-kit
- NgDocViteSetupSchemaThe options of the vite-setup schematic, which ng add runs for the Vite engine.@ng-doc/builder
- NgKeywordLoaderOptionsNo description@ng-doc/keywords-loaders
- NgPageNo description@ng-doc/keywords-loaders
- ObservableStateNo description@ng-doc/ui-kit
Pipe 8
- NgDocAsArrayPipeNo description@ng-doc/ui-kit
- NgDocBindPipeNo description@ng-doc/ui-kit
- NgDocDecodeUriComponentPipeDecodes a URI component, and returns the value unchanged when it is not a valid encoding.@ng-doc/app
- NgDocExecutePipeNo description@ng-doc/ui-kit
- NgDocExtractValuePipeParses the string form of a value (for example a default value of a playground property).@ng-doc/app
- NgDocFilterByTextPipeKeeps the items that match a search term. By default an item matches when its string form equals the term.@ng-doc/app
- NgDocHighlighterPipeNo description@ng-doc/ui-kit
- NgDocSanitizeHtmlPipeMarks HTML as trusted, so it can be bound to innerHTML without sanitization. Use it only for HTML that NgDoc generated.@ng-doc/app
Type alias 62
- AbstractConstructorNo description@ng-doc/core
- BaseElementNo description@ng-doc/ui-kit
- ConstructorNo description@ng-doc/core
- ElementAnimationNo description@ng-doc/ui-kit
- FunctionTypeNo description@ng-doc/core
- InputTypeThe value an input K of T accepts.@ng-doc/core
- NgDocActionNo description@ng-doc/builder
- NgDocAngularEntityTypeNo description@ng-doc/core
- NgDocArtifactProcessorNo description@ng-doc/builder
- NgDocBlockquoteTypeNo description@ng-doc/ui-kit
- NgDocBooleanHandlerNo description@ng-doc/ui-kit
- NgDocBootstrapNo description@ng-doc/app
- NgDocBuildApiSchemaThe interface describes the possible parameters for generating the API entity, the generator can be called by the command below@ng-doc/builder
- NgDocCodeTypeNo description@ng-doc/core
- NgDocColorNo description@ng-doc/ui-kit
- NgDocCommandPaletteScopeThe scope the search palette shows results for.@ng-doc/app
- NgDocComponentAssetNo description@ng-doc/builder
- NgDocContentNo description@ng-doc/ui-kit
- NgDocContentScrollPositionRestorationNo description@ng-doc/app
- NgDocCopyButtonTextThe text a copy button copies, or a function that reads it when the button is pressed.@ng-doc/app
- NgDocDeclarationTypeNo description@ng-doc/core
- NgDocDefineValueFunctionNo description@ng-doc/ui-kit
- NgDocDemoPaneActionOptionsPossible options for demoPane action@ng-doc/core
- NgDocDemoPreviewWidthWidths the demo can be previewed at.@ng-doc/app
- NgDocDemoProvidersThe providers of the demo application, which shows isolated demos: what the module named by demoProviders in ng-doc.config.ts exports by default.@ng-doc/core
- NgDocDemoProvidersImportImports the module that provides the demo application's providers, written as () => import('./demo.providers').@ng-doc/core
- NgDocDisplayValueFunctionNo description@ng-doc/ui-kit
- NgDocExtractedValueNo description@ng-doc/core
- NgDocFormPartialValueNo description@ng-doc/app
- NgDocGroupFnNo description@ng-doc/ui-kit
- NgDocHandlerNo description@ng-doc/ui-kit
- NgDocHeadingHeading types@ng-doc/core
- NgDocHorizontalAlignHorizontal align values@ng-doc/ui-kit
- NgDocIconSizePossible icon sizes@ng-doc/ui-kit
- NgDocKeywordLanguageNo description@ng-doc/core
- NgDocKeywordsLoaderNgDoc keywords loader function, that returns a promise with the global keywords@ng-doc/core
- NgDocKeywordTypeNo description@ng-doc/core
- NgDocKindTypeNo description@ng-doc/core
- NgDocNumberHandlerNo description@ng-doc/ui-kit
- NgDocOrientationNo description@ng-doc/ui-kit
- NgDocOverlayAnimationEventNo description@ng-doc/ui-kit
- NgDocOverlayOriginNo description@ng-doc/ui-kit
- NgDocOverlayPositionNo description@ng-doc/ui-kit
- NgDocOverlayRelativePositionNo description@ng-doc/ui-kit
- NgDocPageAnchorTypeNo description@ng-doc/core
- NgDocPageInfosNo description@ng-doc/core
- NgDocPageSkeletonFieldA field of a page skeleton component.@ng-doc/app
- NgDocPageTypeNo description@ng-doc/core
- NgDocPlatformNo description@ng-doc/builder
- NgDocPlaygroundPropertiesList of playground properties, where key is't a name of property@ng-doc/core
- NgDocSizePossible sizes@ng-doc/ui-kit
- NgDocStringHandlerNo description@ng-doc/ui-kit
- NgDocStyleTypeNo description@ng-doc/core
- NgDocSupportedDeclarationNo description@ng-doc/builder
- NgDocTagSizeNo description@ng-doc/ui-kit
- NgDocTextAlignText align values@ng-doc/ui-kit
- NgDocTextColorPossible text colors@ng-doc/ui-kit
- NgDocTitleFnBuilds the browser tab title from the parts of the current route.@ng-doc/app
- NgDocTypeControlFieldA field of a type control that the playground sets: a plain field, or a signal input (input()) of the same name.@ng-doc/app
- NgDocVerticalAlignVertical align values@ng-doc/ui-kit
- RxjsVersionNo description@ng-doc/keywords-loaders
- StatedObservableNo description@ng-doc/ui-kit
Variable 57
- blockquoteProcessorNo description@ng-doc/app
- BLUR_EVENTNo description@ng-doc/ui-kit
- codeProcessorNo description@ng-doc/app
- demoPaneProcessorNo description@ng-doc/app
- demoProcessorNo description@ng-doc/app
- dropdownCloseAnimationNo description@ng-doc/ui-kit
- dropdownOpenAnimationNo description@ng-doc/ui-kit
- EMPTY_ARRAYNo description@ng-doc/core
- EMPTY_FUNCTIONNo description@ng-doc/core
- EMPTY_MAPNo description@ng-doc/core
- FOCUS_EVENTNo description@ng-doc/ui-kit
- headingAnchorProcessorNo description@ng-doc/app
- iconProcessorNo description@ng-doc/app
- imageProcessorNo description@ng-doc/app
- KEYWORD_ALLOWED_LANGUAGESNo description@ng-doc/core
- linkProcessorNo description@ng-doc/app
- membersProcessorAdds the member filter to the members table of an API page (<ng-doc-members>).@ng-doc/app
- mermaidProcessorNo description@ng-doc/app
- NG_DOC_ALWAYS_FALSE_HANDLERNo description@ng-doc/ui-kit
- NG_DOC_API_LIST_SEGMENT_DATAThe route data key that names the segment of an API entry's list data (assets/ng-doc/SEGMENT/api-list.json). An empty string is the root list.@ng-doc/app
- NG_DOC_ARROW_MARGINNo description@ng-doc/ui-kit
- NG_DOC_ASSETS_PATHNo description@ng-doc/ui-kit
- NG_DOC_COMPONENT_CONTEXTNo description@ng-doc/ui-kit
- NG_DOC_CONTENT_ANCHOR_SCROLLINGEnables one delayed anchor replay after asynchronous NgDoc content is processed.@ng-doc/app
- NG_DOC_CONTENT_SCROLL_POSITION_RESTORATIONDeclares whether delayed NgDoc content may replay a missed saved scroll position.@ng-doc/app
- NG_DOC_CONTEXTNo description@ng-doc/app
- NG_DOC_CUSTOM_ICONS_PATHNo description@ng-doc/ui-kit
- NG_DOC_DEFAULT_HANDLERNo description@ng-doc/ui-kit
- NG_DOC_DEFAULT_PAGE_PROCESSORSNo description@ng-doc/app
- NG_DOC_DEFAULT_PAGE_SKELETONNo description@ng-doc/app
- NG_DOC_DEFAULT_STRINGIFYNo description@ng-doc/ui-kit
- NG_DOC_DIALOG_DATAThe data of the dialog config, for the dialog content to inject.@ng-doc/ui-kit
- NG_DOC_DYNAMIC_SELECTORNo description@ng-doc/core
- NG_DOC_ELEMENTClass name that uses to mark tags that are generated by ng-doc and should be styled@ng-doc/core
- NG_DOC_KIND_LABELSWords the kind chips show for declaration kinds whose name is not already a readable word. Other kinds (and value types) are shown as they are.@ng-doc/app
- NG_DOC_MERMAIDNo description@ng-doc/app
- NG_DOC_PAGE_CUSTOM_PROCESSORNo description@ng-doc/app
- NG_DOC_PAGE_PROCESSORNo description@ng-doc/app
- NG_DOC_PAGE_SKELETONNo description@ng-doc/app
- NG_DOC_ROUTE_PREFIXNo description@ng-doc/app
- NG_DOC_SHIKI_THEMENo description@ng-doc/app
- NG_DOC_SHORTCUTSWhether single-key shortcuts are on for readers who have not turned them on or off themselves.@ng-doc/app
- NG_DOC_SIDEBAR_COLLAPSE_WIDTHThe widest viewport, in CSS pixels, at which the sidebar is an overlay that the navbar's menu button opens.@ng-doc/app
- NG_DOC_STORE_SHORTCUTS_KEYThe local storage key that keeps a reader's choice to turn single-key shortcuts on ("1") or off ("0").@ng-doc/app
- NG_DOC_STORE_THEME_KEYNo description@ng-doc/app
- NG_DOC_SYNTAX_THEME_NAMEThe name of NgDoc's syntax highlighting theme.@ng-doc/core
- NG_DOC_TYPE_CONTROLNo description@ng-doc/app
- NG_REQUEST_BASE_PATHNo description@ng-doc/ui-kit
- NgDocAngularEntitiesNo description@ng-doc/core
- NgDocDeclarationsNo description@ng-doc/core
- notificationCloseAnimationNo description@ng-doc/ui-kit
- notificationOpenAnimationNo description@ng-doc/ui-kit
- playgroundProcessorNo description@ng-doc/app
- tabsProcessorTurns the <ng-doc-tab group="…" name="…"> elements of a page into tabs: every tab of a group becomes one NgDocTabsComponent, where the first tab of the group…@ng-doc/app
- tooltipCloseAnimationNo description@ng-doc/ui-kit
- tooltipOpenAnimationNo description@ng-doc/ui-kit
- tooltipProcessorWraps an element with an ngDocTooltip attribute in a component that shows the attribute's value as a tooltip.@ng-doc/app