NgDoc

What is NgDoc? Installation SSR Configuration NEW OPTIONS Migrations
Pages and categories UPDATED Blockquotes NEW STYLES Images and embeds NEW Code blocks Mermaid diagrams NEW Nunjucks Demo and Demo Pane Playground Keywords
Auto generation Documenting declarations Rendering API NEW
Page Processors Page Skeleton Layout Search Themes UPDATED Icons
Performance Ignoring file lines
API References Develop
@ng-doc/app / Interface

NgDocPageProcessor

Generic types:T

Interface to create a processor that will be used to replace html nodes with an Angular component.

Properties

NameTypeDescription
component
Type<T>

Target component to replace html nodes with.

extractOptions
(element: Element, root: HTMLElement) => NgDocProcessorOptions<T, keyof T>

Extract options for Angular component from html node.

nodeToReplace
((element: Element, injector: Injector) => Element) | undefined

Can be used to find a node to replace instead of the node that was found by selector.

selector
string

Selector to find html nodes to replace.

MIT © 2023 Aleksandr Skoropad