enes

Label

Un Label proporciona un texto accesible que describe un control de formulario. Admite distintos tamaños y grosores, puede marcarse como obligatorio o deshabilitado, y puede posicionarse respecto al control que envuelve.

Uso

<script>
	import { Label, TextBox } from 'fluentui-svelte';
</script>

<Label label="Email"><TextBox /></Label>

Tamaño

Usa la propiedad size para controlar el tamaño del texto de la etiqueta. Valores posibles: 'small', 'medium', 'large'.

Grosor

Usa la propiedad weight para alternar entre una etiqueta regular y una semibold.

Posición de la etiqueta

Usa la propiedad labelPosition para colocar el texto de la etiqueta respecto al control que envuelve. Valores posibles: 'before', 'after', 'above', 'below'.

Obligatorio

Pasa un objeto required para marcar la etiqueta como obligatoria y mostrar un indicador, que por defecto es un asterisco.

Tooltip

Pasa tooltipContent, como texto, snippet o componente, para mostrar más información sobre el campo en un tooltip desde un badge tras el texto de la etiqueta. El badge es un botón con el nombre de la etiqueta, así que también llegan a él quienes usan el teclado o un lector de pantalla; tooltipBadge sustituye su icono de información y tooltipButtonAttributes su aria-label. No se puede entrar en un tooltip, así que no pongas enlaces ni botones en él.

Etiquetar controles de formulario

Un control dentro de Label no necesita id ni for. El texto propio de un Checkbox, RadioButton o ToggleSwitch dentro de Label no se renderiza: el Label da nombre al control. Un <label for> nativo fuera de un Label da nombre a un picker (Dropdown, TagPicker, DatePicker, TimePicker, CalendarDatePicker) solo cuando la página se hidrata, porque el picker lo lee de la página: al renderizar en el servidor, usa Label o pasa aria-labelledby. Un campo con id propio lo conserva: cuando el texto va antes del campo (labelPosition 'before' o 'above', el valor por defecto), pasa también ese id a for, o el label que escribe el servidor no apunta a ningún campo hasta que la página se hidrata.

Atributos de los controles de formulario

Label muestra el texto y el campo como elementos hermanos, y es la etiqueta del primer campo que contiene, que toma el id de la etiqueta si no tiene uno propio. Pasa for para asociar la etiqueta con otro campo. Los atributos HTML, class y ref se aplican al elemento de texto de la etiqueta; wrapperAttributes y wrapperRef se aplican al contenedor. El tamaño y el peso solo afectan al texto de la etiqueta.

Propiedades del componente

NameTypeDefaultDescription
as'div' | 'span''div'El elemento que contiene la etiqueta y su campo.
childrenSnippetEl campo descrito por la etiqueta, mostrado junto al texto de la etiqueta.
wrapperRef bindableHTMLDivElement | HTMLSpanElementLa referencia DOM del elemento contenedor.
wrapperAttributesHTMLAttributesLos atributos que se aplican al elemento wrapper.
labelstring'Label Element'El texto de la etiqueta.
size'small' | 'medium' | 'large''medium'El tamaño del texto de la etiqueta.
weight'regular' | 'semibold''regular'El grosor del texto de la etiqueta.
labelPosition'before' | 'after' | 'above' | 'below''after'Dónde se sitúa la etiqueta respecto al campo que describe.
required{ abbr?: string; message: string; }Marca el campo como obligatorio, y explica por qué mediante el mensaje indicado.
disabledbooleanRenderiza la etiqueta como deshabilitada, para que coincida con el campo que describe.
ref bindableHTMLLabelElement | nullLa referencia DOM del elemento label.
idstringGeneratedEl id del elemento label. Un control dentro de la etiqueta recibe su nombre de ella, incluido un picker cuyo control visible sustituye a su campo nativo.
forstringThe field insideEl id del campo al que corresponde la etiqueta. Sin él, la etiqueta corresponde al primer campo que contiene, que toma un id generado si no tiene uno propio. Con labelPosition before o above y un campo con un id propio, pasa ese id aquí para que el servidor también renderice la asociación.
tooltipContentstring | Snippet | ComponentMás información sobre el campo, en un tooltip que se muestra desde un badge tras el texto de la etiqueta, al pasar el puntero y al recibir el foco. No se puede entrar en un tooltip, así que no pongas enlaces ni botones en él.
tooltipBadgeSnippet | ComponentInfoRegularLo que muestra el badge que abre el tooltip. Solo se renderiza con tooltipContent.
tooltipPropsTooltipPropsLas props que se aplican al tooltip.
tooltipButtonAttributesHTMLButtonAttributesLos atributos que se aplican al botón del badge. Su nombre es el texto de la etiqueta seguido de su aria-label.
HTMLLabelAttributes without for
Editar este documento Ver como Markdown