Getting Started
Writing content
API Documentation
Customization
Recipes
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.