dbcForm: Form component

Description Usage Arguments Value

View source: R/dashBootstrapComponents.R

Description

The Form component can be used to organise collections of input components and apply consistent styling.

Usage

1
2
3
4
dbcForm(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, action=NULL, method=NULL,
n_submit=NULL, n_submit_timestamp=NULL,
prevent_default_on_submit=NULL, loading_state=NULL)

Arguments

children

A list of or a singular dash component, string or number. The children of this component

id

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

style

Named list. Defines CSS styles which will override styles previously set.

class_name

Character. Often used with CSS to style elements with common properties.

className

Character. **DEPRECATED** Use 'class_name' instead.

Often used with CSS to style elements with common properties.

key

Character. A unique identifier for the component, used to improve performance by React.js while rendering components See https://reactjs.org/docs/lists-and-keys.html for more info

action

Character. The URI of a program that processes the information submitted via the form.

method

A value equal to: 'get', 'post'. Defines which HTTP method to use when submitting the form. Can be GET (default) or POST.

n_submit

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

n_submit_timestamp

Numeric. Last time that 'Enter' was pressed.

prevent_default_on_submit

Logical. The form calls preventDefault on submit events. If you want form data to be posted to the endpoint specified by 'action' on submit events, set prevent_default_on_submit to False. Defaults to True.

loading_state

Lists containing elements 'is_loading', 'prop_name', 'component_name'. those elements have the following types: - is_loading (logical; optional): determines if the component is loading or not - prop_name (character; optional): holds which property is loading - component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer

Value

named list of JSON elements corresponding to React.js properties and their values


dash documentation built on Nov. 7, 2021, 9:06 a.m.