Prop (Dash.NET)

Dash.NET

Documentation for 0.2.0-alpha.5

Textarea.Prop Type

Namespace: Dash.NET.DCC
Assembly: Dash.NET.dll
Parent Module: Textarea
Base Type: obj
All Interfaces: IEquatable<Prop> , IStructuralEquatable

• value (string) - The value of the textarea • autoFocus (string) - The element should be automatically focused after the page loaded. • cols (string | number) - Defines the number of columns in a textarea. • disabled (string | boolean) - Indicates whether the user can interact with the element. • form (string) - Indicates the form that is the owner of the element. • maxLength (string | number) - Defines the maximum number of characters allowed in the element. • minLength (string | number) - Defines the minimum number of characters allowed in the element. • name (string) - Name of the element. For example used by the server to identify the fields in form submits. • placeholder (string) - Provides a hint to the user of what can be entered in the field. • readOnly (boolean | value equal to: 'readOnly', 'readonly', 'READONLY') - Indicates whether the element can be edited. readOnly is an HTML boolean attribute - it is enabled by a boolean or 'readOnly'. Alternative capitalizations `readonly` & `READONLY` are also acccepted. • required (value equal to: 'required', 'REQUIRED' | boolean) - Indicates whether this element is required to fill out or not. required is an HTML boolean attribute - it is enabled by a boolean or 'required'. Alternative capitalizations `REQUIRED` are also acccepted. • rows (string | number) - Defines the number of rows in a text area. • wrap (string) - Indicates whether the text should be wrapped. • accessKey (string) - Defines a keyboard shortcut to activate or add focus to the element. • className (string) - Often used with CSS to style elements with common properties. • contentEditable (string | boolean) - Indicates whether the element's content is editable. • contextMenu (string) - Defines the ID of a

element which will serve as the element's context menu. • dir (string) - Defines the text direction. Allowed values are ltr (Left-To-Right) or rtl (Right-To-Left) • draggable (value equal to: 'true', 'false' | boolean) - Defines whether the element can be dragged. • hidden (string) - Prevents rendering of given element, while keeping child elements, e.g. script elements, active. • lang (string) - Defines the language used in the element. • spellCheck (value equal to: 'true', 'false' | boolean) - Indicates whether spell checking is allowed for the element. • style (record) - Defines CSS styles which will override styles previously set. • tabIndex (string | number) - Overrides the browser's default tab order and follows the one specified instead. • title (string) - Text to be displayed in a tooltip when hovering over the element. • n_blur (number; default 0) - Number of times the textarea lost focus. • n_blur_timestamp (number; default -1) - Last time the textarea lost focus. • n_clicks (number; default 0) - Number of times the textarea has been clicked. • n_clicks_timestamp (number; default -1) - Last time the textarea was clicked. • loading_state (record with the fields: 'is_loading: boolean (optional)', 'prop_name: string (optional)', 'component_name: string (optional)') - Object that holds the loading state object coming from dash-renderer • persistence (boolean | string | number) - Used to allow user interactions in this component to be persisted when the component - or the page - is refreshed. If `persisted` is truthy and hasn't changed from its previous value, a `value` that the user has changed while using the app will keep that change, as long as the new `value` also matches what was given originally. Used in conjunction with `persistence_type`. • persisted_props (list with values of type: value equal to: 'value'; default ['value']) - Properties whose user interactions will persist after refreshing the component or the page. Since only `value` is allowed this prop can normally be ignored. • persistence_type (value equal to: 'local', 'session', 'memory'; default local) - Where persisted user changes will be stored: memory: only kept in memory, reset on page refresh. local: window.localStorage, data is kept after the browser quit. session: window.sessionStorage, data is cleared once the browser quit.

Union cases

