',
optional: true,
default: 'undefined',
},
}}
/>
### Descripción
| Prop | Descripción |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `variables` | Un objeto en el que las claves identifican en qué parte de la cadena se asigna cada valor. |
| `$context` | Opcionalmente, incluye `$context` como una variable en el objeto `variables` para aportar contexto al contenido (usado para su traducción). |
| `$id` | Opcionalmente, incluye `$id` como una variable en el objeto `variables` para proporcionar un identificador para usar con el editor de traducción. |
| `$maxChars` | Opcionalmente, incluye `$maxChars` como una variable para limitar la cantidad de caracteres de la traducción. La biblioteca aplica estrictamente este límite mediante la lógica de `formatCutoff()`. |
***
## Ejemplos
### Contexto
Para añadir contexto a la cadena, usamos la prop `$context`.
```jsx title="Component.tsx"
// [!code word:$context]
import { useGT } from 'gt-react';
const Component = () => {
const gt = useGT();
return {gt('Hello, world!', { $context: 'un saludo formal' })}
;
};
```
### Paso de variables
Para añadir una variable a la cadena, usamos la sintaxis `{variable-name}`, donde las llaves encierran el nombre de la variable.
```jsx title="Component.tsx"
// [!code word:username]
import { useGT } from 'gt-react';
const Component = () => {
const gt = useGT();
return {gt('Hello, {username}! How is your day?', { username: 'Brian123' })}
;
};
```
### Uso del formato de mensajes ICU
`gt-react` admite el formato de mensajes ICU, lo que también te permite dar formato a las variables.
```jsx title="Component.tsx"
// [!code word:account-balance]
import { useGT } from 'gt-react';
const Component = () => {
const gt = useGT();
return
{ gt(
'Your account balance: {dollars, number, ::currency/USD}!',
{
"dollars" : 1000000,
}
) }
;
};
```
Consulte la [documentación del formato de mensajes ICU](https://unicode-org.github.io/icu/userguide/format_parse/messages/) para obtener más información.
### Límites de caracteres
Usa `$maxChars` para limitar la longitud de la traducción:
```jsx title="Component.tsx"
// [!code word:$maxChars]
import { useGT } from 'gt-react';
const Component = () => {
const gt = useGT();
return {gt('Welcome to our application', { $maxChars: 15 })}
;
// Salida: "Bienvenue à no\u202F…"
};
```
***
## Notas
* `InlineTranslationOptions` se usa para la traducción de cadenas en línea.
* El objeto `variables` pasa valores al texto.
* El objeto `variablesOptions` define el comportamiento de las variables.
## Próximos pasos
* Consulta [`useGT`](/docs/react/api/strings/use-gt) para obtener más información sobre la traducción de cadenas en línea.
* Consulta [`formato de mensajes de ICU`](https://unicode-org.github.io/icu/userguide/format_parse/messages/) para obtener más información sobre las opciones de formato.