BnTextarea ​

BnTextarea is a wrapper for a <textarea> element.

Basic Usage ​

The only required prop for BnTextarea is name. The name prop is used to identify the input in the context of a Form or an useForm, or when submitting a form in the traditional way.

<bn-textarea v-model="value" name="name" />

Textarea Attributes ​

The BnTextarea component accepts all the attributes that a native <textarea> element accepts.

<bn-textarea name="disabled" disabled placeholder="Disabled" />
<bn-textarea name="readonly" v-model="filledExample" readonly />

Vee-Validate ​

BnTextarea works with vee-validate out of the box.

<script setup lang="ts">
import { Form } from 'vee-validate';
import isRequired from '../rules';

const validationSchema = {
  textarea: isRequired,
};
</script>

<template>
  <Form :validation-schema="validationSchema">
    <bn-textarea
      name="textarea"
      placeholder="Click on me and then click out"
    />
  </Form>
</template>

Rules ​

If you want to validate a field without being in the context of a Form or an useForm, you can use the rules prop.

<script setup lang="ts">
import isRequired from '../rules';
</script>

<template>
  <bn-textarea
    v-model="validate"
    name="validation"
    :rules="isRequired"
    placeholder="Click on me and then click out"
  />
</template>

Color ​

You can change the color accent of the textarea using the color prop.

<bn-textarea name="value" color="lime" placeholder="Click on me" />

Slots ​

bottom ​

The bottom slot is used to add content below the input. Useful for hints or errors. Includes the following slot props:

• errorMessage: vee-validate property, if the input is invalid
• valid: vee-validate meta property
• touched: vee-validate meta property

<bn-textarea
  v-model="value"
  name="value"
  :rules="(value) => value.length > 5 || 'Your text is too short'"
>
  <template #bottom="{ errorMessage, valid, touched }">
    <span
      class="mt-1 text-sm"
      :class="!valid && touched ? 'text-rose-700' : 'text-gray-500'"
    >
      <template v-if="touched && !valid">
        {{ errorMessage }}
      </template>
      <template v-else-if="valid">
        ✅
      </template>
    </span>
  </template>
</bn-textarea>

Customization ​

There are two ways to customize the appearance of the BnTextarea component:

classes prop ​

Every component has a classes prop that will accept an object where each key corresponds to an internal element of the component. The value of each key will be the classes that will be applied to that element. For the values, you can use strings, objects or arrays, the same way it works with Vue's class binding.

<bn-textarea
  name="textarea"
  v-model="value"
  :classes="{ textarea: 'border-4 rounded-none' }"
/>

Default styles will still be applied, but the classes you provide will take precedence, so you can use this to override any existing style.

The available keys for this component are:

• textarea: The <textarea> element itself

Theming ​

You can change the default appearance or even add variants by editing the configuration of the TailwindCSS plugin.

plugins: [
    require('@tailwindcss/forms'),
    require('@headlessui/tailwindcss'),
    banano.tailwindPlugin({
      theme: {
        BnTextarea: {
          '.bn-textarea': {
            '@apply text-green-600': {},
          }
        }
      }
    }),
  ],

You can find more information about customizing the library in Theme Customization.

API Reference ​

Props ​

Events ​

This component does not emit any events, but it emits all the events from the underlying <input> element.

Slots ​