text-field
A labelled text field on a native <input> (or <textarea> with rows), so it submits under its name, autofills, and validates as the browser's own (required, type="email", minlength, pattern). The message shows after the field is left, or when the form is submitted, and is linked to the field for screen readers. value is two-way.
Try it: events appear here (valuechange).
Source: text-field.zb, and its registry item.
Install
npx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/text-field.jsonpnpm dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/text-field.jsonyarn dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/text-field.jsonbunx --bun shadcn@latest add https://zubra-js.github.io/zubra-ui/r/text-field.json
npx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/text-field.jsonpnpm dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/text-field.jsonyarn dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/text-field.jsonbunx --bun shadcn@latest add https://zubra-js.github.io/zubra-ui/r/element/text-field.json
npx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/text-field.jsonpnpm dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/text-field.jsonyarn dlx shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/text-field.jsonbunx --bun shadcn@latest add https://zubra-js.github.io/zubra-ui/r/src/text-field.json
<link rel="stylesheet" href="https://zubra-js.github.io/zubra-ui/themes/default.css">
<script type="module" src="https://zubra-js.github.io/zubra-ui/cdn/text-field.js"></script>The compiled install writes src/components/zubra/text-field.js and the theme, and adds @zubra/runtime to your dependencies. The one-file install writes the same path as a plain custom element that needs nothing installed (or download it and load it with a <script type="module">); it's smaller on a page with one to three components, the shared runtime with more.
Usage
<text-field
label="Email"
description="We'll send the receipt here."
type="email"
name="email"
autocomplete="email"
placeholder="you@example.com"
></text-field>
<script type="module">
import './components/zubra/text-field.js';
const element = document.querySelector('text-field');
element.required = true;
element.addEventListener('valuechange', (event) => console.log('valuechange', event.detail));
</script>import './components/zubra/text-field.js';
const required = true;
export function TextFieldExample() {
return (
<text-field
label="Email"
description="We'll send the receipt here."
type="email"
name="email"
autocomplete="email"
placeholder="you@example.com"
required={required}
onvaluechange={(event) => console.log('valuechange', event.detail)}
></text-field>
);
}<script setup>
import './components/zubra/text-field.js';
const required = true;
const onValuechange = (event) => console.log('valuechange', event.detail);
</script>
<template>
<text-field
label="Email"
description="We'll send the receipt here."
type="email"
name="email"
autocomplete="email"
placeholder="you@example.com"
:required.prop="required"
@valuechange="onValuechange"
></text-field>
</template>
<!-- vite.config.js: vue({ template: { compilerOptions: { isCustomElement: (tag) => tag.includes('-') } } }) --><script>
import './components/zubra/text-field.js';
const required = true;
</script>
<text-field
label="Email"
description="We'll send the receipt here."
type="email"
name="email"
autocomplete="email"
placeholder="you@example.com"
{required}
onvaluechange={(event) => console.log('valuechange', event.detail)}
></text-field>import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import './components/zubra/text-field.js';
@Component({
selector: 'app-text-field-example',
schemas: [CUSTOM_ELEMENTS_SCHEMA],
template: `
<text-field
label="Email"
description="We'll send the receipt here."
type="email"
name="email"
autocomplete="email"
placeholder="you@example.com"
[required]="required"
(valuechange)="onValuechange($event)"
></text-field>
`,
})
export class TextFieldExample {
required = true;
onValuechange(event: Event) {
console.log('valuechange', (event as CustomEvent).detail);
}
}API
| Property | Type | Default |
|---|---|---|
value | string | "" |
label | string | "" |
description | string | "" |
error | string | "" |
name | string | "" |
type | string | "text" |
placeholder | string | "" |
autocomplete | string | "" |
inputmode | string | "" |
required | boolean | false |
disabled | boolean | false |
readonly | boolean | false |
minlength | unknown | null |
maxlength | unknown | null |
pattern | string | "" |
rows | number | 0 |
| Event | When |
|---|---|
valuechange | The text changed; detail is the new text. |
Size
1.7 KB gzipped for the component, plus the runtime, which every Zubra component on a page shares (up to 22.1 KB, all of it). On its own, with the parts of the runtime it uses, it's 18.4 KB.