Components

<DateTime>

Referencia de API para el componente <DateTime>

Resumen

El componente <DateTime> renderiza una cadena de fecha u hora formateada, admitiendo personalización como opciones de formato y configuración regional. La fecha u hora se formatea de acuerdo con la configuración regional actual y cualquier parámetro opcional pasado.

<DateTime>{1738010355}</DateTime>
// Output: 1/27/2025

Todo el formato se maneja localmente utilizando la biblioteca Intl.DateTimeFormat.

Referencia

Props

PropTypeDefault
children??
any
undefined
name??
string
undefined
value??
string | number | Date
undefined
options??
Intl.DateTimeFormatOptions
{}
locales??
string[]
undefined

Descripción

Nombre del PropDescripción
childrenEl contenido para renderizar dentro del componente. Típicamente un valor de fecha o tiempo. Si se proporciona, tiene prioridad sobre la prop value.
valueEl valor predeterminado para la fecha o el tiempo. Puede ser una cadena, número (timestamp) u objeto Date.
optionsOpciones de formato opcionales para la fecha o el tiempo, siguiendo la especificación Intl.DateTimeFormatOptions. Usa esto para definir estilos como nombres de días de la semana, zonas horarias y más.
localesLocales opcionales para especificar el locale de formato. Si no se proporciona, se utiliza el locale del usuario. Lee más sobre cómo especificar locales aquí.

Retorna

JSX.Element que contiene la fecha o el tiempo formateado como una cadena.


Ejemplos

Uso básico

El componente <DateTime> se puede usar para mostrar valores de fecha u hora localizados.

EventDate.jsx
import { DateTime } from 'gt-next';
 
export default function EventDate(event) {
    return (
        <DateTime> {event.date} </DateTime>. 
    );
}

Especificando locales

El componente <DateTime> se puede usar para mostrar valores de fecha u hora en un locale específico.

EventDate.jsx
 
import { DateTime } from 'gt-next';
 
export default function EventDate(event) {
    return (
        <DateTime locales={['fr-FR']}> {event.date} </DateTime>. 
    );
}

Traduciendo <DateTime>

Supongamos que deseas que la fecha y hora se muestren en una oración que también se está traduciendo. Puedes envolver el componente <DateTime> en un componente <T>.

EventDate.jsx
import { T, DateTime } from 'gt-next';
 
export default function EventDate(event) {
    return (
        <T id="eventDate">
            La hora del evento es <DateTime> {event.date} </DateTime>. // [!code highlight]
        </T>
    );
}

Formato personalizado

El componente <DateTime> admite opciones de formato personalizado.

EventDate.jsx
import { DateTime } from 'gt-next';
 
export default function EventDate(event) {
    return (
        <DateTime options={{
            dateStyle: 'full', 
            timeStyle: 'long', 
            timeZone: 'Australia/Sydney', 
        }}>
            {event.date}
        </DateTime>.
    );
}

Notas

  • El componente <DateTime> es un componente variable que se puede usar para formatear valores de fecha y hora.
  • El componente utiliza la biblioteca Intl.DateTimeFormat para el formateo.

Próximos Pasos

  • Para más detalles y ejemplos de uso del componente <DateTime> y otros componentes de variables como <Currency>, <Num>, y <Var>, consulta la documentación de Uso de Componentes Variables.

En esta página