Textarea (Dash.NET)

Dash.NET

Documentation for 0.2.0-alpha.5

Textarea Module

Namespace: Dash.NET.DCC
Assembly: Dash.NET.dll

A basic HTML textarea for entering multiline text.

Types

Type	Description
Attr	A list of children or a property for this dash component
Prop	• 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.
Textarea	A basic HTML textarea for entering multiline text.

Functions and values

Function or value Description

Function or value	Description
`Textarea.textarea id attrs` Full Usage: `Textarea.textarea id attrs` Parameters: id : `string` attrs : `Attr list` Returns: `DashComponent`	A basic HTML textarea for entering multiline text. Properties: • id (string) - The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app. • 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. id : `string` attrs : `Attr list` Returns: `DashComponent`


                
                  
                    
                      Textarea.textarea id attrs

Full Usage: Textarea.textarea id attrs

Parameters:

id : string

attrs : Attr list

Returns: DashComponent

A basic HTML textarea for entering multiline text. Properties: • id (string) - The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app. • 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.

id : string
attrs : Attr list

Returns: DashComponent