AngularJS: Filtros

Fala galera, beleza?

Já precisou formatar algum dado para exibir para o usuário? Pensou em fazer o tratamento lá no backend ou criar uma função javascript para fazer o parse e exibir? Então, neste post vamos ver como o AngularJS trata essa questão com os filters.

Filtro

Os filtros são utilizados para fazer a formatação dos dados e exibi-los ao usuário. Uma definição bem simples, igual correr com medo dos caretas na Semana Santa lá no meu Brejim (quem é do interior cearense sabe do que eu estou falando!).

O AngularJS já possui alguns filtros padrão, como, por exemplo, currency para formatação de moeda e date para formatação de datas. Na API de Referência podemos verificar todos os filtros disponibilizados pelo framework.

Os filtros podem ser usados na view, no controller, na directive ou no service. Nós podemos também criar de maneira muito fácil o nosso próprio filtro.

Veja os exemplos abaixo:

Usando filtros na view

Para utilizarmos o filter na view usamos o | (pipe) dentro da expressão {{ }}, por exemplo: meu salário {{ 123456789 | currency }}, que vai dar $123,456,789.00 como resposta.

Os filtros podem ser utilizados encadeados, ou seja, o resultado de um pode servir de entrada para o outro, exemplo: {{ “1984-12-15T00:00” | date | uppercase }}, que teria como saída DEC 15, 1984.

Eles ainda podem receber parâmetros, como {{ “1984-12-15T00:00” | date: ‘medium’ }} e sua respectiva saída Dec 15, 1984 12:00:00 AM.

Os exemplos acima  podem ser vistos no gist abaixo e/ou rodando aqui.

Nota: Para que o AngularJS funcione com a formatação local para currency, number date precisaríamos adicionar a internacionalização.

Usando filtros no controller, service e/ou directive

Filtros também podem ser utilizados em controladores, serviços e diretivas. Para isso, precisamos do controle de injeção de dependência.

Há duas maneiras de um filtro ser injetado, aqui você pode ver o gist do html e aqui você o vê rodando:

  1. Adicionar o sufixo Filter ao nome do filtro <nomeDoFiltro>Filter. Por exemplo, currencyFilter;
  2. Injetar o service $filter e passar, como parâmetro, qual filtro desejamos utilizar. Exemplo: $filter(‘date’)(‘1984-12-15T00:00′,’medium’);

Dica de Performance: Utilizar filtros fora da view é uma excelente prática quando temos uma grande quantidade de dados a serem filtrados. Isso fará com que eles não precisem ser reformatados sempre que houver uma atualização na tela. Fora da view, o filtro só é utilizado quando necessário, como quando acontece uma atualização de dados do backend ou quando a expressão do filtro é alterada.

 

Porquê o sufixo Filter?  O sufixo Filter diz ao sistema de injeção de dependência que, caso o filtro esteja presente no provider, deve utilizá-lo. Caso contrário, o DI retira o sufixo Filter e tenta injetar um filtro com nome correspondente. Assim, se o nome do seu filtro é inverterStringFilter (você nunca deve nomear seus filtros com o sufixo Filter), o DI vai procurar primeiro por inverterStringFilterProvider e, se encontrá-lo, irá usá-lo. Do contrário, ele tenta injetar o filtro de nome inverterString.

Criando filtros customizados

Criar nosso próprio filtro é muito fácil, só precisamos registrá-lo utilizando a function filter no módulo do AngularJS. A syntax pode ser vista no gist abaixo. O primeiro argumento é o nome do filtro e o segundo é a factory function para o filtro.

Vamos criar dois filtros de exemplos:

O filtro de formatação de CPF recebe um único parâmetro de entrada e dá como saída um CPF formatado no formato xxx.xxx.xxx-xx. A syntax para utilização é {{inputCPF | cpf}}, como pode ser visto na linha 13 do gist abaixo.

O segundo filtro que criamos é o abestado. Muito útil para elogiar um grande amigo, ele recebe dois parâmetros de entrada. O primeiro é o nome do amigo e o segundo é se ele é muito abestado ou não. A syntax para utilização é {{nomeDoAmigo | abestado: param1}}, como pode ser visto na linha 16 do gist abaixo. Aqui você pode ver o exemplo rodando.

Filtros nos dão um excelente poder quando o assunto é formatação de dados. Ainda há muitas outras opções que não abordei aqui, como o limitTo e orderBy, que podemos utilizar para limitar e ordenar dados de um coleção de objetos.

Então é isso pessoal, espero que tenham curtido o post.

Abraços e até a próxima!