Status na matriz: Experimental.
Tabela (<dsgovbr-tabela>)
JS opcional (dsgovbr-bootstrapped-componentes.js) com as partes do Table do GOV.BR DS: tabela,
busca, filtros, menu de ferramentas (densidade), barra de itens selecionados e paginação. Usa só classes e plugins do
Bootstrap (.table, .table-responsive, .collapse, .dropdown,
.btn-group, .form-check, .input-group, .card, .badge), então o
bootstrap.bundle precisa estar carregado. O <table> é o do autor (HTML semântico); o
componente o decora.
Exemplo completo
| Usuário | Ativo | Ações | |
|---|---|---|---|
| Ana Pereira | ana.pereira@exemplo.gov.br | Sim | Editar Ana Pereira |
| João Souza | joao.souza@exemplo.gov.br | Sim | Editar João Souza |
| Carla Lima | carla.lima@exemplo.gov.br | Não | Editar Carla Lima |
Sem acao, busca e filtros não enviam nada: só disparam os eventos. Veja o último evento:
(nenhum ainda)
Estados: vazio e carregando
| Usuário |
|---|
| Usuário |
|---|
Uso
<dsgovbr-tabela titulo="Usuários" busca ferramentas selecionavel acao="/usuarios/"
total="42" por-pagina="10" opcoes-por-pagina="10,25,50" pagina="1"
paginacao-href="?p={pagina}">
<table> … <tr data-valor="7"> … </table>
<dsgovbr-filtro nome="ativo" rotulo="Ativo">
<dsgovbr-opcao valor="1">Sim</dsgovbr-opcao>
</dsgovbr-filtro>
<dsgovbr-lote-acao acao="excluir" icone="fas fa-trash">Excluir</dsgovbr-lote-acao>
<dsgovbr-acoes><button class="btn btn-primary">Adicionar</button></dsgovbr-acoes>
</dsgovbr-tabela>
tabela.addEventListener("dsgovbr:tabela-selecao", (e) => console.log(e.detail.valores));
| Atributo | Efeito |
|---|---|
titulo | Título da tabela (<h2>), à esquerda da barra de ferramentas. |
busca, busca-nome, busca-valor, busca-placeholder | Mostra a lupa que abre o campo de busca; name do campo (padrão q), valor inicial e dica (padrão "Buscar nesta listagem"). |
filhos <dsgovbr-filtro nome rotulo> | Mostram o funil e o painel de filtros: um dropdown por filtro (com <dsgovbr-opcao valor selecionada> como checkbox; unico no filtro aceita uma opção só, como rádio; valor-consulta trata o valor da opção como pedaço de query string, ex.: criado__gte=…&criado__lt=…, expandido em vários campos ao enviar), "Filtros:" com os aplicados, Filtrar e Limpar todos os filtros. |
acao | URL do <form method="get"> de busca e filtros: com ela o envio é nativo (servidor); sem ela, só os eventos. |
ferramentas, densidade | Menu de três pontos com "Densidade" (alta = .table-sm, media, baixa); o atributo reflete a escolha. |
selecionavel, selecao-nome | Coluna de checkboxes (name padrão selecionados; o valor vem de data-valor da linha) e barra "N itens selecionados" com as <dsgovbr-lote-acao acao icone>. |
total / total-paginas, pagina, por-pagina, opcoes-por-pagina, paginacao-href | Rodapé com <dsgovbr-paginacao compacta>; o evento dsgovbr:pagina sobe até a tabela. |
lote-metodo, lote-acao-url, lote-campo | Envio nativo das ações em lote (aplicações renderizadas no servidor): com lote-metodo="post" (ou get) o clique numa <dsgovbr-lote-acao> envia um <form> com a ação (campo lote-campo, padrão acao), os valores marcados (selecao-nome) e os <dsgovbr-campo-oculto nome valor> filhos (ex.: o token CSRF; para="consulta" os manda só na busca/filtros, para="ambos" nos dois) para lote-acao-url (padrão: a página atual). O evento dsgovbr:tabela-acao é cancelável: preventDefault() impede o envio. |
vazio, carregando | Mensagem sem linhas e estado carregando (aria-busy). |
Eventos (todos sobem): dsgovbr:tabela-busca e dsgovbr:tabela-filtro (detail:
termo, filtros; canceláveis), dsgovbr:tabela-selecao (quantidade,
valores), dsgovbr:tabela-acao (acao, valores) e
dsgovbr:tabela-densidade. Não aninhe o componente dentro de outro <form>.
Diferenças conhecidas em relação ao GOV.BR DS
- Não usa
.br-tablenem oBRTable: o<table>fica com as classes do Bootstrap e o componente cuida das ferramentas ao redor. - Sem ordenação, colunas fixas e rolagem infinita; a ordenação deve ser feita pela aplicação (
aria-sortnos cabeçalhos). - A linha selecionada usa
.table-activena cor--selecteddo GOV.BR DS; o seletor de página da paginação compacta é um<select>nativo. - O conteúdo é lido uma vez: linhas novas depois de montado não ganham checkbox sozinhas (remonte alterando um atributo).
- Experimental: atributos, elementos e eventos podem mudar antes da 1.0.