Skip to content

Conversation

@gabriel291-silva
Copy link

@gabriel291-silva gabriel291-silva commented Mar 12, 2025

…bility applications and automated testing

What is the purpose of this pull request?
I inserted a definition in the component, this modification is for accessibility app

What problem is this solving?
acessibility problems

Descrição detalhada de como a correção resolve um problema de acessibilidade (a11y).

durante os testes automatizados, foi captado que o componente exibia umas das estrutura de lista, porem essa estrutura não possuía nenhum tipo de item filho, e isso se tornou invalido para os testes, então apenas validei a existência dos valores para que esse componente que contem a lista fosse exibido somente quando a lista não fosse vazia, conclusão o componente “

    ” não será exibido vazio com essa validação de existência dos itens.

    after :
    image

    Before
    image

    Instruções de como testar a correção.

    irei disponibilizar o link do workspace, para testar buscar pela classe “itemListTitle” usando o devtools nos links eu irei lhe enviar, vou anexar dois links um onde o componente vazio e escondido e outro em que ele aparece com os conteúdos necessários para não ser um erro de acessibilidade.

    Atualização do changelog com as alterações feitas.

    Added

    • verification in component for acessibility validation

    @vtex-io-ci-cd
    Copy link

    vtex-io-ci-cd bot commented Mar 12, 2025

    Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖

    Please select which version do you want to release:

    • Patch (backwards-compatible bug fixes)

    • Minor (backwards-compatible functionality)

    • Major (incompatible API changes)

    And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.

    • No thanks, I would rather do it manually 😞

    @vtex-io-docs-bot
    Copy link

    vtex-io-docs-bot bot commented Mar 12, 2025

    Beep boop 🤖

    I noticed you didn't make any changes at the docs/ folder

    • There's nothing new to document 🤔
    • I'll do it later 😞

    In order to keep track, I'll create an issue if you decide now is not a good time

    • I just updated 🎉🎉

    @iago1501 iago1501 self-requested a review March 17, 2025 12:54
    @iago1501 iago1501 added the enhancement New feature or request label Mar 17, 2025
    @iago1501
    Copy link
    Contributor

    HI @gabriel291-silva , thanks for the contribution, could you describe more how this fix is going to help/address an a11y issue and describe how to test it, please? A few more metrics with the after and before would be great.

    Another important point is that the changelog is missing

    @gabriel291-silva
    Copy link
    Author

    Detailed description of how the fix resolves an accessibility (a11y) issue.

    During automated testing, it was detected that the component displayed a list structure; however, this structure did not contain any child items, making it invalid for the tests. To address this, I simply validated the existence of values so that this component containing the list would only be displayed when the list was not empty.

    Conclusion: The

      component will no longer be displayed empty due to this validation of item existence.

      - beafore
      image

      - after
      image

      Instructions on How to Test the Fix

      I will provide the workspace link. To test it, search for the class "itemListTitle" using DevTools in the links I will send.

      I will attach two links:

      One where the empty component is hidden.
      Another where it appears with the necessary content, ensuring it is not an accessibility error.
      Link with the empty item not displayed:
      https://vtexpr206--hmartus.myvtex.com/mango ice cream?_q=mango ice cream&map=ft&updateRegionalization=false&__bindingAddress=www.hmart.com/

      Link with the filled component displayed:
      https://vtexpr206--hmartus.myvtex.com/rice---grain?__bindingAddress=www.hmart.com/&page=3

      Atualização do Changelog

      Added

      • verification in component for acessibility validation

      @leo-prange-vtex
      Copy link

      leo-prange-vtex commented Mar 18, 2025

      @gabriel291-silva You can add the comment content in the PR definition to organize and request.

      @gabriel291-silva
      Copy link
      Author

      Changed

      @gabriel291-silva
      Copy link
      Author

      i adjusted the coment on changelog.md

      @iago1501 iago1501 merged commit 3845bb0 into vtex-apps:master Mar 25, 2025
      4 of 6 checks passed
      @vtex-io-ci-cd
      Copy link

      vtex-io-ci-cd bot commented Mar 25, 2025

      Your PR has been merged! App is being published. 🚀
      Version 2.18.2 → 2.18.3

      After the publishing process has been completed (check #vtex-io-releases) and doing A/B tests with the new version, you can deploy your release by running:

      vtex deploy vtex.search@2.18.3

      After that your app will be updated on all accounts.

      For more information on the deployment process check the docs. 📖

      Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

      Labels

      enhancement New feature or request

      Projects

      None yet

      Development

      Successfully merging this pull request may close these issues.

      3 participants