TextArea ​

KTextArea - Text areas are primarily used in modal views (wizards).

<KTextArea />

Props ​

label ​

String to be used as the textarea label.

<KTextArea label="Name" placeholder="I'm labelled!" />

If the label is omitted it can be handled with another component, like KLabel. This is meant to be used before KTextArea will be styled appropriately.

<KLabel>Label</KLabel>
<KTextArea placeholder="I have a label" />

labelAttributes ​

Use the labelAttributes prop to configure the KLabel's props if using the label prop. This example shows using the label-attributes to set up a tooltip, see the slot section if you want to slot HTML into the tooltip rather than use plain text.

<KTextArea label="Name" :label-attributes="{ help: 'I use the KLabel `help` prop' }" />

overlayLabel ​

Enable this prop to overlay the label on the input element's border. Defaults to false. Make sure that if you are using the built in label you specify the --KInputBackground theming variable. This variable is used for the background of the label as well as the input element.

<KTextArea label="Name" placeholder="I'm labelled!" :overlay-label="true" />

cols ​

You can specify cols to adjust the horizontal size of the textarea

<KTextArea :cols="12" placeholder="cols:12" />

rows ​

You can specify rows to adjust the vertical size of the textarea

<KTextArea :rows="12" placeholder="rows:12" />

isResizable ​

Boolean value to allow vertically resizing using the drag handle in the right-hand corner of the textarea

<KTextArea is-resizable />

characterLimit ​

Use this prop to specify a character limit for the textarea, defaults to 2048.

<KTextArea :characterLimit="20" />

disableCharacterLimit ​

Use this prop to remove the character limit on the textarea. Defaults to false.

<KTextArea disable-character-limit />

hasError ​

Boolean value to indicate whether the element has an error and should apply error styling. By default this is false.

<KTextArea has-error />

Attribute Binding ​

You can pass any input attribute and it will get properly bound to the element.

<KTextArea label="Name" placeholder="I'm disabled!" disabled />

required ​

KTextArea will display an * to indicate a field is required if you set the required attribute and provide a label. See KLabel's required prop for more information.

<KTextArea label="Name" required />
<KTextArea label="Name" overlay-label required />

v-model ​

KTextArea works as regular texarea do using v-model for data binding:

<KComponent :data="{myInput: 'hello'}" v-slot="{ data }">
  {{ myInput }}
  <KTextArea v-model="data.myInput" />
</KComponent>

Slots ​

• label-tooltip - slot for tooltip content if textarea has a label and label has tooltip (note: this slot overrides help/info content specified in label-attributes)

If you want to utilize HTML in the textarea label's tooltip, use the slot.

<KTextArea label="My Tooltip">
  <template #label-tooltip>Brings all the <code>devs</code> to the yard</template>
</KTextArea>

<KTextArea
  label="My Tooltip"
  :label-attributes="{ help: 'true' }"
>
  <template #label-tooltip>Brings all the <code>devs</code> to the yard</template>
</KTextArea>

Events ​

KTextArea has a couple of natural event bindings.

• input - Fired on change, returns the content of the textarea

• char-limit-exceeded - Fired when the text starts or stops exceeding the limit, returns an object:

  json

  {
      value,          // current value
      length,         // length of current value
      characterLimit, // character limit
      limitExceeded   // whether or not the limit has been exceeded
  }

  1
  2
  3
  4
  5
  6
  

KTextArea also transparently binds to events:

<KComponent :data="{myInput: 'hello'}" v-slot="{ data }">
  <div>
    <KTextArea
      v-model="data.myInput"
      @blur="e => (data.myInput = 'blurred')"
      @focus="e => (data.myInput = 'focused')"
    />
  </div>
</KComponent>

Theming ​

An Example of changing the error border color of KInput to pink might look like:

<template>
  <KTextArea class="custom-input" has-error type="email" />
</template>

<style>
.custom-input {
  --KInputError: hotpink;
}
</style>