error_args: Shared error-state arguments (internal)
In shinyGovstyle: Custom Gov Style Inputs for Shiny

error_args

R Documentation

Shared error-state arguments (internal)

Description

Documentation-only function. Holds the canonical ⁠@param⁠ entries for the pair of params that describe an input's error state (error, error_message), inherited by functions via ⁠@inheritParams⁠. Used by components whose label/hint_label docs are instead covered by control_label_params, to avoid documenting hint_label twice.

Usage

error_args(error, error_message)

Arguments

`error`	If `TRUE`, render the component in its error state and reserve a slot for the error message. Defaults to `FALSE`.
`error_message`	Text shown when `error` is `TRUE`. Defaults to `NULL`.