Skip to content
@ng-doc/core / Interface

NgDocDemoActionOptions

Possible options for demo action

Extends
NgDocBaseDemoOptions
DeclarationTypeScript
export interface NgDocDemoActionOptions extends NgDocBaseDemoOptions { … }

Members

Properties

7
class?: string | string[] | undefined
inherited from NgDocBaseDemoOptions

Class name that should be added to the container

container?: boolean | undefined

Display demo in the container (true by default)

defaultTab?: string | undefined
inherited from NgDocBaseDemoOptions

Tab name that should be opened by default

expanded?: boolean | undefined
inherited from NgDocBaseDemoOptions

Opens the demo on its code (false by default): a demo starts on a source file instead of the preview (the opened snippet, then defaultTab, then the first file), and a demoPane starts with its code expanded.

fullscreenRoute?: string | undefined
inherited from NgDocBaseDemoOptions

A child route of the page (see route.children of NgDocPage). When set, a link that opens the route in a new tab replaces the demo; the route opens as a standalone page that shows only the routed component.

inputs?: Record<string, unknown> | undefined
inherited from NgDocBaseDemoOptions

Specifies input values for the demo that will be set to demo component. These values will be used only once, when the demo is rendered.

tabs?: string | string[] | undefined
inherited from NgDocBaseDemoOptions

List of tabs that should be displayed if they are not empty and exist

Symbol
Kind
Interface
Extends
NgDocBaseDemoOptions
Scope
@ng-doc/core
Edit this page