Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature externalizacao notificacoes #3

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Osdeni
Copy link

@Osdeni Osdeni commented Jan 13, 2021

Para que possamos passar a utilizar a ferramenta em nosso projeto, ajustamos as notificações para serem usadas também de forma "fracionada", sem a necessidade de estar "anexa a barra de ferramentas superior", dando assim, maior liberdade visual para que nossa aplicação possa fazer uso da ferramenta já desenvolvida.

@gdfreitas
Copy link
Contributor

gdfreitas commented Mar 19, 2021

Bom dia Osdeni!

Em análise em conjunto com a equipe, pontuamos alguns ajustes necessários para integrar essas mudanças ao nosso componente, seguindo o intuito de tornar o componente de notificações mais flexível para atender também layouts não padronizados por meio do Design System.

Sugerimos as seguintes alterações:

  1. Utilizar a ferramenta Yarn para gestão das dependências, conforme a seção de Contribuindo > Ferramentas. Não commitar o package-lock.json.
  2. Criar um componente <bth-painel-notificacoes> para contemplar o painel que foi fragmentado por meio de parâmetros. Utilizar este componente posteriormente no <bth-notificacoes>, desta forma as responsabilidades estarão melhor definidas. Lembrar de adicionar estes componentes ao índice de componentes públicos na seção "Ferramentas" do arquivo README.md
  3. Pensar num formato onde não se faz necessário o uso do atributo height-painel-notificacoes="calc(100vh -150px), onde por exemplo o painel se adapta ao elemento externo ao qual foi inserido, mantendo simples e objetivo.
  4. Implementar os devidos testes unitários das diferentes variações do(s) componente(s)
  5. Caso seja necessário algum parâmetro/propriedade pública dos componentes, manter a preferência pelo portugues ao nomeá-los.
  6. O evento conteudoSinalizado é um evento interno de um contrato entre componentes das "ferramentas" com o menu, utilizado na versão para dispositivos móveis. Portanto se faz necessário criar um novo evento para o componente de bth-painel-notificacoes para cumprir o propósito de informar a quantidade de notificações não lidas à quem tiver interesse, o mesmo serve caso outras informações sejam necessárias. Testar e documentar.
  7. Descrever na documentação possíveis casos de uso desta abordagem, se possível exemplificando as variações, conforme exemplo das as documentações atuais.
  8. Descrever na documentação as restrições visuais que o componente impõe, caso necessário, envolver alguém da equipe para elaboração das mesmas.
    • Exemplo: qual ícone utilizar, relação ícone/quantidade de itens não lidos, obrigatoriedade de ícone (painel pode ser usado sem ícone?)
    • Normativas de uso do ícone em relação a acessibilidade (badge vermelha em barra de menu vermelha, sem contraste, prejudica acessibilidade)
  9. Implementar cenários na sandbox servida em http://localhost:3333/ para que possam ser manualmente testadas as diversas variações do componente
    • Por exemplo: dentro dropdown, em container menores/maiores, o conteúdo irá ter overflow? Pensar nos cenários possíveis.
    • Para a criação de um ambiente na sandbox, sugere-se a criação um arquivo html separado, à exemplo o ambiente de testes dos componentes comuns (comuns.html)

@gdfreitas gdfreitas self-assigned this Mar 19, 2021
@gdfreitas gdfreitas added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 19, 2021
@gdfreitas gdfreitas self-requested a review March 19, 2021 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants