Saltar al contenido
menumenu tanreiexpand_morecontrasttranslate
tanreiexpand_more
Primeros pasosWebReactSwiftUIJetpack ComposeFlutterReact NativePreajustesTu propio sistema de diseñoUsar Tanrei con agentes de IAMarcaTokens de diseñoSistemas de diseño y personalizaciónTheme StudioColorTipografíaIconosFormaElevaciónMovimientoEstados de interacciónComportamientoDiseño de páginaAccesibilidadTextosTokens de colorTokens de la escala tipográficaTokens de formaTokens de elevaciónTokens de movimientoTokens de estadoTokens de espacio y de medidaComponentesBotónBotón de acción principalBotón segmentadoGrupo de botonesBotón con menúBarra de herramientasBotón de copiarCasilla de verificaciónBotón de opciónInterruptorChipMenúControl deslizanteCampo de control deslizanteCalendarioDateTimePickerGrupo de camposGrupo de botones de opciónGrupo de casillas de verificaciónSelectCampo de selecciónBarra de menúsSubida de archivosSelector de archivos AvanzadoZona de soltar archivosEntrada de texto AvanzadoCampo de textoCampo de chipsCampoCuadro combinado AvanzadoCampo de cuadro combinadoEntrada numérica AvanzadoCampo numéricoEntrada de color AvanzadoCampo de colorEntrada de código de un solo uso AvanzadoCampo de código de un solo usoEntrada de texto incrustada AvanzadoCuadro de redacción de chatTarjetaDivisorCapa modal AvanzadoDiálogoListaFila de listaHoja inferiorHoja lateralCarruselBloque de códigoTablaPopoverPasosAcordeónLista de descripcionesFiguraEstructura de la aplicaciónCabecera de páginaVista de árbolLínea de tiempoVista previa de imágenesTirador de tamañoMarco redimensionableÁrea de desplazamientoInsigniaIndicador de progresoMedidorContador animadoIndicador de cargaSnackbarTooltipAtajo de tecladoTagCódigo en líneaCalloutAvatarEstado vacíoGrupo de tagsEsqueletoElemento de archivoMuestraTexto en marquesinaPestañasVista de pestañasBarra de la aplicaciónBarra de navegaciónPanel de navegaciónBúsquedaEnlacePaginaciónEnlaces anterior y siguienteIndicador de pasosRuta de navegaciónTabla de contenidoTarjeta de enlaceMenú FABEstadoCómo se construye TanreiCómo contribuirLicencia y atribución
InicioComponentesCampo numérico

Campo numérico

Permite introducir un número como número (escrito en la forma de la configuración regional de la persona o cambiado por pasos con una tecla o un botón, mantenido dentro de unos límites y con su unidad al lado), como un campo de formulario completo, compuesto por un campo y una entrada numérica.

content_copyVer en Markdown
Categoría
Entradas de texto
Tokens
comp.field
Nivel
Compuesto
Se compone de
Field, Number input

Descripción general

Web
tanrei-number-field
schedule
SwiftUI
TanreiNumberField
radio_button_unchecked
Jetpack Compose
TanreiNumberField
radio_button_unchecked
Flutter
TanreiNumberField
radio_button_unchecked
React Native
NumberField
radio_button_unchecked
Variantes que no se incluyen en
tanrei: filled, outlined

Generado a partir de docs/status/status.json, specs/number-field.spec.json

Un campo numérico con una unidad y límites, y otro que contiene un importe

Usa un campo numérico para un número que el producto lee como número: una cantidad, un tamaño, un porcentaje, un importe. Las personas lo escriben en la forma de su configuración regional, o lo cambian por pasos con las teclas de flecha o con los dos botones que hay al final del campo. El campo se dibuja y se mide como el campo de texto de la misma variante y el mismo tamaño.

Se compone de un campo y una entrada numérica. El campo es el marco: la etiqueta, la marca de obligatorio o de opcional, la ayuda y el error. La entrada numérica es el control: la caja, el número, su unidad y los dos botones de paso. El campo numérico no dibuja nada propio y no tiene ningún token: cada propiedad que tiene es una propiedad de uno de los dos, que recibe sin cambios.

Un campo numérico ya es un campo: nunca se pone dentro de un campo. Donde la etiqueta está en otro lugar —junto a un control deslizante, en una celda de una tabla—, usa la entrada numérica sola.

Es un bloque tan ancho como el lugar en el que se pone, y su caja lo llena. No tiene ancho propio: para un campo más estrecho, dale un lugar más estrecho.

En la web es <tanrei-number-field>. Las demás plataformas todavía no lo han implementado.

Uso

value es un número, o null mientras el campo no contiene ninguno. Cambia cuando la persona confirma (el foco sale del campo, pulsa Enter o da un paso), y no con cada pulsación de tecla. Mientras escribe, el texto es suyo: nada se rechaza, se reformatea, se ajusta a los límites ni se redondea. Entretanto, input lleva el número que representa el texto.

<form>
  <tanrei-number-field name="quantity" label="Cantidad" value="1" min="1" max="99"
    required required-text="Obligatorio" invalid-text="Introduce un número." increment-label="Aumentar" decrement-label="Reducir"></tanrei-number-field>
</form>

<!-- Una unidad, un paso de un cuarto y sin límite superior. -->
<tanrei-number-field id="radius" label="Radio de esquina" value="8" min="0" step="0.25" suffix-text="px" increment-label="Aumentar" decrement-label="Reducir"></tanrei-number-field>

<!-- Dinero: un signo delante, un código detrás y siempre dos decimales. -->
<tanrei-number-field label="Importe" value="120" prefix-text="$" suffix-text="USD"
  min-fraction-digits="2" max-fraction-digits="2" increment-label="Aumentar" decrement-label="Reducir"></tanrei-number-field>

