Skip to contents

Create a TextArea component

Usage

calcite_text_area(...)

Arguments

...

named attributes passed to htmltools::tag()

Value

an object of class calcite_component which is a subclass of shiny.tag

Details

Properties

The following properties are provided by this component:

NameAttributeDescriptionValuesReflects to Attribute
columnscolumnsSpecifies the component's number of columns.numberTRUE
disableddisabledWhen true, interaction is prevented and the component is displayed with lower opacity.booleanTRUE
formformThe id of the form that will be associated with the component. When not set, the component will be associated with its ancestor form element, if any.stringTRUE
groupSeparatorgroup-separatorWhen true, number values are displayed with a group separator corresponding to the language and country format.booleanTRUE
labellabelAccessible name for the component.stringFALSE
limitTextlimit-textCheck API referencebooleanTRUE
maxLengthmax-lengthWhen the component resides in a form, specifies the maximum number of characters allowed.numberTRUE
messageOverridesNAUse this property to override individual strings used by the component.Check API referenceFALSE
minLengthmin-lengthWhen the component resides in a form, specifies the minimum number of characters allowed.numberTRUE
namenameSpecifies the name of the component.stringTRUE
numberingSystemnumbering-systemSpecifies the Unicode numeral system used by the component for localization."arab" | "arabext" | "latn"FALSE
placeholderplaceholderSpecifies the placeholder text for the component.stringFALSE
readOnlyread-onlyWhen true, the component's value can be read, but cannot be modified.booleanTRUE
requiredrequiredWhen true and the component resides in a form, the component must have a value in order for the form to submit.booleanTRUE
resizeresizeSpecifies if the component is resizable."both" | "horizontal" | "none" | "vertical"TRUE
rowsrowsSpecifies the component's number of rows.numberTRUE
scalescaleSpecifies the size of the component."l" | "m" | "s"TRUE
statusstatusSpecifies the status of the input field, which determines message and icons."idle" | "invalid" | "valid"TRUE
validationIconvalidation-iconSpecifies the validation icon to display under the component.boolean | stringTRUE
validationMessagevalidation-messageSpecifies the validation message to display under the component.stringFALSE
validityNAThe current validation state of the component.Check API referenceFALSE
valuevalueThe component's value.stringFALSE
wrapwrapSpecifies the wrapping mechanism for the text."hard" | "soft"TRUE

Events

The following events are observed by shiny:

EventDescription
calciteTextAreaChangeFires each time a new value is typed and committed.
calciteTextAreaInputFires each time a new value is typed.

Slots

The following slots are provided by this component:

SlotDescription
Default (unnamed)A slot for adding text.
footer-startA slot for adding content to the start of the component's footer.
footer-endA slot for adding content to the end of the component's footer.

Examples

calcite_text_area()
#> <calcite-text-area></calcite-text-area>