Variáveis e Modificadores
1. Como Utilizar Variáveis
Em contextos aplicáveis, os usuários podem utilizar variáveis usando a seguinte sintaxe:
{{ data.reference_do_campo }}
A referência do campo pode ser consultada na tela onde os campos são criados e sempre segue o formato snake_case baseado no nome do campo.
Exemplo
Se um usuário criou um campo chamado "Data de vencimento", a referência poderá ser:
{{ data.data_de_vencimento }}
2. Estrutura das Variáveis Disponíveis para Itens
Os usuários podem utilizar as seguintes variáveis quando existe um contexto de item:
| Variável | Descrição |
|---|---|
id | Identificador único numérico do registro |
reference | Identificador único do registro (ticket) |
created_at | Data de criação do registro |
updated_at | Data da última atualização do registro |
data | Contém todos os campos personalizados do usuário |
Dentro de data, estarão os campos personalizados, como:
{{ data.campo_01 }}{{ data.campo_02 }}
3. Aplicação de Modificadores (Mods)
Os usuários podem modificar as variáveis usando o sufixo especial __mod[] no final da variável:
{{ data.campo_01__mod[format?type=date&dt_style=short] }}
Explicação da Sintaxe
- O sufixo
__mod[]indica que uma modificação será aplicada. - Dentro dos colchetes
[], especificam-se as modificações e parâmetros no formato query string.
Modificadores Disponíveis
format→ Para formatar diversos tipos de dados (ex: datas).transformText→ Para transformar textos aplicando diferentes funções.
4. Como Usar o Modificador format
O modificador format permite personalizar a exibição dos dados de acordo com o tipo de informação (números, moedas, datas).
4.1. Estrutura da Sintaxe
A estrutura básica utiliza parâmetros semelhantes aos de uma URL:
{{ variavel__mod[format?parametro1=valor1¶metro2=valor2] }}
format→ Define o tipo de modificador.?→ Inicia a lista de parâmetros.parametro=valor→ Define um parâmetro e seu valor correspondente.&→ Separa múltiplos parâmetros.
Exemplo Prático: Formatação de Moeda
{{ data.valor_total__mod[format?type=number&n_style=currency&n_currency=USD] }}
type=number→ Indica que o valor é um número.n_style=currency→ Formata o valor como moeda.n_currency=USD→ Define a moeda como Dólar Americano.- Saída esperada:
$10.00
4.2 Lista de Parâmetros e Como Usá-los
📌 Parâmetros Gerais
| Parâmetro | Tipo | Descrição | Valor Padrão |
|---|---|---|---|
type | string | Define o tipo de dado a ser formatado. Aceita: text, date, number, boolean, list, object. | "text" |
locale | string | Define a localidade para formatação (ex: pt-BR, en-US). | Idioma do sistema |
📌 Parâmetros para type=date (Datas)
| Parâmetro | Tipo | Descrição | Valor Padrão |
|---|---|---|---|
d_style | string | Define o estilo da data (full, long, medium, short). | "short" |
dt_style | string | Define o estilo da hora (full, long, medium, short). | undefined |
dt_utc | boolean | Converte a data para UTC (true ou false). | false |
Exemplos Práticos
- Data Completa:
{{ data.custom_due_date__mod[format?type=date&d_style=full] }}
🔹 Saída: terça-feira, 8 de março de 2025 - Data e Hora Médias:
{{ data.server_time__mod[format?type=date&d_style=medium&dt_style=short] }}
🔹 Saída: 8 de mar. de 2025 13:30 - Data Curta com Hora Curta:
{{ data.server_time__mod[format?type=date&d_style=short&dt_style=short] }}Ss 🔹 Saída: 08/03/2025, 13:30
📌 Parâmetros para type=number (Números e Moedas)
| Parâmetro | Tipo | Descrição | Valor Padrão |
|---|---|---|---|
n_style | string | Define o formato do número (decimal, currency, percent). | "decimal" |
n_currency | string | Define a moeda (ex: BRL, USD, EUR). | "BRL" |
n_currencyDisplay | string | Define a exibição da moeda (symbol, code, name). | "symbol" |
n_minimumFractionDigits | number | Número mínimo de casas decimais. | undefined |
n_maximumFractionDigits | number | Número máximo de casas decimais. | undefined |
n_multiplier | number | Multiplicador aplicado antes da formatação. | 1 |
Exemplos Práticos: Números e Moedas
Abaixo estão exemplos práticos de como aplicar os parâmetros de formatação para números e multiplicadores:
- Formatação de Moeda (Dólar):
{{ data.preco__mod[format?type=number&n_style=currency&n_currency=USD] }}
🔹 Saída esperada:$10.00 - Formatação de Percentual com Casas Decimais:
{{ data.taxa__mod[format?type=number&n_style=percent&n_minimumFractionDigits=2] }}
🔹 Se o valor for0.075, a saída será:7,50% - Uso de Multiplicador (Conversão de Unidades):
{{ data.tempo__mod[format?type=number&n_multiplier=60] }}
🔹 Se o valor for2, a saída será:120(ex: converte horas para minutos)
📌 Parâmetros para type=text (Texto)
| Parâmetro | Tipo | Descrição | Valor Padrão |
|---|---|---|---|
t_length | number | Define o tamanho máximo do texto antes de truncar. | undefined |
t_suffix | string | Define o sufixo exibido ao truncar o texto (ex: ...). | "..." |
Exemplo:
{{ data.descricao__mod[format?type=text&t_length=20&t_suffix="..."] }}
🔹 Se o texto for "Este é um exemplo de texto muito longo", a saída será: "Este é um exemplo..."
📌 Parâmetros para type=list (Listas)
| Parâmetro | Tipo | Descrição | Valor Padrão |
|---|---|---|---|
l_separator | string | Define o separador entre itens da lista. | "<br/>" |
value_path | string | Obrigatório para type=list. Define o campo a ser extraído de cada item da lista. | undefined |
📢 value_path é obrigatório para type=list, pois ele determina de onde os valores serão extraídos dentro dos itens da lista.
Exemplo
{{ data.produtos__mod[format?type=list&value_path=name&l_separator=", "] }}
Se a lista contiver:
[
{ "name": "Product A" },
{ "name": "Product B" },
{ "name": "Product C" }
]
🔹 Saída esperada:Produto A, Produto B, Produto C
📌 Parâmetros para type=object (Objetos JSON)
| Parâmetro | Tipo | Descrição | Valor Padrão |
|---|---|---|---|
display_string | string | Define um formato de exibição alternativo para objetos. | undefined |
Exemplo
{{ data.detalhes__mod[format?type=object] }}
◆ Se o objeto contiver:
{
"nome": "João",
"idade": 30
}
🔹 Saída esperada:{"nome":"João","idade":30}
5. Como Usar o Modificador transformText
O modificador transformText permite realizar alterações no formato do texto. Ele aceita uma lista de opções dentro do parâmetro options.
Opções Disponíveis para transformText
| Opção | Descrição |
|---|---|
lowercase | Converte o texto para minúsculas |
uppercase | Converte o texto para maiúsculas |
deburr | Remove acentos e caracteres especiais |
stripTags | Remove todas as tags HTML |
trim | Remove espaços em branco no início e no final |
kebabCase | Converte o texto para kebab-case |
camelCase | Converte o texto para camelCase |
snakeCase | Converte o texto para snake_case |
dotCase | Converte espaços em pontos . |
capitalize | Capitaliza a primeira letra do texto |
startCase | Capitaliza todas as palavras |
titleCase | Capitaliza títulos, preservando preposições minúsculas |
numeroPorExtenso | Converte números em palavras (ex: 123 $\rightarrow$ cento e vinte e três) |
slugify | Transforma o texto em um formato amigável para URLs |
removeNumbers | Remove números do texto |
Exemplos de Uso do transformText
- Converter para maiúsculas
{{ data.nome_cliente__mod[transformText?options=uppercase] }} - Aplicar múltiplas transformações
(Remove espaços extras e capitaliza a primeira letra){{ data.nome_cliente__mod[transformText?options=trim&options=capitalize] }} - Remover acentos e converter para kebab-case
{{ data.titulo__mod[transformText?options=deburr&options=kebabCase] }} - Gerar um slug a partir de um título
{{ data.titulo__mod[transformText?options=slugify] }}