Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/core / Interface

NgDocPage

Page configuration interface, that should be used to describe configuration of the page

Properties

NameTypeDescription
category
NgDocCategory | undefined

The page category

data
unknown

Any custom data that you can provide for the page and use on it via NgDocPage.data

demos
Record<string, any> | undefined

The page demo components should be on object where key it's the component's class name and value it's class constructor

disableFullscreenRoutes
boolean | undefined

By default, the child routes of a page are shown in a fullscreen dialog. Set disableFullscreenRoutes to false to handle them yourself with a . It can be used for example in a demo that requires to show nested routes. Be careful however, only 1 router-outlet is allowed level, that can lead to collisions if multiple demos on the same page require nested routes.

hidden
inherited from NgDocBaseEntity
boolean | undefined

If true the page will be hidden from the sidebar

imports
(readonly any[] | Type<any>)[] | undefined

Import Angular dependencies for the page. If you are using standalone components for demos and playgrounds, you don't need to import anything.

mdFile
string | string[]

Path to the page markdown file

onlyForTags
string[] | undefined

Render the page only for specific build configuration

order
inherited from NgDocBaseEntity
number | undefined

Order is using for sorting entities in the sidebar

playgrounds
Record<string, NgDocPlaygroundConfig> | undefined

The page playgrounds should be on object where key it's the playground's name and value its playground configuration

providers
Provider[] | undefined

List of providers for the page they will be available for all components on the page

route
inherited from NgDocBaseEntity
string | Route | undefined

The route of the entity (current sourceFileFolder name by default)

title
inherited from NgDocBaseEntity
string

The entity title