Skip to content
@ng-doc/app / Interface

NgDocTypeControlProviderOptions

Options for the type control provider

DeclarationTypeScript
export interface NgDocTypeControlProviderOptions { … }

Members

Properties

4
cloneable?: boolean | undefined

Whether the control's values can be sent to an isolated playground's iframe, which gets them in its URL: plain data only (strings, numbers, booleans, null, undefined, dates, arrays and plain objects of those). false makes a playground with an input of this control render in the page, with a note. Left out, each value is checked when it changes, and the first one that can't be sent does the same.

hideLabel?: boolean | undefined

Allows to hide the label of the type control, if the label is not needed or if you want to use a custom label

labelWrapper?: boolean | undefined

Whether the row of the control is a <label> that wraps the control (the default). A label forwards clicks on its content to the first form control inside it, which a control with several interactive parts, such as a list or a dialog, doesn't want. With false, the row is a <div> whose caption names the control through aria-labelledby.

order?: number | undefined

You can use this to change the order of the type control. Controls are sorted by ascending order, and controls without an order come last. NgDoc's own controls use 10 (type aliases), 20 (string), 30 (number), 40 (boolean), 50 (string[], number[] and arrays of a union, NgDocTypeAlias[]) and 60 (other arrays)

Symbol
Kind
Interface
Scope
@ng-doc/app
Edit this page