podman-desktop icon indicating copy to clipboard operation
podman-desktop copied to clipboard

feat(table): adding accessibility labels to collapse button

Open axel7083 opened this issue 9 months ago • 2 comments

What does this PR do?

To be able to migrate the Table component to Svelte v5 I wanted to properly cover all the table feature to ensure no regression. The collapse action does not seems to be covered by tests.

To be able to easily test it, I need to add some recommended attributes, to properly test it. Such as aria-expanded.

Screenshot / video of UI

image image

What issues does this PR fix or reference?

Required for

  • https://github.com/podman-desktop/podman-desktop/pull/12921

How to test this PR?

  • [x] Tests are covering the bug fix or the new feature

axel7083 avatar Jun 26 '25 10:06 axel7083

📝 Walkthrough

Walkthrough

The changes introduce a new test case to the table component's test suite, specifically verifying the behavior of the collapsed prop in controlling the initial collapsed state of table rows. The test checks that rows specified as collapsed are rendered with the appropriate accessibility attributes. In the table component itself, the logic for rendering the row toggle button is updated to require both a defined name property and the presence of children. The button now includes explicit title and aria-expanded attributes to better indicate the collapsed state for accessibility purposes. No exported or public entity declarations were altered.

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/ui/src/lib/table/Table.spec.ts

Oops! Something went wrong! :(

ESLint: 9.29.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'svelte-eslint-parser' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:202:49)

packages/ui/src/lib/table/Table.svelte

Oops! Something went wrong! :(

ESLint: 9.29.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'svelte-eslint-parser' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:202:49)


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a84e726c6f88ef1496dfcdfdbf1e09d459c433b3 and 42be2cac075a7c9cce4c3e19da807eb5b49e2e9c.

📒 Files selected for processing (2)
  • packages/ui/src/lib/table/Table.spec.ts (2 hunks)
  • packages/ui/src/lib/table/Table.svelte (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/ui/src/lib/table/Table.svelte
  • packages/ui/src/lib/table/Table.spec.ts
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: smoke e2e tests (development)
  • GitHub Check: linter, formatters
  • GitHub Check: unit tests / ubuntu-24.04
  • GitHub Check: unit tests / macos-15
  • GitHub Check: smoke e2e tests (production)
  • GitHub Check: unit tests / windows-2022
  • GitHub Check: Linux
  • GitHub Check: Windows
  • GitHub Check: macOS
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 26 '25 10:06 coderabbitai[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:loudspeaker: Thoughts on this report? Let us know!

codecov[bot] avatar Jun 26 '25 10:06 codecov[bot]

Not sure why title is not enough to test the state

@jeffmaury I need the title to getByRole the button, and I need the area-expanded to determine if the row is collapsed or not

axel7083 avatar Jun 27 '25 09:06 axel7083

I think it would be better to expand the wording a bit (sorry about the pun):

  • Collapse row
  • Expand row

Thoughts?

vancura avatar Jun 27 '25 09:06 vancura

I think it would be better to expand the wording a bit (sorry about the pun):

  • Collapse row
  • Expand row

Thoughts?

Not much opinion about it, if you think this is better, I can update

axel7083 avatar Jun 27 '25 09:06 axel7083

It's better to explain the target of the action, not just the action itself. The truth is this is a matter of personal taste. We need somebody to take care of wording, but that's not me :)

vancura avatar Jun 27 '25 09:06 vancura

As the title reflects the state I think the other property is extra but I'm OK

jeffmaury avatar Jun 27 '25 11:06 jeffmaury