<script type="module">
  import '@tanrei/web/components/number-field';

  const radius = document.querySelector('#radius');
  // Una confirmación cambió el valor. Ya es el nuevo: un número, o null.
  radius.addEventListener('change', () => save(radius.value));
  // La persona está escribiendo o dando pasos: el número que representa el texto, sin ajustar a los límites y sin redondear, o null.
  radius.addEventListener('input', (e) => preview(e.detail.value));
  // Se confirmó un texto que no es un número. El campo lo conserva y muestra invalidText:
  // detail.text es ese texto, vacío donde el campo no recibió ninguno.
  radius.addEventListener('entryerror', (e) => console.log(e.detail.reason, e.detail.text));
</script>
import { NumberField } from '@tanrei/react';

<NumberField label="Radio de esquina" value={radius} min={0} step={0.25} suffixText="px"
  incrementLabel="Aumentar" decrementLabel="Reducir"
  onChange={(event) => setRadius(event.currentTarget.value)} />

Un nivel más abajo

El mismo campo, escrito a mano a partir de sus dos miembros, da la misma imagen y es, para la tecnología de apoyo, el mismo botón de número (spin button) con el mismo nombre, la misma descripción y los mismos estados:

<tanrei-field label="Cantidad" required required-text="Obligatorio"
  supporting-text="Hasta 99 por pedido.">
  <tanrei-number-input name="quantity" min="1" max="99" invalid-text="Introduce un número."
    increment-label="Aumentar" decrement-label="Reducir"></tanrei-number-input>
</tanrei-field>

El mismo campo escrito a mano: un campo con una entrada numérica dentro

Baja a ese nivel cuando necesites una organización que el campo numérico no ofrece:

Necesitas Usa
Una etiqueta, la caja, una ayuda y un error El campo numérico
Algo tuyo dentro del marco, junto a la caja o debajo de ella Un campo con una entrada numérica y tu propio elemento dentro
La caja sola, bajo una etiqueta que está en otro lugar: junto a un control deslizante, una celda de una tabla, una barra de herramientas La entrada numérica sola, que recibe su nombre de su propio label

Lo que cambia un nivel más abajo es dónde se dice cada cosa. name, value, los límites y la unidad están en la entrada numérica, que es entonces el control con el que trata el formulario, y sus eventos se oyen en ella. label, error, disabled y la obligatoriedad se quedan en el campo, que se los pasa al control: no definas los de la propia entrada. No hay nada que el campo numérico haga y que no hagan el campo y la entrada numérica escritos a mano.

Especificaciones

Un botón de paso deshabilitado en el límite, dígitos en el borde de fin, sin botones de paso, un error, y un campo numérico de solo lectura y otro deshabilitado

El campo

Parte Qué es
Etiqueta Del campo: encima del contenedor (stacked). En filled y outlined la dibuja la entrada numérica, flotando dentro de la caja, y el campo no dibuja fila de etiqueta. Es el nombre accesible, tanto si se dibuja como si se oculta con labelHidden
Marca de obligatoriedad Del campo, después de la etiqueta: el tag de obligatoriedad en su forma de obligatorio, un asterisco o nada con required; el tag de obligatoriedad en su forma de opcional con optional. Una etiqueta flotante lleva el asterisco
Entrada De la entrada numérica: el número como texto. Mientras la persona edita, lo que ha escrito; en los demás casos, el número confirmado en la forma de la configuración regional. Una sola línea, que se desplaza
Prefijo, sufijo De la entrada numérica: texto fijo antes y después del número, como un signo de moneda o una unidad. Forman parte de la caja, nunca del valor
Botones de paso De la entrada numérica: dos botones al final; el primero da un paso hacia abajo y el segundo, hacia arriba. Quítalos con steppers en false
Texto de apoyo Del campo: una línea de ayuda. Mientras el campo está en error, el texto de error ocupa su lugar (o va debajo de ella, donde el sistema de diseño conserva las dos), y es errorText mientras error es true e invalidText mientras el texto no es un número. Empieza y termina en el margen interior del texto de la caja, con botones de paso y sin ellos

Las tres variantes y los tres tamaños, small (32), medium (40) y large (56), son los del campo de texto. El sistema predeterminado solo incluye stacked.

El campo numérico no tiene ningún token propio. Su caja lee los tokens de la entrada numérica, sus filas leen los tokens del campo y sus dos botones de paso, los del botón, allí donde estén definidos. Para cambiar una sola instancia, define en ella el token de un miembro: style="--tanrei-comp-field-label-gap: 0.75rem".

Los dos botones de paso son botones de la variante text y de tamaño mediano, uno al lado del otro. Con el sistema predeterminado ocupan 88 del ancho del campo, y cada uno es un objetivo táctil completo. Nunca se dibujan más pequeños ni apilados: donde una fila no tenga sitio para ellos, desactívalos. Las teclas siguen dando pasos.

El valor y el texto

Cuándo Qué ocurre
La persona escribe, pega o dicta No se cambia nada. input lleva el número que representa el texto, o null
El foco sale del campo, o Enter El texto se confirma: se sube hasta min, se baja hasta max, se redondea a maxFractionDigits, pasa a ser el valor y se vuelve a escribir en la forma de la configuración regional. change se emite si el valor es distinto
El texto está vacío El valor pasa a ser null
El texto no es un número El texto se queda. El valor pasa a ser null, el campo queda en error y muestra invalidText —su errorText donde no hay ninguno—, y se emite entryerror
El producto define value Se muestra el número, sea lo que sea lo que se haya escrito. No se emite ningún evento, y min y max no corrigen el número

Un número confirmado se escribe con los dígitos y el separador decimal de la configuración regional, con entre minFractionDigits y maxFractionDigits dígitos después de este y sin separadores de agrupación, de modo que lo que se muestra se puede volver a escribir tal cual.

El mismo valor, 1.5, en alemán y en árabe de Egipto

