Input

Accessible, unstyled native text input with controlled and uncontrolled state.

Minimal setup

Use a Vue 3.5+ project with Vue SFC compilation configured (see Vite+ integration).

vp install @vizejs/ui

Add the public import below to <script setup lang="ts">. Components provide behavior without styles; the preview uses optional Paper styles.

import { Input } from "@vizejs/ui/input";

Or copy the source into your project with vize lib pull input (see Source Distribution).

Try it

This is the basic example maintained with the component source, using the public package imports. The preview adds the optional Paper styles.

Open the interactive example · Styling these components

Copy the example

<!-- Controlled text input bound with v-model and labelled by a native label. -->
<script setup lang="ts">
import { ref, useId } from "vue";

import { Input } from "@vizejs/ui/input";

const name = ref("");
const inputId = useId();
</script>

<template>
  <div>
    <label :for="inputId">Display name</label>
    <Input
      :id="inputId"
      v-model="name"
      name="displayName"
      autocomplete="nickname"
      placeholder="Ada Lovelace"
    />
    <output :for="inputId">Hello, {{ name || "stranger" }}</output>
  </div>
</template>

API

Input

Source: src/families/form/input/text-input.vue

Props

Events

Exposed

Behavior

Normative state × input → outcome table for text-input.vue (@vizejs/ui/input). Every row is proven by the named mounted-DOM test in src/families/form/input/input.test.ts; a row without a passing test is a contract violation.

The subpath remains tree-shakable and retains no packaged CSS; those package contracts are pinned by distribution.test.ts, check:size, and check:tree-shaking.