Declare a form field — el_form_field • shiny.element

Declare a form field

Usage

el_form_field(
  prop,
  type = "input",
  label = NULL,
  value = NULL,
  choices = NULL,
  rules = NULL,
  report = FALSE,
  button = FALSE,
  border = NULL,
  ...
)

Arguments

prop: Field name. Keys the form's model and is what el_rule()s and validation messages refer to.
type: Control type: one of "input", "textarea", "password", "input-number", "select", "radio-group", "checkbox-group", "checkbox" (one box, TRUE or FALSE), "switch", "slider", "date-picker", "time-picker", "time-select", "rate", "cascader", "cascader-panel", "color-picker", "autocomplete", "transfer", "select-v2", "segmented", "input-tag", "mention" or "mention-textarea". Their props go in ...: a cascader's options, a transfer's data.
label: Label text.
value: Initial value. Defaults to the type's empty value, which is also what resetFields() restores.
choices: Options for "select", "radio-group" and "checkbox-group"; suggestions for "autocomplete", filtered as the user types. A named vector c(Label = value) or a list of list(value=, label=). For "checkbox", the box's text is label.
rules: A single el_rule() or a list of them.
report: Whether the field also reports its value on load and on every change, as input$<form id>_<prop>, as a standalone input would – for a control that changes the page, such as a size switch. The form's own input$<form id> still waits for a submit. A field added later by update_el_form()(fields =) reports with the submit only.
button, border: For "radio-group" and "checkbox-group": draw the choices as buttons (el-radio-button, el-checkbox-button), or as boxes with a border.
...: Further props. Element's form-item props – required, error, label_width, label_position, size, show_message, inline_message, validate_status, for, and label_html/error_html for markup of your own, a string or htmltools tags – go on the field's form item; anything else on the control, e.g. placeholder, min, max, disabled. Names are converted to camelCase.

Value

A field declaration, for el_form().

Examples

el_form_field(
  "name",
  "input",
  label = "Name",
  rules = el_rule(required = TRUE, message = "Required")
)
#> $prop
#> [1] "name"
#> 
#> $label
#> [1] "Name"
#> 
#> $tag
#> [1] "el-input"
#> 
#> $props
#> list()
#> 
#> $value
#> [1] ""
#> 
#> $rules
#> $rules[[1]]
#> $rules[[1]]$required
#> [1] TRUE
#> 
#> $rules[[1]]$message
#> [1] "Required"
#> 
#> $rules[[1]]$trigger
#> [1] "blur"
#> 
#> 
#> 
el_form_field(
  "age",
  "input-number",
  label = "Age",
  value = 18,
  min = 0,
  max = 150
)
#> $prop
#> [1] "age"
#> 
#> $label
#> [1] "Age"
#> 
#> $tag
#> [1] "el-input-number"
#> 
#> $props
#> $props$min
#> [1] 0
#> 
#> $props$max
#> [1] 150
#> 
#> 
#> $value
#> [1] 18
#> 
#> $rules
#> NULL
#> 
el_form_field(
  "city",
  "select",
  label = "City",
  choices = c(Beijing = "bj", Shanghai = "sh")
)
#> $prop
#> [1] "city"
#> 
#> $label
#> [1] "City"
#> 
#> $tag
#> [1] "el-select"
#> 
#> $props
#> list()
#> 
#> $value
#> [1] ""
#> 
#> $rules
#> NULL
#> 
#> $optionTag
#> [1] "el-option"
#> 
#> $options
#> $options[[1]]
#> $options[[1]]$label
#> [1] "Beijing"
#> 
#> $options[[1]]$value
#> [1] "bj"
#> 
#> $options[[1]]$text
#> [1] ""
#> 
#> 
#> $options[[2]]
#> $options[[2]]$label
#> [1] "Shanghai"
#> 
#> $options[[2]]$value
#> [1] "sh"
#> 
#> $options[[2]]$text
#> [1] ""
#> 
#> 
#>