Skip to content

Widget Svelte ​

Tipo
Referência
Para
Desenvolvedor
Na tela
DataViz › Aplicação › Dashboards › Editar Widget › Svelte
Liberação
Em beta

O Widget Svelte é um Widget que você escreve em código: um componente Svelte 4 que lê os dados da Aplicação pelo objeto app e desenha o que quiser, de um gráfico de biblioteca a uma tela com abas e botões.

Qual escolher ​

Você precisaUse
Uma visualização que um Widget pronto já fazO Widget pronto. Veja Escolher um widget
Uma visualização ou interação que nenhum Widget pronto fazWidget Svelte
O mesmo código em vários Dashboards, com quem monta só preenchendo camposComponente paramétrico, feito a partir de um Widget Svelte

Quem mexe num Widget Svelte precisa ler código, e uma tabela renomeada que um Widget pronto acompanharia pode quebrá-lo.

Como funciona ​

FatoO que muda no código
O código é uma lista de arquivos. O primeiro, Main.svelte, é o que o Dashboard montaOs outros entram por import './Outro.svelte'
O compilador é Svelte 4, com Tailwind 3Sintaxe do Svelte 5 não funciona. Veja Boas práticas e Bibliotecas
O componente recebe uma propriedade, appDado por app.query, que já aplica os filtros do Dashboard e os Filtros do widget. Veja Objeto app
Trocar um filtro ou recarregar o Dashboard monta o Widget de novo, com um app novoVariáveis voltam ao valor inicial. O que precisa durar vai para um filtro, com app.addFilter
A compilação fica em cache pelo texto do códigoO mesmo código em dez Widgets compila uma vez
Erro ao compilar ou ao montar aparece no lugar do Widget, com o título Erro de compilaçãoNo editor do Dashboard, o quadro traz Editar Código e Corrigir com IA

Onde fica cada opção ​

O editor abre numa lateral. Editar código abre a Edição completa, com os arquivos, a IA e a prévia.

Na lateralO que tem
Código › Editar códigoAbre o código na Edição completa
Salvar como componentePede nome e categoria e transforma o Widget num componente paramétrico
Filtros do widgetFiltros que valem só para este Widget. Entram em toda consulta e vencem o filtro do código na mesma coluna
Comportamento › Crescer com o conteúdoO Widget cresce na altura conforme o conteúdo, na visualização e na exportação, nunca no editor. Exige largura total. Na tela, só cresce se todos os Widgets do Dashboard forem Svelte, de largura total e com a opção ligada; o editor diz qual condição falta
Comportamento › Cortar conteúdo que passa da bordaEsconde o que passa do tamanho do Widget, em vez de rolar. Não vale com Crescer com o conteúdo
Título, CartãoComo em todo Widget (Opções comuns). No Cartão, Borda desligada tira a moldura
Só na Edição completaO que tem
Lista de arquivos, Adicionar arquivoO primeiro arquivo é o principal: não muda de nome e não sai
Ver dados › Colunas extrasColunas extras do Ver dados, no menu do Widget
Ver dados › Filtros do relatórioEntram no relatório aberto por Ver dados. Não filtram o Widget
ObservaçãoComo em todo Widget

Sem a função de usar o gerador de relatórios, o atalho para o Explorer não aparece.

O que o código não pode fazer ​

O código roda no navegador de quem abre o Dashboard, com a sessão dessa pessoa. A consulta passa pelas mesmas regras de acesso de qualquer Widget: o código lê só o que essa pessoa pode ler.

Pelo mesmo motivo, qualquer pessoa vê o fonte nas ferramentas do navegador. Nunca ponha chave de API, senha ou token fixo no código; para falar com uma API sua, use app.generateJWTToken(). Quem o código enxerga como usuário muda no link público, na exportação e no alerta; veja Usuário.

A seção ​

PáginaPara
Seu primeiro Widget SvelteSair do zero com um Widget que consulta, formata, filtra e trata erro
Objeto appConsultar app.query e cada membro de app
Boas práticasUm Widget que não quebra em outro Tenant, no escuro ou no PDF
BibliotecasO que dá para importar
ExemplosPadrões prontos para copiar
Gravar em CadastroLer e gravar registros de um Cadastro
Componentes paramétricosTransformar o Widget num tipo reutilizável
Contrato do componenteDeclarar os campos do componente

Pelo Lumo CLI

O Widget Svelte também se cria em YAML, com type: Svelte, pelo Lumo CLI. lumo scaffold widget Svelte gera um modelo comentado. Veja a referência de app.