Un texto se lee con tolerancia, según el locale del campo o, donde este está vacío, según el idioma de la página:

  • Los espacios alrededor del número y dentro de él se ignoran.
  • Un guion, un signo menos o un signo más delante de los dígitos es el signo.
  • Los dígitos ASCII, los dígitos propios de la configuración regional y los dígitos de ancho completo son todos dígitos.
  • El separador de agrupación de la configuración regional se ignora entre dígitos: 1,234.50 se lee como 1234.5 en inglés.
  • Un prefijo y un sufijo escritos o pegados se ignoran: 12 px se lee como 12.
  • Las letras, un exponente, dos separadores o un signo solo no son un número.

El campo nunca adivina entre dos configuraciones regionales. En alemán, donde la coma es el separador decimal, 1.500 se lee como 1500 y 1.5 como 15.

En un diseño de derecha a izquierda: una unidad en letras latinas después del número, de izquierda a derecha, y una unidad en la escritura de la propia página a la izquierda del número

Un número y su unidad son una sola pieza de escritura. El prefijo se escribe antes del número y el sufijo después, en la dirección de la escritura de la propia unidad, sea cual sea la dirección de la página. Así, «44 px», «$ 120 USD» y «40 %» se leen en una página en árabe o en hebreo igual que en una en inglés, y una unidad escrita en letras árabes o hebreas queda a la izquierda del número. Los botones de paso y la etiqueta siguen a la página. align="end" pone el número junto a su unidad: a la derecha para una unidad en letras o signos latinos, en las dos direcciones. Para un código de moneda latino a la izquierda del número, empieza el sufijo con una marca de derecha a izquierda (U+200F).

Los pasos

Entrada Qué ocurre
Flecha arriba, Flecha abajo Da un paso de step
Re Pág, Av Pág Da un paso de diez veces step
Una pulsación en un botón de paso Da un paso. Si se mantiene pulsado, se repite: al cabo de medio segundo, después diez veces por segundo y después veinte
Inicio, Fin, Flecha izquierda, Flecha derecha Mueven el cursor de texto dentro del texto
La rueda del ratón, un arrastre Nada. La página se desplaza

Un paso lleva al siguiente número de la cuadrícula del paso, contada desde min (desde cero si no lo hay): con un paso de 5, desde 12 un paso hacia arriba lleva a 15 y uno hacia abajo, a 10. Se calcula en decimal, así que 0.2 más un paso de 0.1 es 0.3. Desde un campo vacío, un paso lleva al número más cercano a cero que permiten los límites.

step dice hasta dónde llega un paso. No limita lo que se puede escribir: con un paso de 5, un 12 escrito sigue siendo 12. Para aceptar solo algunos números, valida el valor y activa error.

Con un control deslizante

Un número junto a un control deslizante, bajo un mismo título de fila, es la caja sola: una entrada numérica, que recibe su nombre de su propio label. Su página tiene el ejemplo.

Anatomía

Anatomía

Dibujado sobre el fixture stacked-empty, tal como lo dibuja el paquete web.
Parte Descripción
1 field The Field: the label row with its glyph and its requirement mark, and the supporting row with the help and the error text. In a look whose input floats the label it draws no label row.
2 number-input The number input, as the Field's one control: the box, the number in it, the prefix and the suffix, the two steppers, and the label that floats in the box in the looks that float one.

Propiedades

