Class Input

dash/dcc/Input.py:24–408

An Input component. Keyword arguments: - value (string | number; optional): The value of the input. - type (a value equal to: None, 'text', 'number', 'password', 'email', 'range', 'search', 'tel', 'url', 'hidden'; default HTMLInputTypes.text): The type of control to r

class Input(Component):
    """An Input component.


    Keyword arguments:

    - value (string | number; optional):
        The value of the input.

    - type (a value equal to: None, 'text', 'number', 'password', 'email', 'range', 'search', 'tel', 'url', 'hidden'; default HTMLInputTypes.text):
        The type of control to render.

    - debounce (number | boolean; default False):
        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 send
        the value back on every change. If a number, it will not send
        anything back to the Dash server until the user has stopped typing
        for that number of seconds.

    - placeholder (string | number; optional):
        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 <label>
        element, their purposes are different. The <label> attribute
        describes the role of the form element (i.e. it indicates what
        kind of information is expected), and the placeholder attribute is
        a hint about the format that the content should take. There are
        cases in which the placeholder attribute is never displayed to the
        user, so the form must be understandable without it.

    - n_submit (number; default 0):
        Number of times the `Enter` key was pressed while the input had
        focus.

    - n_submit_timestamp (number; default -1):
        Last time that `Enter` was pressed.

    - inputMode (a value equal to: None, 'verbatim', 'latin', 'latin-name', 'latin-prose', 'full-width-latin', 'kana', 'katakana', 'numeric', 'tel', 'email', 'url'; default 'verbatim'):
        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.

    - autoComplete (string; default 'off'):
        This attribute indicates whether the value of the control can be
        automatically completed by the browser.

    - readOnly (boolean; optional):
        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.

    - required (boolean; optional):
        This attribute specifies that the user must fill in a value before
        submitting a form. It cannot be used when the type attribute is