Input.Attr Type

A list of children or a property for this dash component

Union cases

Union case Description

Children DashComponent list

Full Usage: Children DashComponent list

Parameters:
Item : DashComponent list

Prop Prop

Full Usage: Prop Prop

Parameters:
Item : Prop

Static members

Static member Description

Attr.autoComplete p

Full Usage: Attr.autoComplete p

Parameters:
    p : string

Returns: Attr

This attribute indicates whether the value of the control can be automatically completed by the browser.

p : string
Returns: Attr

Attr.autoFocus p

Full Usage: Attr.autoFocus p

Parameters:
    p : bool

Returns: Attr

The element should be automatically focused after the page loaded. autoFocus is an HTML boolean attribute - it is enabled by a boolean or 'autoFocus'. Alternative capitalizations `autofocus` & `AUTOFOCUS` are also acccepted.

p : bool
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
Returns: Attr

The child or children of this dash component

value : seq<DashComponent>
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
Returns: Attr

The child or children of this dash component

value : DashComponent list
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
Returns: Attr

The child or children of this dash component

value : DashComponent
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
Returns: Attr

The child or children of this dash component

value : Guid
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
    value : float

Returns: Attr

The child or children of this dash component

value : float
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
    value : string

Returns: Attr

The child or children of this dash component

value : string
Returns: Attr

Attr.children value

Full Usage: Attr.children value

Parameters:
    value : int

Returns: Attr

The child or children of this dash component

value : int
Returns: Attr

Attr.className p

Full Usage: Attr.className p

Parameters:
    p : string

Returns: Attr

The class of the input element

p : string
Returns: Attr

Attr.debounce p

Full Usage: Attr.debounce p

Parameters:
    p : bool

Returns: Attr

If true, changes to input will be sent back to the Dash server only on enter or when losing focus. If it's false, it will sent the value back on every change.

p : bool
Returns: Attr

Attr.disabled p

Full Usage: Attr.disabled p

Parameters:
    p : bool

Returns: Attr

If true, the input is disabled and can't be clicked on. disabled is an HTML boolean attribute - it is enabled by a boolean or 'disabled'. Alternative capitalizations `DISABLED`

p : bool
Returns: Attr

Attr.inputType p

Full Usage: Attr.inputType p

Parameters:
Returns: Attr

The type of control to render.

p : InputType
Returns: Attr

Attr.list p

Full Usage: Attr.list p

Parameters:
    p : string

Returns: Attr

Identifies a list of pre-defined options to suggest to the user. The value must be the id of a element in the same document. The browser displays only options that are valid values for this input element. This attribute is ignored when the type attribute's value is hidden, checkbox, radio, file, or a button type.

p : string
Returns: Attr

Attr.loadingState p

Full Usage: Attr.loadingState p

Parameters:
Returns: Attr

Object that holds the loading state object coming from dash-renderer

p : LoadingState
Returns: Attr

Attr.max p

Full Usage: Attr.max p

Parameters:
Returns: Attr

The maximum (numeric or date-time) value for this item, which must not be less than its minimum (min attribute) value.

p : IConvertible
Returns: Attr

Attr.maxLength p

Full Usage: Attr.maxLength p

Parameters:
Returns: Attr

If the value of the type attribute is text, email, search, password, tel, or url, this attribute specifies the maximum number of characters (in UTF-16 code units) that the user can enter. For other control types, it is ignored. It can exceed the value of the size attribute. If it is not specified, the user can enter an unlimited number of characters. Specifying a negative number results in the default behavior (i.e. the user can enter an unlimited number of characters). The constraint is evaluated only when the value of the attribute has been changed.

p : IConvertible
Returns: Attr

Attr.min p

Full Usage: Attr.min p

Parameters:
Returns: Attr

The minimum (numeric or date-time) value for this item, which must not be greater than its maximum (max attribute) value.

p : IConvertible
Returns: Attr

Attr.minLength p

Full Usage: Attr.minLength p

Parameters:
Returns: Attr

If the value of the type attribute is text, email, search, password, tel, or url, this attribute specifies the minimum number of characters (in Unicode code points) that the user can enter. For other control types, it is ignored.

p : IConvertible
Returns: Attr

Attr.mode p

Full Usage: Attr.mode p

Parameters:
Returns: Attr

Provides a hint to the browser as to the type of data that might be entered by the user while editing the element or its contents.

p : InputMode
Returns: Attr

Attr.multiple p

Full Usage: Attr.multiple p

Parameters:
    p : bool

Returns: Attr

This Boolean attribute indicates whether the user can enter more than one value. This attribute applies when the type attribute is set to email or file, otherwise it is ignored.

p : bool
Returns: Attr

Attr.nBlur p

Full Usage: Attr.nBlur p

Parameters:
Returns: Attr

Number of times the input lost focus.

p : IConvertible
Returns: Attr

Attr.nBlurTimestamp p

Full Usage: Attr.nBlurTimestamp p

Parameters:
Returns: Attr

Last time the input lost focus.

p : IConvertible
Returns: Attr

Attr.nSubmit p

Full Usage: Attr.nSubmit p

Parameters:
Returns: Attr

Number of times the `Enter` key was pressed while the input had focus.

p : IConvertible
Returns: Attr

Attr.nSubmitTimestamp p

Full Usage: Attr.nSubmitTimestamp p