Propiedad Tipo Valor predeterminado Descripción
variant stacked | filled | outlined "stacked" The text input's three looks, so that a number input is drawn as the text inputs beside it: stacked is a filled box that shows focus and error with a line inside its edge and draws no label — the label of the Field that frames it stands above it; filled and outlined float the label inside the box. Use one style per form. A design system may leave some out (the Tanrei system ships stacked only) or add values. — Number input
size small | medium | large "medium" Minimum height of the container: stacked 32 / 40 / 56, as tall as a Button of the same size, so that the box and a Button side by side in one row stand as tall as each other; filled and outlined 40 / 48 / 56, which hold the label that floats inside them. These are the text input's three sizes, small for a bar, a toolbar or a dense row of controls. The hit area always meets the minimum target. A design system may add values. — Number input
value number null The committed number, or null (the platform's absent value) while the field holds none. It changes when the person commits — focus leaves, the action key, a step — not on every keystroke; input carries what is being typed. — Number input
label string "" Names the control, visibly and to assistive technology. Required, unless the control names itself (a checkbox or a switch with its own label): then leave it empty and the field adds only help and an error. — Field Names the number input. In a filled or outlined look the input draws it, floating in its box, and the Field draws no label row (FLD-25, NMI-8).
labelHidden boolean false Does not draw the label, which stays the accessible name. For a control whose visible label is elsewhere (a table column, a toolbar). — Field Hides the label wherever it would be drawn: the Field's row, or the input's floating label (FLD-25). Where no message is shown either, the bare number input, named by its own label, is that control without a frame.
placeholder string "" A hint shown while the input is empty and the label is not in the input line. Never a replacement for a name. — Number input
supportingText string "" Help shown below the control and given to assistive technology as the control's description. While the field is in error it gives way to errorText, unless the design system keeps both (comp.field.error-text.placement append). — Field
errorText string "" Shown while error is true, in supportingText's place — or below it, which then stays, where the design system's comp.field.error-text.placement is append: what is wrong and how to put it right, in words. — Field
error boolean false Puts the field in the error condition: the error text is drawn, the control is exposed as invalid and, where it has an error condition of its own, drawn in it. What a value means is the product's to validate; the field never sets this itself. — Field The Field puts its number input in the input's own error condition (FLD-8, NMI-10); the steppers stay as they are.
disabled boolean false Disables the control and draws the frame as disabled. Disable a framed control here, not on the control, so that its label follows. — Field The Field disables its number input, and with it both steppers (FLD-14, NMI-32); the number field is then left out of its form (NUM-48).
readOnly boolean false The number can be focused, selected and copied, but not changed: no key steps it and no stepper is drawn. — Number input
required boolean false What the form asks of the control: true exposes it as required and draws the required mark beside the label. It never validates: a missing answer is the product's to report with error. — Field The Field exposes its number input as required (FLD-10, NMI-12).
optional boolean false Draws the optional tag after the label and adds optionalText to the control's description, because assistive technology has no state for it. Ignored while required is true: a control is never both. — Field
requiredMark auto | tag | asterisk | none "auto" How this control shows that it is required: tag is a small filled Tag with requiredText, asterisk is "*" after the label, none draws nothing and keeps the semantics. Auto takes comp.field.requirement.mark, which follows sys.behavior.requirement-mark, the system's one answer. Ignored unless required is true. — Field
requiredText string "" The text of the required tag, in the product's language ("Required", "必須"). The product's: Tanrei has no word for it. Empty reads the product's words; with neither, FLD-24 says what is drawn. — Field
optionalText string "" The text of the optional tag, in the product's language ("Optional", "任意"); also read to assistive technology as part of the description. The product's: Tanrei has no word for it. Empty reads the product's words. — Field
min number null The lowest number a commit keeps; a lower one is raised to it. Null for no limit. It is also where the steps are counted from. — Number input
max number null The highest number a commit keeps; a higher one is lowered to it. Null for no limit. — Number input
step number 1 How far Up Arrow, Down Arrow and a stepper move the number; Page Up and Page Down move ten times as far. It does not limit what may be typed. — Number input
steppers boolean true Draws the two stepper buttons at the end of the field. False for a field in a row too narrow for them, or beside a slider that does their work; the keys still step. — Number input
incrementLabel string "" The accessible name of the stepper that steps up, in the product's language ("Increase"). The product's: Tanrei has no word for it. Empty reads the product's words. Required while the steppers are shown. — Number input
decrementLabel string "" The accessible name of the stepper that steps down, in the product's language ("Decrease"). The product's: Tanrei has no word for it. Empty reads the product's words. Required while the steppers are shown. — Number input
prefixText string "" Fixed text before the number, not part of the value: a currency sign ("$", "¥"). — Number input
suffixText string "" Fixed text after the number, not part of the value: the unit ("px", "ms", "%", "kg"). Read to assistive technology with the number. — Number input
valueText string "" The value as words ("12 pixels", "3 stars"), given to assistive technology in place of the number with its prefix and suffix. The same text a Slider beside the field takes as its valueText. — Number input
align start | end "start" Where the number stands in the input: at the start, as the text of every other field, or at the end, for a number in a column of numbers whose digits should line up. — Number input
minFractionDigits number 0 The fewest digits shown after the decimal separator; zeros fill them (2 for an amount of money: "12.00"). — Number input
maxFractionDigits number 3 The most digits kept after the decimal separator: a commit rounds to it. 0 makes the field hold whole numbers and asks for a keyboard without a separator. — Number input
locale string "" A BCP 47 language tag ("en-US", "de-DE", "ar-EG") for how the number is shown and read: its digits and its decimal separator. Empty uses the platform's current locale. The value itself is a number in every locale. — Number input
invalidText string "" The words for an input committed with a text that is not a number ("Enter a number"): given to the Field that frames it, which shows them as its error text and, while they are empty, shows its own errorText (NMI-21, FLD-28). — Number input Shown by the Field, in its supporting row (FLD-28).

Slots

Slot Descripción
label-icon A glyph before the label. — Field

Eventos

Evento Descripción
input The person changed the text, or a step changed the value; carries the number the text reads as — not clamped, not rounded — or the empty value while it reads as none. Emitted for every change, not when the product sets value. What a Slider beside the field follows. — Number input
change A commit changed the value: focus left the field, the action key was pressed, a key or a stepper stepped it, or a held stepper was released; carries the value. — Number input
action The person pressed the keyboard's action key (Enter, Return, Done). — Number input
entryError The person committed a text that is not a number; carries the reason (invalid) and invalidText, the words the input has for it. The entry error itself is shown by the Field that frames the input (NMI-21). — Number input

Estados

Comportamiento

Requisitos en formato EARS. Cada implementación de plataforma se prueba contra estos identificadores. El texto de los requisitos se muestra tal como está en la especificación, en inglés.

ID Requisito
NUM-47 THE number field SHALL be a Field that frames one number input, and nothing else. It SHALL give label, labelHidden, supportingText, errorText, error, disabled, required, optional, requiredMark, requiredText and optionalText to its Field and every other prop to its number input, each unchanged; SHALL hold the label-icon slot for its Field; and SHALL emit its number input's events as its own, each once. THE number field SHALL be as wide as the place it stands in, and its number input SHALL fill it: it is a block with no width of its own, as its Field is (FLD-1), around a control that fills the width it is given (NMI-36). It SHALL draw no part of its own, hold no state of its own and have no token of its own: what it shows, how it behaves and what it exposes to assistive technology SHALL be exactly what that Field and that number input do when a product places the one in the other (FLD-1 to FLD-28; NMI-1 to NMI-46) — the label row and its requirement mark (FLD-2 to FLD-6), or the label that floats in the box with the Field's row left out (FLD-25, NMI-7, NMI-8); the supporting row and the error (FLD-7 to FLD-9, FLD-26); the name, the description and the states (FLD-10, FLD-11, FLD-14, NMI-12, NMI-32); a text that is not a number shown as an error in the Field's row, in the input's words (FLD-28, NMI-21); and the two steppers, which are the number input's Buttons and stand inside its box (NMI-25).
NUM-48 WHERE the platform has forms (the web) THE number field SHALL be the one control the form sees: it SHALL take name, submit its number input's value as that input submits it — a decimal number with ASCII digits and a period, or an empty string WHILE it holds none (NMI-35) — reset to the value it was first given, restore it on navigation, report to the form's constraint validation exactly what its number input would report there (a missing value WHILE required is true and it holds none, NMI-12; a bad input WHILE an entry error lasts, NMI-21), and be left out WHILE disabled is true or a disabled group of the form holds it; its number input and its Field SHALL take no part in the form themselves. WHEN the action key asks for the form's submission (NMI-20) the form asked SHALL be the number field's own.
NUM-49 WHEN the number field is given focus — by the product, by a press on any part of it that FLD-12 or NMI-14 gives to the input, or by a form that reports its validity — THE number field SHALL pass the focus to its number input and SHALL add no stop to the focus order: it has one stop, its input, and the steppers are none (NMI-25). A press on a stepper SHALL step and move no focus, in the number field as in the bare input (NMI-26). WHILE focus is inside it THE number field SHALL count as focused for its Field (FLD-13).
NUM-50 IF the number field is placed in a Field THE number field SHALL in debug builds report that it is a field already and that the bare control is the number input, and both SHALL still render (FLD-15). WHILE it stands in a field group THE number field SHALL follow that group's disabled, through its own Field, and take nothing else from the group (FGR-14).
NUM-51 THE number field SHALL have no words of its own and SHALL read none: requiredText and optionalText are read by its Field (FLD-24), incrementLabel and decrementLabel by its number input (NMI-44), each from the instance's prop and then from the product's words.
NUM-52 WHERE the platform has ARIA attributes (the web), WHEN the product sets an aria- attribute on the host, by the attribute or by the ARIA property that reflects it, THE number field SHALL move it to the data-aria- attribute of the same name, so that the host is no second node with its name, description or state, and SHALL expose it on the element that carries its role — an id reference by the elements it names in the host's tree or a tree around it, an error message as part of the description while the number field is invalid — except those the number field owns (aria-label, aria-labelledby, aria-disabled), which it SHALL move and not expose: its name is label (NUM-47). WHEN the product removes the aria- attribute or its data-aria- twin, or sets the ARIA property that reflects it (ariaLabel, ariaDescribedByElements…) to null, THE number field SHALL take it off that element. WHEN the product sets an aria- attribute the number field owns THE number field SHALL report it in debug builds.

Correspondencia de nombres por plataforma

Paridad no significa API idénticas. Cada plataforma expresa el mismo contrato con su propio estilo.

Especificación Web SwiftUI Jetpack Compose Flutter React Native
Componente tanrei-number-field TanreiNumberField TanreiNumberField TanreiNumberField NumberField
variant · Propiedad variant variant variant variant variant
size · Propiedad size size size size size
value · Propiedad value value value value value
label · Propiedad label label label labelText label
labelHidden · Propiedad labelHidden labelsHidden labelHidden labelHidden labelHidden
placeholder · Propiedad placeholder prompt placeholder hintText placeholder
supportingText · Propiedad supportingText supportingText supportingText helperText supportingText
errorText · Propiedad errorText errorText errorText errorText errorText
error · Propiedad error error isError isError error
disabled · Propiedad disabled disabled enabled enabled disabled
readOnly · Propiedad readOnly readOnly readOnly readOnly readOnly
required · Propiedad required isRequired required required required
optional · Propiedad optional isOptional optional optional optional
requiredMark · Propiedad requiredMark requiredMark requiredMark requiredMark requiredMark
requiredText · Propiedad requiredText requiredText requiredText requiredText requiredText
optionalText · Propiedad optionalText optionalText optionalText optionalText optionalText
min · Propiedad min in min min min
max · Propiedad max in max max max
step · Propiedad step step step step step
steppers · Propiedad noSteppers steppers steppers steppers steppers
incrementLabel · Propiedad incrementLabel incrementLabel incrementContentDescription incrementSemanticLabel incrementAccessibilityLabel
decrementLabel · Propiedad decrementLabel decrementLabel decrementContentDescription decrementSemanticLabel decrementAccessibilityLabel
prefixText · Propiedad prefixText prefix prefix prefixText prefix
suffixText · Propiedad suffixText suffix suffix suffixText suffix
valueText · Propiedad valueText valueText stateDescription semanticValue valueText
align · Propiedad align align align align align
minFractionDigits · Propiedad minFractionDigits minFractionDigits minFractionDigits minFractionDigits minFractionDigits
maxFractionDigits · Propiedad maxFractionDigits maxFractionDigits maxFractionDigits maxFractionDigits maxFractionDigits
locale · Propiedad locale locale locale locale locale
invalidText · Propiedad invalidText invalidText invalidText invalidText invalidText
input · Evento input onInput onInput onInput onInput
change · Evento change value onValueChange onChanged onValueChange
action · Evento action onSubmit keyboardActions onSubmitted onSubmitEditing
entryError · Evento entryerror onEntryError onEntryError onEntryError onEntryError
Notas The tag is tanrei-number-field, the class TanreiNumberField, the React name NumberField. Members: <tanrei-field> holding one <tanrei-number-input> in its default slot; the product places none. The host is display: block, as the Field is, so a number field is as wide as its place and its input fills it (NUM-47, NMI-36). Value member: tanrei-number-input. The host is the form's element — name, the value and its state as the input gives them (the decimal string, or nothing while disabled), validity anchored on the input (valueMissing, badInput), reset to the value attribute, restore, form, a disabled fieldset — and the input inside has no name. The value property is number | null and the attribute a decimal string, declared as the member declares them. Props, set as properties on the member each is from. On the Field: label, labelHidden, supportingText, errorText, error, disabled, required, optional, requiredMark, requiredText, optionalText. On the number input: variant, size, value, placeholder, readOnly, min, max, step, noSteppers (the inverse of steppers, attribute no-steppers), incrementLabel, decrementLabel, prefixText, suffixText, valueText, align, minFractionDigits, maxFractionDigits, locale, invalidText. Attributes are the members' own: kebab-case, except readonly, min, max and step. Props of one name on both members — label, labelHidden, error, disabled — are the Field's; the input's are never set by the element and reach the input through the connection. Events: input, change, action and entryerror are the number input's own composed events and leave by themselves, with the host as their target and value already new at change; action stays cancelable. None is stopped and none is copied; a stepper's own click is the Button's and is not an event of the spec. Slots: label-icon is passed to the Field by a slot element of the same name, rendered only while the host has a child for it. The element has no other slot: the steppers are the input's own Buttons, not the product's children. Parts: the member hosts are field and number-input. Exported from the Field: label, label-icon, requirement-label, supporting-text. Exported from the number input: container, outline, active-indicator, label, requirement-label, input, prefix, suffix, stepper. Two names collide, label and requirement-label. Each is exported with its member's name before it, always (field-label, number-input-label, field-requirement-label, number-input-requirement-label), and under the bare name from both members as well, because the two are one thing to a person and are never drawn at once: FLD-25 is the sentence that holds it. stepper is a part of a member's small part: the number input exports the two Buttons' hosts under that name, and nothing of the Button's inside is exported. Focus: the shadow root does not delegate. focus() and blur() call the number input's; a press on the label row focuses the input by FLD-12, a press on the box by NMI-14, a press on a stepper steps and moves no focus (NMI-26), and a press on the help does nothing. The connection is the Field's with its control (FLD-25, FLD-26, FLD-28; NMI-45); the element takes no part in it. Parts and tokens of its own: none. The element writes no custom property: --tanrei-comp-field-*, --tanrei-comp-input-box-*, --tanrei-comp-number-input-* and, for the steppers, --tanrei-comp-button-* reach the members by inheritance, and one number field is set apart by setting any of them on the element. What its twin cannot do that it does: nothing. The twin: <tanrei-field label="Quantity" supporting-text="Up to 99 per order." required><tanrei-number-input name="quantity" min="1" max="99" increment-label="Increase" decrement-label="Decrease"></tanrei-number-input></tanrei-field>. Words: none of its own (NUM-51). Not built on this platform yet: the number input as a view of its own, and this as the Field around it. Its name, its props and its idiom: TanreiNumberField("Quantity", value: $quantity, in: 1...99, step: 1), shaped as the platform's own pair, TextField(_:value:format:) and Stepper(value:in:step:): value is a Binding<Double?> (and an overload for Binding<Int?>, which sets maxFractionDigits to 0), written on every commit, which is the change event; min and max are one optional ClosedRange or partial range. Built on TextField with .keyboardType(.decimalPad) (.numbersAndPunctuation where a minus sign is needed) and a FormatStyle from locale. labelHidden follows .labelsHidden(), disabled follows .disabled(_:), action is onSubmit:. The field carries .accessibilityAdjustableAction for increment and decrement and .accessibilityValue with the value text; the steppers are TanreiButtons with .focusable(false). The drawing is Tanrei's on every Apple platform; Stepper itself is not used to draw. The product's words are read from the \.tanreiWords environment value. Not built on this platform yet: the number input as a view of its own, and this as the Field around it. Its name, its props and its idiom: Compose idiom, as TextField: TanreiNumberField(value: Double?, onValueChange: (Double?) -> Unit, label = "Quantity", min = 1.0, max = 99.0); the caller keeps value (state hoisting) and onValueChange is called on a commit, onInput while typing. enabled is the inverse flag and isError, readOnly, prefix and suffix keep Compose's names. Built on BasicTextField with KeyboardOptions(keyboardType = KeyboardType.Decimal) (Number while maxFractionDigits is 0) and java.text.DecimalFormat for locale. Semantics: Role has no spin button, so the field sets stateDescription (the value text), ProgressBarRangeInfo for the limits and setProgress, plus custom accessibility actions for increase and decrease; the steppers are TanreiButtons with Modifier.focusProperties { canFocus = false }. A held stepper repeats from pointerInput with the component's own timings. The product's words are read from LocalTanreiWords. Not built on this platform yet: the number input as a view of its own, and this as the Field around it. Its name, its props and its idiom: Flutter idiom, as TextField and InputDecoration: TanreiNumberField(value: 12, onChanged: (num? v) {…}, labelText: 'Quantity', min: 1, max: 99), with hintText, helperText, errorText, prefixText, suffixText and enabled keeping InputDecoration's names, enabled the inverse flag. TanreiNumberFormField wraps it as a FormField<num?> (validator, onSaved, autovalidateMode). Built on TextField with TextInputType.numberWithOptions(decimal:, signed:) and no input formatter that refuses characters (NMI-16); formatting and parsing use NumberFormat from the intl package with locale. Semantics(value:, increasedValue:, decreasedValue:, onIncrease:, onDecrease:) makes it adjustable; the steppers are TanreiButtons with canRequestFocus: false. Tabular figures are FontFeature.tabularFigures(). The product's words are read from the TanreiWords inherited widget, which the app fills from its own localizations. Not built on this platform yet: the number input as a view of its own, and this as the Field around it. Its name, its props and its idiom: React Native idiom, as TextInput: <NumberField label="Quantity" value={quantity} onValueChange={setQuantity} min={1} max={99} /> with value: number | null. Built on TextInput with inputMode="decimal" ("numeric" while maxFractionDigits is 0; keyboardType="numbers-and-punctuation" on iOS where a minus sign is needed, because its decimal pad has none). accessibilityRole="adjustable", accessibilityValue={{ min, max, now, text }} and accessibilityActions increment and decrement with onAccessibilityAction; the steppers are Buttons with focusable={false}. Formatting uses Intl.NumberFormat where the engine has it (Hermes does) and falls back to ASCII digits with the locale's separator. fontVariant: ['tabular-nums']. Follows the app's direction where an ancestor's is not known. The product's words are read from the TanreiWordsProvider context.

Tokens

Token Alias de Valor resuelto (claro)
--tanrei-comp-field-counter-gap sys.space.space200 16px
--tanrei-comp-field-error-text-gap sys.space.space50 4px
--tanrei-comp-field-error-text-placement — 0
--tanrei-comp-field-label-icon-gap sys.space.space100 8px
--tanrei-comp-field-label-icon-size sys.icon.small 20px
--tanrei-comp-field-label-gap sys.space.space100 8px
--tanrei-comp-field-motion-state-duration sys.motion.role.state.default 250ms
--tanrei-comp-field-motion-state-easing sys.motion.easing.state cubic-bezier(0.2, 0, 0, 1)
--tanrei-comp-field-requirement-asterisk-gap sys.space.space25 2px
--tanrei-comp-field-requirement-gap sys.space.space100 8px
--tanrei-comp-field-requirement-mark sys.behavior.requirement-mark 0
--tanrei-comp-field-standard-counter-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-disabled-counter-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-text-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-counter-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-label-icon-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-label-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-required-asterisk-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-supporting-text-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-error-value-text-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-label-icon-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-label-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-required-asterisk-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-supporting-text-color — #1b1b1b · 38%
--tanrei-comp-field-standard-disabled-value-text-color — #1b1b1b · 38%
--tanrei-comp-field-standard-error-text-color sys.color.error #cd262f
--tanrei-comp-field-standard-error-counter-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-error-label-icon-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-error-label-color sys.color.on-surface #1b1b1b
--tanrei-comp-field-standard-error-required-asterisk-color sys.color.primary #1b1b1b
--tanrei-comp-field-standard-error-supporting-text-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-error-value-text-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-focused-counter-color — #4b4b4b
--tanrei-comp-field-standard-focused-error-text-color — #cd262f
--tanrei-comp-field-standard-focused-error-counter-color — #4b4b4b
--tanrei-comp-field-standard-focused-error-label-icon-color — #4b4b4b
--tanrei-comp-field-standard-focused-error-label-color — #1b1b1b
--tanrei-comp-field-standard-focused-error-required-asterisk-color — #1b1b1b
--tanrei-comp-field-standard-focused-error-supporting-text-color — #4b4b4b
--tanrei-comp-field-standard-focused-error-value-text-color — #4b4b4b
--tanrei-comp-field-standard-focused-label-icon-color — #4b4b4b
--tanrei-comp-field-standard-focused-label-color — #1b1b1b
--tanrei-comp-field-standard-focused-required-asterisk-color — #1b1b1b
--tanrei-comp-field-standard-focused-supporting-text-color — #4b4b4b
--tanrei-comp-field-standard-focused-value-text-color — #4b4b4b
--tanrei-comp-field-standard-label-icon-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-label-color sys.color.on-surface #1b1b1b
--tanrei-comp-field-standard-required-asterisk-color sys.color.primary #1b1b1b
--tanrei-comp-field-standard-supporting-text-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-standard-value-text-color sys.color.on-surface-variant #4b4b4b
--tanrei-comp-field-supporting-text-gap sys.space.space50 4px
--tanrei-comp-field-value-text-gap sys.space.space200 16px
--tanrei-comp-field-label-typescale sys.typescale.label 500 14px/1.4286
--tanrei-comp-field-supporting-text-typescale sys.typescale.label-small 500 12px/1.3333
--tanrei-comp-field-value-text-typescale sys.typescale.label 500 14px/1.4286

Fixtures

Representaciones canónicas. Todas las plataformas capturan cada fixture con el mismo identificador para poder comparar los resultados.

Generado a partir de specs/number-field.spec.json, tokens/comp/field.tokens.json, design/tokens/

Qué dibuja la web de otra manera

  • El shadow root del elemento contiene un <tanrei-field> con un <tanrei-number-input> dentro. Importar el campo numérico define ambos.
  • El campo numérico es un elemento asociado a formularios, y el único control con el que trata su formulario. Recibe name y envía su valor como un número decimal simple (12.5), muestre lo que muestre la configuración regional. Se restablece al valor del atributo value, y notifica al formulario que falta un valor mientras required y no contiene ninguno, y que la entrada es incorrecta mientras su texto no es un número.
  • Es un bloque tan ancho como su lugar. En un lugar que no da ningún ancho, una etiqueta larga lo hace más ancho que su caja: dale ahí un ancho.
  • Las partes son las de los miembros, con sus propios nombres: label, label-icon, requirement-label y supporting-text del campo; container, outline, active-indicator, input, prefix, suffix y stepper de la entrada numérica. label y requirement-label llegan a la de los dos que se dibuje; field-label y number-input-label llegan a una sola. Los dos miembros son las partes field y number-input.
  • El detail.text de entryerror es el invalidText de la entrada, vacío donde no se dio ninguno. Los tipos del detalle son los de la entrada numérica: TanreiNumberInputInputDetail y TanreiNumberInputEntryErrorDetail.
  • steppers es el atributo inverso no-steppers, y readOnly es readonly.
  • input es un CustomEvent con detail.value. change y action son eventos simples: lee value del elemento. Salvo que action se cancele, a continuación se pide al formulario que se envíe.
  • Sin locale, el campo lee el atributo lang más cercano y, después, el idioma del navegador.
  • Además del separador de la configuración regional, un punto se lee como separador decimal siempre que la configuración regional no agrupe con puntos.
  • Una tecla de página da diez pasos sobre la cuadrícula del propio paso, como la de un deslizador: con un paso de 2, Re Pág desde 42 da 62, y luego 82.
  • En iOS y iPadOS, el campo pide el teclado completo mientras se pueda escribir un número negativo, porque allí el teclado decimal no tiene signo menos.
  • Antes de que el elemento esté definido, no tiene tamaño. Reserva la altura.

Pautas

Campo numérico, campo de texto o control deslizante

Aspecto Campo numérico Campo de texto Control deslizante
Contiene Un número Cualquier texto Un número dentro de un intervalo
Se elige Escribiendo o dando pasos Escribiendo Arrastrando
Va bien para Un valor que se conoce Dígitos que no son una cantidad Un valor que se elige a ojo

Un código postal, un número de tarjeta, un número de teléfono y un código de un solo uso son dígitos, pero no cantidades: nadie le suma uno a un código postal. Usa para ellos un campo de texto.

Recomendado

  • Escribe una etiqueta que nombre lo que se cuenta, y mantenla visible en un formulario.
  • Pon la unidad en suffixText y un signo de moneda en prefixText.
  • Da un valueText donde el sufijo se leería mal: «1,5 veces» para ×.
  • Escribe invalidText de modo que diga qué hay que escribir: «Introduce un número.»
  • Define maxFractionDigits en 0 para los números enteros. El teclado no tiene entonces separador.
  • Da incrementLabel y decrementLabel, en el campo o una sola vez para todo el producto con setWords(). Tanrei no incluye textos propios: un botón de paso sin nombre se dibuja igualmente y sigue dando pasos con un puntero, y queda oculto para la tecnología de apoyo, donde el botón de número da los pasos por sí mismo.

Evita

  • No uses un campo numérico para dígitos que no son una cantidad.
  • No guardes con input. Se emite con cada pulsación de tecla; change lleva el valor confirmado.
  • No esperes que min y max corrijan un valor que defines tú. Se aplican a lo que la persona confirma.
  • No pongas dentro del campo un control para elegir la unidad. Pon un select a su lado.
  • No pongas un campo numérico dentro de un campo. Ya es un campo; el control que un campo enmarca es la entrada numérica.
  • No ocultes la etiqueta de un campo numérico para poner la caja bajo una etiqueta tuya. Usa la entrada numérica.

Accesibilidad

Rol
spinbutton
Etiquetado
The number field adds nothing to what its members expose and coordinates nothing: the Field gives the number input its name, its description and its required, invalid and disabled states (FLD-8, FLD-10, FLD-11, FLD-14), and the number input carries them on its own element with its value, its limits and its value text (NMI-12, NMI-34). Assistive technology meets one spin button named by label and two buttons that are no focus stops, exactly as it meets a Field around a number input written by hand.
Objetivo mínimo
El área de pulsación cumple el tamaño mínimo de objetivo aunque el tamaño visual sea menor. minimum 32px · pointer 44px · spacing 8px · touch 48px

Teclado

Teclas Acción
Every key The number input's (its accessibility block; NMI-20, NMI-23). The number field handles no key and adds no focus stop (NUM-49).

Notas

  • One level down is the same thing: a Field with a number input in it. Every fixture has that pair as its twin, and the accessibility tree of the two is the same (NUM-47).
  • On the web the two members stand in the number field's own shadow root, so the form meets the number field and not the input (NUM-48); focus passes through to the input (NUM-49).
  • Two levels down, for a number whose label is elsewhere and that shows no message, is the number input alone, named by its own label: beside a slider under one row title, in a table, in a toolbar.

Generado a partir de specs/number-field.spec.json, tokens/sys/measure.tokens.json

De qué se encarga el componente

  • La entrada es un botón de número (spin button). Su nombre es label, tanto si se dibuja como si se oculta, y nunca el marcador de posición.
  • Su valor es el número confirmado, y sus límites son min y max.
  • El texto de apoyo o de error que se muestra es su descripción, con optionalText mientras el campo es opcional.
  • Se expone como no válido mientras error es true o su texto no es un número, como obligatorio mientras required está activado, y como de solo lectura.
  • Un error que aparece mientras el campo tiene el foco se anuncia una vez, de forma cortés; también un texto que no es un número.
  • Los botones de paso son botones que reciben su nombre de decrementLabel y de incrementLabel; uno al que nadie dio nombre queda oculto para la tecnología de apoyo. Están fuera del orden del foco, porque las teclas de flecha dan los pasos desde la entrada; quien explora la pantalla con el tacto los encuentra igualmente.
  • Una pulsación en un botón de paso no mueve el foco, así que no hace aparecer el teclado en pantalla.
  • Mientras un método de entrada está componiendo, el campo no lee nada y no gestiona ninguna tecla.
  • La rueda del ratón nunca cambia el número.
  • El área de pulsación del campo cumple el objetivo mínimo, y cada botón de paso es un objetivo completo.
  • Con el texto al 200%, la etiqueta y la ayuda saltan de línea. El número se queda en una sola línea, y se desplaza.
  • Donde la fila no puede contener el número y los botones de paso uno al lado del otro —con el texto al 200% en una ventana estrecha, con un prefijo y un sufijo largo—, los botones de paso pasan a una fila propia debajo del número, al final de la caja. Nunca se ocultan, porque en una pantalla táctil son la única forma de dar pasos.
  • Con colores forzados, el campo gana un borde, y un error se distingue por sus palabras y por el estado no válido.
  • En un diseño de derecha a izquierda, los botones de paso y la etiqueta se reflejan: los botones de paso quedan en el extremo izquierdo. El número y su unidad se escriben como los escribe la escritura de la propia unidad: una unidad en letras o signos latinos después del número, de izquierda a derecha, y una unidad en la escritura de la página a la izquierda del número. Lo que se lee en voz alta no cambia.

Carencias conocidas en la web:

  • Chromium lee el número sin su unidad: obtiene el texto del valor a partir del texto que hay en la entrada, y pasa por alto el que indica el campo. Nombra la unidad en la etiqueta donde importe.
  • Antes de que el elemento esté definido, no se dibuja nada.

Qué debes hacer tú

  • Da un label a cada campo numérico.
  • Escribe invalidText en el campo. Da requiredText, optionalText, incrementLabel y decrementLabel en el campo, o una sola vez para todo el producto con setWords(). Tanrei no incluye textos propios; si falta uno, se notifica en desarrollo. Consulta Los textos del producto.
  • Valida tú el valor, activa error y escribe errorText de modo que diga cómo corregir el número.
  • Da el mismo nombre a un control deslizante y a la entrada numérica que tiene al lado.