swarm ui: the create-agent name field says why a name is refused, beside the field
A name with an uppercase letter greyed out next with only the footer to say why. The text field now takes an error: it marks the field invalid, draws the reason under it and points aria-describedby at it. The create form passes it once something is typed, and nameProblem names the cause (uppercase first, then length, then other characters) instead of one catch-all rule. Next stays disabled, with the footer hint as before. The swarm UI doc says so.
This commit is contained in:
parent
da25f0a1c3
commit
94969b552e
5 changed files with 39 additions and 5 deletions
|
|
@ -73,6 +73,7 @@ import {
|
|||
import {
|
||||
NAME_PATTERN,
|
||||
lastReachableStep,
|
||||
nameProblem,
|
||||
nextStep,
|
||||
previousStep,
|
||||
STEP_TITLES,
|
||||
|
|
@ -391,6 +392,7 @@ export function CreateAgentForm({
|
|||
pattern={NAME_PATTERN}
|
||||
title="1-63 chars: lowercase letters, digits, hyphens"
|
||||
required
|
||||
error={name === "" ? null : nameProblem(name)}
|
||||
onInput={setName}
|
||||
/>
|
||||
<SelectField
|
||||
|
|
|
|||
|
|
@ -28,9 +28,16 @@ export const STEP_TITLES: Record<Step, string> = {
|
|||
export const NAME_PATTERN = "[a-z0-9\\-]{1,63}";
|
||||
|
||||
export function nameProblem(name: string): string | null {
|
||||
return new RegExp(`^${NAME_PATTERN}$`).test(name)
|
||||
? null
|
||||
: "the name is 1-63 characters: lowercase letters, digits and hyphens";
|
||||
if (new RegExp(`^${NAME_PATTERN}$`).test(name)) return null;
|
||||
// Said for the likeliest slip first, so the field can name the cause.
|
||||
if (/[A-Z]/.test(name)) {
|
||||
return "uppercase letters aren't allowed, use lowercase";
|
||||
}
|
||||
if (name.length > 63) return "the name is at most 63 characters";
|
||||
if (/[^a-z0-9-]/.test(name)) {
|
||||
return "only lowercase letters, digits and hyphens are allowed";
|
||||
}
|
||||
return "the name is 1-63 characters: lowercase letters, digits and hyphens";
|
||||
}
|
||||
|
||||
/** The step after `step`, or `step` itself on the last. */
|
||||
|
|
|
|||
|
|
@ -45,6 +45,10 @@
|
|||
box-sizing: border-box;
|
||||
min-height: 2.75em;
|
||||
}
|
||||
/* A control whose value is not acceptable; the reason is a `Hint` below it. */
|
||||
.ui-form-control-invalid {
|
||||
border-color: var(--red);
|
||||
}
|
||||
/* A label that stays for assistive tech and is off the screen. */
|
||||
.ui-form-field-label-hidden {
|
||||
position: absolute;
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
// mode — promote that the day a real caller needs one, same "don't
|
||||
// build ahead of a caller" rule the rest of `ui/` follows.
|
||||
import { FormField } from "../form-field/FormField.js";
|
||||
import { Hint } from "../hint/Hint.js";
|
||||
|
||||
/** One value the field offers to complete to. */
|
||||
export interface TextFieldSuggestion {
|
||||
|
|
@ -26,6 +27,7 @@ export function TextField({
|
|||
suggestions,
|
||||
onKeyDown,
|
||||
combobox,
|
||||
error,
|
||||
}: {
|
||||
id: string;
|
||||
label: string;
|
||||
|
|
@ -43,6 +45,10 @@ export function TextField({
|
|||
suggestions?: TextFieldSuggestion[];
|
||||
/** Key presses in the field, for a caller that draws its own menu. */
|
||||
onKeyDown?: (e: KeyboardEvent) => void;
|
||||
/** Why the value is not acceptable, shown under the field and marked on it.
|
||||
* Null or absent while it is fine, so a caller can leave it out until the
|
||||
* operator has typed something. */
|
||||
error?: string | null;
|
||||
/** Marks the field as the text box of a menu the caller draws itself. */
|
||||
combobox?: {
|
||||
expanded: boolean;
|
||||
|
|
@ -53,11 +59,15 @@ export function TextField({
|
|||
};
|
||||
}) {
|
||||
const listId = `${id}-suggestions`;
|
||||
const errorId = `${id}-error`;
|
||||
const invalid = error !== undefined && error !== null;
|
||||
return (
|
||||
<FormField label={label} htmlFor={id} hideLabel={hideLabel}>
|
||||
<input
|
||||
id={id}
|
||||
class="ui-form-control"
|
||||
class={"ui-form-control" + (invalid ? " ui-form-control-invalid" : "")}
|
||||
aria-invalid={invalid ? true : undefined}
|
||||
aria-describedby={invalid ? errorId : undefined}
|
||||
// preact 11 types `type` as a union that ties each kind to its own
|
||||
// `list` and `role` attributes; the field takes any of its kinds and
|
||||
// passes `list` only for suggestions, so the union is asserted here.
|
||||
|
|
@ -77,6 +87,11 @@ export function TextField({
|
|||
onKeyDown={onKeyDown}
|
||||
onInput={(e) => onInput((e.target as HTMLInputElement).value)}
|
||||
/>
|
||||
{invalid ? (
|
||||
<Hint tone="error" id={errorId}>
|
||||
{error}
|
||||
</Hint>
|
||||
) : null}
|
||||
{suggestions ? (
|
||||
<datalist id={listId}>
|
||||
{suggestions.map((s) => (
|
||||
|
|
|
|||
|
|
@ -41,6 +41,10 @@ test("a name is 1-63 lowercase letters, digits and hyphens", () => {
|
|||
assert.notEqual(nameProblem("a".repeat(64)), null);
|
||||
assert.notEqual(nameProblem("Ruth"), null);
|
||||
assert.notEqual(nameProblem("ru th"), null);
|
||||
// The reason names the cause, uppercase first.
|
||||
assert.match(nameProblem("Ruth"), /uppercase/);
|
||||
assert.match(nameProblem("ru th"), /lowercase letters, digits and hyphens/);
|
||||
assert.match(nameProblem("a".repeat(64)), /63/);
|
||||
});
|
||||
|
||||
test("identity needs a valid name and a hive before next", () => {
|
||||
|
|
|
|||
Loading…
Reference in a new issue