Parameters:
Returns: Attr

Last time that `Enter` was pressed.

p : IConvertible
Returns: Attr

Attr.name p

Full Usage: Attr.name p

Parameters:
    p : string

Returns: Attr

The name of the control, which is submitted with the form data.

p : string
Returns: Attr

Attr.pattern p

Full Usage: Attr.pattern p

Parameters:
    p : string

Returns: Attr

A regular expression that the control's value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is text, search, tel, url, email, or password, otherwise it is ignored. The regular expression language is the same as JavaScript RegExp algorithm, with the 'u' parameter that makes it treat the pattern as a sequence of unicode code points. The pattern is not surrounded by forward slashes.

p : string
Returns: Attr

Attr.persistedProps p

Full Usage: Attr.persistedProps p

Parameters:
    p : string[]

Returns: Attr

Properties whose user interactions will persist after refreshing the component or the page. Since only `value` is allowed this prop can normally be ignored.

p : string[]
Returns: Attr

Attr.persistence p

Full Usage: Attr.persistence p

Parameters:
Returns: Attr

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`.

p : IConvertible
Returns: Attr

Attr.persistenceType p

Full Usage: Attr.persistenceType p

Parameters:
Returns: Attr

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.

p : PersistenceTypeOptions
Returns: Attr

Attr.placeholder p

Full Usage: Attr.placeholder p

Parameters:
Returns: Attr

A hint to the user of what can be entered in the control . The placeholder text must not contain carriage returns or line-feeds. Note: Do not use the placeholder attribute instead of a

p : IConvertible
Returns: Attr

Attr.readOnly p

Full Usage: Attr.readOnly p

Parameters:
    p : bool

Returns: Attr

This attribute indicates that the user cannot modify the value of the control. The value of the attribute is irrelevant. If you need read-write access to the input value, do not add the "readonly" attribute. It is ignored if the value of the type attribute is hidden, range, color, checkbox, radio, file, or a button type (such as button or submit). readOnly is an HTML boolean attribute - it is enabled by a boolean or 'readOnly'. Alternative capitalizations `readonly` & `READONLY` are also acccepted.

p : bool
Returns: Attr

Attr.required p

Full Usage: Attr.required p

Parameters:
    p : bool

Returns: Attr

This attribute specifies that the user must fill in a value before submitting a form. It cannot be used when the type attribute is hidden, image, or a button type (submit, reset, or button). The :optional and :required CSS pseudo-classes will be applied to the field as appropriate. required is an HTML boolean attribute - it is enabled by a boolean or 'required'. Alternative capitalizations `REQUIRED` are also acccepted.

p : bool
Returns: Attr

Attr.selectionDirection p

Full Usage: Attr.selectionDirection p

Parameters:
    p : string

Returns: Attr

The direction in which selection occurred. This is "forward" if the selection was made from left-to-right in an LTR locale or right-to-left in an RTL locale, or "backward" if the selection was made in the opposite direction. On platforms on which it's possible this value isn't known, the value can be "none"; for example, on macOS, the default direction is "none", then as the user begins to modify the selection using the keyboard, this will change to reflect the direction in which the selection is expanding.

p : string
Returns: Attr

Attr.selectionEnd p

Full Usage: Attr.selectionEnd p

Parameters:
    p : string

Returns: Attr

The offset into the element's text content of the last selected character. If there's no selection, this value indicates the offset to the character following the current text input cursor position (that is, the position the next character typed would occupy).

p : string
Returns: Attr

Attr.selectionStart p

Full Usage: Attr.selectionStart p

Parameters:
    p : string

Returns: Attr

The offset into the element's text content of the first selected character. If there's no selection, this value indicates the offset to the character following the current text input cursor position (that is, the position the next character typed would occupy).

p : string
Returns: Attr

Attr.size p

Full Usage: Attr.size p

Parameters:
    p : string

Returns: Attr

The initial size of the control. This value is in pixels unless the value of the type attribute is text or password, in which case it is an integer number of characters. Starting in, this attribute applies only when the type attribute is set to text, search, tel, url, email, or password, otherwise it is ignored. In addition, the size must be greater than zero. If you do not specify a size, a default value of 20 is used.' simply states "the user agent should ensure that at least that many characters are visible", but different characters can have different widths in certain fonts. In some browsers, a certain string with x characters will not be entirely visible even if size is defined to at least x.

p : string
Returns: Attr

Attr.spellCheck p

Full Usage: Attr.spellCheck p

Parameters:
Returns: Attr

Setting the value of this attribute to true indicates that the element needs to have its spelling and grammar checked. The value default indicates that the element is to act according to a default behavior, possibly based on the parent element's own spellcheck value. The value false indicates that the element should not be checked.

p : SpellCheckOptions
Returns: Attr

Attr.step p

Full Usage: Attr.step p

Parameters:
Returns: Attr

Works with the min and max attributes to limit the increments at which a numeric or date-time value can be set. It can be the string any or a positive floating point number. If this attribute is not set to any, the control accepts only values at multiples of the step value greater than the minimum.

p : IConvertible
Returns: Attr

Attr.style p

Full Usage: Attr.style p

Parameters:
Returns: Attr

The input's inline styles

p : seq<Style>
Returns: Attr

Attr.value p

Full Usage: Attr.value p

Parameters:
Returns: Attr

The value of the input

p : IConvertible
Returns: Attr