Ecrãs auxiliares

Um dashboard tem sempre um ecrã principal e pode ter quantos ecrãs auxiliares precisar. São eles que dão o detalhe.

O que são

Um ecrã auxiliar é desenhado no mesmo editor, com os mesmos widgets e as mesmas consultas que o principal. A diferença está em como aparece: por cima do ecrã que o chama, em modal central ou em painel lateral.

Pertencem ao dashboard:

• acompanham-no ao duplicar e ao exportar, com os identificadores internos remapeados;
• são apagados com ele;
• nunca aparecem na lista de dashboards.

Criar

No editor, o seletor de ecrãs no topo mostra o ecrã actual. O botão + cria um ecrã auxiliar novo, e o seletor permite alternar entre todos.

Apresentação

Nas propriedades do ecrã, a secção Apresentação decide como abre:

Propriedade	O que faz
Modo	Ecrã normal, modal central ou painel lateral
Largura	Largura do modal ou do painel, em píxeis
Altura	Altura do modal (o painel é sempre de altura total)
Mostrar título e Título	O cabeçalho
Mostrar descrição e Descrição	Uma linha por baixo do título
Botão de fechar	Mostrar ou esconder
Fechar ao clicar fora	Ligado ou desligado
Fechar com Escape	Ligado ou desligado
Refrescar ao fechar	Recarrega os conjuntos do ecrã de trás quando este fecha

A largura do modal é a régua do desenho

Um ecrã auxiliar usa a sua própria largura como régua das 48 colunas. Num modal de 960 px, cada coluna mede 20 px em vez dos 26,7 de um ecrã web. É por isso que o canvas do editor muda de largura quando se passa a editar um ecrã de detalhe.

Parâmetros

Um ecrã auxiliar recebe valores de quem o abre, através dos seus parâmetros. Declaram-se nas propriedades do ecrã, com nome e obrigatoriedade.

Dentro do ecrã, cada consulta usa o parâmetro numa condição — origem parâmetro. Ver Parâmetros de ecrã.

Abrir

Há três formas:

Configurando o detalhe num widget — a mais comum, e sem código. Ver Drill para o detalhe.

Com um widget de Link — escolhendo o ecrã de destino e a origem de cada parâmetro.

Por código, num evento:

const resultado = await keplin.ui.openModal("scr_detalhe", { produto: "Café Nortada Clássico 1kg" });

openModal devolve uma promessa que resolve quando o ecrã fecha, com o valor que o próprio ecrã passar em closeModal.

Fechar

Pelo botão, pela tecla de escape, clicando fora — conforme configurado — ou por código:

keplin.ui.closeModal({ confirmado: true });

Se Refrescar ao fechar estiver ligado, os conjuntos de dados do ecrã de trás recarregam quando este fecha.

Empilhar ecrãs

Um ecrã auxiliar pode abrir outro. O sistema mantém a pilha de ecrãs abertos, e fechar um devolve o controlo ao anterior.

Isto permite encadear detalhes — região, loja, produto — mantendo o contexto, porque um parâmetro do ecrã actual pode ser passado ao seguinte.

Dois níveis são confortáveis. A partir do terceiro, vale a pena perguntar se não seria melhor um dashboard próprio.

Quando usar

Use um ecrã auxiliar quando o detalhe tem vários widgets, quando depende de uma chave escolhida, ou quando abrir e fechar é mais natural do que navegar.

Não use para uma informação que caiba numa dica ou numa coluna a mais na tabela. Um modal para mostrar dois campos é ruído.