NgDocPage
Extends: |
|
Page configuration interface, that should be used to describe configuration of the page
Properties
Name | Type | Description |
---|---|---|
category |
| The page category |
data | unknown | Any custom data that you can provide for the page and use on it via |
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 |
imports | (readonly any[] | | 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
| number | undefined | Order is using for sorting entities in the sidebar |
playgrounds | Record<string, | The page playgrounds should be on object where key it's the playground's name and value its playground configuration |
providers |
| List of providers for the page they will be available for all components on the page |
route inherited from
| string | | The route of the entity (current sourceFileFolder name by default) |
title inherited from
| string | The entity title |