Vue Form Text Component

Vue textarea components. Give textual form `<textarea>`s an upgrade with custom styles, sizing, focus states, validation, and more.

Other frameworks

CoreUI components are available as native Angular, Bootstrap (Vanilla JS), and React components. To learn more please visit the following pages.

• Angular Textarea
• Bootstrap Textarea
• React Textarea

Example #

Example textarea

Must be 8-20 words long.

<CForm>
  <CFormTextarea
    id="exampleFormControlTextarea1"
    label="Example textarea"
    rows="3"
    text="Must be 8-20 words long."
  ></CFormTextarea>
</CForm>

If you need to add custom classs to form's components, or need to add some custom elements you can add each form component separately. Please check the example below.

<CFormLabel for="exampleFormControlTextarea1">Example textarea</CFormLabel>
<CFormTextarea id="exampleFormControlTextarea1" rows="3"></CFormTextarea>
<CFormText component="span" id="passwordHelpInline">Must be 8-20 words long.</CFormText>

You can also use slots.

<CFormTextarea id="exampleFormControlTextarea1" rows="3">
  <template #label>Example textarea</template>
  <template #text>Must be 8-20 word long.</template>
</CFormTextarea>

Disabled #

Add the disabled boolean attribute on an input to give it a grayed out appearance and remove pointer events.

<CFormTextarea
  className="mb-3"
  placeholder="Disabled textarea"
  aria-label="Disabled textarea example"
  disabled>
</CFormTextarea>

Readonly #

Add the readonly boolean attribute on an textarea to prevent modification of the textarea's value. Read-only textareas appear lighter (just like disabled textareas), but retain the standard cursor.

<CFormTextarea
  placeholder="Readonly textarea"
  aria-label="Readonly textarea example"
  disabled
  readonly
></CFormTextarea>

API #

CFormTextarea #

import { CFormTextarea } from '@coreui/vue'
// or
import CFormTextarea from '@coreui/vue/src/components/form/CFormTextarea'

Props #

Prop name	Description	Type	Values	Default
disabled	Toggle the disabled state for the component.	boolean	-	-
feedback 4.3.0+	Provide valuable, actionable feedback.	string	-	-
feedback-invalid 4.3.0+	Provide valuable, actionable feedback.	string	-	-
feedback-valid 4.3.0+	Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, :invalid and :valid.	string	-	-
floating-label 4.3.0+	Provide valuable, actionable valid feedback when using standard HTML form validation which applied two CSS pseudo-classes, :invalid and :valid.	string	-	-
id	The id global attribute defines an identifier (ID) that must be unique in the whole document.	string	-	-
invalid	Set component validation state to invalid.	boolean	-	-
label 4.3.0+	Add a caption for a component.	string	-	-
model-value	The default name for a value passed using v-model.	string	-	-
plain-text	Render the component styled as plain text. Removes the default form field styling and preserve the correct margin and padding. Recommend to use only along side readonly.	boolean	-	-
readonly	Toggle the readonly state for the component.	boolean	-	-
text 4.3.0+	Add helper text to the component.	string	-	-
tooltip-feedback 4.3.0+	Display validation feedback in a styled tooltip.	boolean	-	-
valid	Set component validation state to valid.	boolean	-	-

Events #

Event name	Description	Properties
change	Event occurs when the element loses focus, after the content has been changed.
input	Event occurs immediately after the value of a component has changed.
update:modelValue	Emit the new value whenever there’s an input or change event.

CFormFeedback #

import { CFormFeedback } from '@coreui/vue'
// or
import CFormFeedback from '@coreui/vue/src/components/form/CFormFeedback'

Props #

Prop name	Description	Type	Values	Default
component	Component used for the root node. Either a string to use a HTML element or a component.	string	-	'div'
invalid	Method called immediately after the value prop changes.	boolean	-	-
tooltip	If your form layout allows it, you can display validation feedback in a styled tooltip.	boolean	-	-
valid	Set component validation state to valid.	boolean	-	-

CFormLabel #

import { CFormLabel } from '@coreui/vue'
// or
import CFormLabel from '@coreui/vue/src/components/form/CFormLabel'

Props #

Prop name	Description	Type	Values	Default
custom-class-name	A string of all className you want to be applied to the component, and override standard className value.	array|string	-	-

CFormText #

import { CFormText } from '@coreui/vue'
// or
import CFormText from '@coreui/vue/src/components/form/CFormText'

Props #

Prop name	Description	Type	Values	Default
component	Component used for the root node. Either a string to use a HTML element or a component.	string	-	'div'