Union case	Description
`AccessKey string` Full Usage: `AccessKey string` Parameters: Item : `string`	Item : `string`
`AutoFocus string` Full Usage: `AutoFocus string` Parameters: Item : `string`	Item : `string`
`ClassName string` Full Usage: `ClassName string` Parameters: Item : `string`	Item : `string`
`Cols int` Full Usage: `Cols int` Parameters: Item : `int`	Item : `int`
`ContentEditable bool` Full Usage: `ContentEditable bool` Parameters: Item : `bool`	Item : `bool`
`ContextMenu string` Full Usage: `ContextMenu string` Parameters: Item : `string`	Item : `string`
`Dir string` Full Usage: `Dir string` Parameters: Item : `string`	Item : `string`
`Disabled bool` Full Usage: `Disabled bool` Parameters: Item : `bool`	Item : `bool`
`Draggable bool` Full Usage: `Draggable bool` Parameters: Item : `bool`	Item : `bool`
`Form string` Full Usage: `Form string` Parameters: Item : `string`	Item : `string`
`Hidden string` Full Usage: `Hidden string` Parameters: Item : `string`	Item : `string`
`Lang string` Full Usage: `Lang string` Parameters: Item : `string`	Item : `string`
`LoadingState LoadingState` Full Usage: `LoadingState LoadingState` Parameters: Item : `LoadingState`	Item : `LoadingState`
`MaxLength int` Full Usage: `MaxLength int` Parameters: Item : `int`	Item : `int`
`MinLength int` Full Usage: `MinLength int` Parameters: Item : `int`	Item : `int`
`NBlur IConvertible` Full Usage: `NBlur IConvertible` Parameters: Item : `IConvertible`	Item : `IConvertible`
`NBlurTimestamp IConvertible` Full Usage: `NBlurTimestamp IConvertible` Parameters: Item : `IConvertible`	Item : `IConvertible`
`NClicks IConvertible` Full Usage: `NClicks IConvertible` Parameters: Item : `IConvertible`	Item : `IConvertible`
`NClicksTimestamp IConvertible` Full Usage: `NClicksTimestamp IConvertible` Parameters: Item : `IConvertible`	Item : `IConvertible`
`Name string` Full Usage: `Name string` Parameters: Item : `string`	Item : `string`
`PersistedProps string[]` Full Usage: `PersistedProps string[]` Parameters: Item : `string[]`	Item : `string[]`
`Persistence IConvertible` Full Usage: `Persistence IConvertible` Parameters: Item : `IConvertible`	Item : `IConvertible`
`PersistenceType PersistenceTypeOptions` Full Usage: `PersistenceType PersistenceTypeOptions` Parameters: Item : `PersistenceTypeOptions`	Item : `PersistenceTypeOptions`
`Placeholder string` Full Usage: `Placeholder string` Parameters: Item : `string`	Item : `string`
`ReadOnly bool` Full Usage: `ReadOnly bool` Parameters: Item : `bool`	Item : `bool`
`Required bool` Full Usage: `Required bool` Parameters: Item : `bool`	Item : `bool`
`Rows int` Full Usage: `Rows int` Parameters: Item : `int`	Item : `int`
`SpellCheck bool` Full Usage: `SpellCheck bool` Parameters: Item : `bool`	Item : `bool`
`Style obj` Full Usage: `Style obj` Parameters: Item : `obj`	Item : `obj`
`TabIndex IConvertible` Full Usage: `TabIndex IConvertible` Parameters: Item : `IConvertible`	Item : `IConvertible`
`Title string` Full Usage: `Title string` Parameters: Item : `string`	Item : `string`
`Value string` Full Usage: `Value string` Parameters: Item : `string`	Item : `string`
`Wrap string` Full Usage: `Wrap string` Parameters: Item : `string`	Item : `string`

Static members

Static member	Description
`Prop.convert` Full Usage: `Prop.convert` Returns: `Prop -> obj`	Returns: `Prop -> obj`
`Prop.toDynamicMemberDef prop` Full Usage: `Prop.toDynamicMemberDef prop` Parameters: prop : `Prop` Returns: `string * obj`	prop : `Prop` Returns: `string * obj`
`Prop.toPropName` Full Usage: `Prop.toPropName` Returns: `Prop -> string`	Returns: `Prop -> string`