Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@tournant/input

1.0.0 • Public • Published

@tournant/input

A component for text-like inputs. Accessible and versatile.


NPM version GitHub license

Installation

You can install the component using NPM or Yarn.

npm install @tournant/input --save

If you use Yarn:

yarn add @tournant/input

Once the component is installed you need to import wherever you want to use it.

import TournantInput from '@tournant/input'

Don’t forget to add it to the registered components (been there, done that):

components: {
  TournantInput,
  // ... all the other amazing components
}

API

This is just a quick overview. For an in-depth guide how to use the component check the section Usage below.

Props

  • value: The value shown inside of the input.
  • label: The label text of the input. Required.
  • validation: A vuelidate-like object, must contain properties named $error and $dirty. Required.
  • description: Descriptive text giving a user more context on what form their input has to have. Optional.
  • descriptionPosition: Controls if the position should be displayed underneath the input or between label and input; defaults to bottom.
  • isTextarea: Render a textarea instead of an input element. Default to false.

Styles

The component exposes the following CSS classes for its parts:

Classname Element
t-ui-input Root
t-ui-input__input Text field
t-ui-input__description Descriptive text
t-ui-input__feedback Container to show feedback messages

By default no styles will be attached to these classes.

Usage

This component was built to accept all text-like input formats. These are, for example, password, email or date.

Attributes you add when adding the component to your template are bound to the input element.

Say you want to add a password input to a form. If you add type="password" the component will take the type and apply it to the input element.

<tournant-input type="password" />

@tournant/input is v-model compliant.

<tournant-input v-model="password" type="password" name="password" />

Ths will result in the following input:

<input
    id="6ac26f8f-930c-4dc4-a098-b00094b56906"
    aria-invalid="false"
    type="password"
    name="password"
    class="t-ui-input__input"
/>

💁‍ Note: You do not need to pass in a id. A unique ID for every instance of the component is automatically generated.

Textarea

<input>s and <textarea>s are quite similar, in that they can both hold text content, which might need validation and so forth. This is why, instead of having a separate component to add a <textarea>, you can change this one via the isTextarea prop to be one:

<tournant-input
    v-model="message"
    :is-textarea="true"
    name="message"
    label="Your message"
/>

will output

<label class="t-ui-input__label" for="6ac26f8f-930c-4dc4-a098-b00094b56906">
    Your message
</label>
<textarea
    class="t-ui-input__input"
    name="message"
    id="6ac26f8f-930c-4dc4-a098-b00094b56906"
></textarea>

Label

Input elements must have a linked label to give the input an accessible name.

To do so, pass in the label prop when using the component.

<tournant-input
    v-model="password"
    type="password"
    name="password"
    label="Your password"
/>

💁 Note: label is required.

Description

Sometimes it is useful to describe expected conditions. For example, a user has to enter a password that is at least eight characters long.

To add a description, pass in the prop named, you might have guessed it, description.

<tournant-input
    v-model="password"
    type="password"
    name="password"
    label="Your password"
    description="Your password has to be at least eight characters long."
/>

This will render the description in a p element which is linked to the input via the aria-describedby attribute.

Required inputs

In addition to binding the required attribute on the input element the component exposes a slot inside of its label element to add a visual clue that the user has to fill in data.

Bear in mind that the popular * might not be enough to indicate a required field. For further reading I recommend the article Required Fields on a11y-101.com

<tournant-input
    v-model="password"
    type="password"
    name="password"
    label="Your password"
    description="Your password has to be at least eight characters long."
>
    <template v-slot:label-text>
        <span class="aside">required</span>
    </template>
</tournant-input>

💁 Note: This example uses the named slot syntax introduced in Vue 2.6. Take a look in the docs for usage examples and how to use named slots in versions prior to 2.6.

💁 Note: You can add any text you want. If you mark optional fields instead of required ones, this is also possible.

Validation

No input without validation, right?

You will have to take care of this yourself, though. The component can and should not know what value is expected inside of it.

Nonetheless, we tried to make it as easy as possible to use the component along existing solutions like Vuelidate.

In fact, if you are already using Vuelidate, you are good to go.

@tournant/input expects a vuelidate-like validation object. Namely the properties $error and $dirty.

For our password example the Vuelidate config might look something like this:

import { required, minLength } from 'vuelidate/lib/validators'
 
export default {
    // […] Component context omitted for brevity
    validations: {
        password: {
            required,
            minLength: minLength(8)
        }
    }
}

You can use $v.password as the prop for the input component without the need to change anything.

<tournant-input
    v-model="password"
    :required="true"
    :validation="$v.password"
    type="password"
    name="password"
    label="Your password"
    description="Your password has to be at least eight characters long."
>
    <template v-slot:label-text>
        <span class="aside">required</span>
    </template>
</tournant-input>

aria-invalid is set based on validation.$error, to let screen readers know if the entered value is correct.

This attribute could also be used to add styles based on the validated state.

.tournant-input__input[aria-invalid='true'] {
    border-color: red;
}

Feedback Messages

Relying on styling is not enough to convey errors to users. @tournant/input exposes a feedback slot to render detailed feedback for the users.

<tournant-input
    v-model="password"
    :required="true"
    :validation="$v.password"
    type="password"
    name="password"
    label="Your password"
    description="Your password has to be at least eight characters long."
>
    <template v-slot:label-text>
        <span class="aside">required</span>
    </template>
    <template v-slot:feedback>
        <p v-if="!$v.password.required">
            Your password is required.
        </p>
    </template>
</tournant-input>

If validation.$error equals true the ID of the feedback container will be added to aria-describedby and as thus read by screen readers.

Bugs & Enhancements

If you found a bug, please create a bug ticket.

For enhancements please refer to the contributing guidelines.

Install

npm i @tournant/input

DownloadsWeekly Downloads

10

Version

1.0.0

License

MIT

Unpacked Size

28.9 kB

Total Files

7

Last publish

Collaborators

  • avatar
  • avatar