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

fix(Table): invalid sort indicator location when sticky is enabled #510

Conversation

aversini
Copy link
Collaborator

@aversini aversini commented Apr 16, 2024

Summary by CodeRabbit

  • Documentation

    • Updated the Sortable table component to require cell properties as strings only.
  • Style

    • Enhanced visual focus handling in the ButtonSort component by adjusting border transparency settings.
  • Tests

    • Updated tests to reflect style changes in the ButtonSort component.

Copy link

coderabbitai bot commented Apr 16, 2024

Walkthrough

The recent updates focus on enhancing UI component behaviors and ensuring consistency in data handling. Specifically, the Sortable component now strictly accepts string values for sorting, enhancing predictability in sort operations. Additionally, visual tweaks in the ButtonSort component improve UX by adjusting focus indicators and layering properties, aligning with modern UI practices.

Changes

File Path Change Summary
.../src/Components/Table.stories.tsx Updated sortState in Sortable to accept only string values.
.../src/components/private/ButtonSort.tsx Added focus-within:after:border-transparent; removed after:z-[-1px].
.../src/components/private/__tests__/ButtonSort.test.tsx Updated tests to reflect CSS class changes in ButtonSort.

Recent Review Details

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between b17da22 and cada8c6.
Files selected for processing (3)
  • packages/documentation/src/Components/Table.stories.tsx (1 hunks)
  • packages/ui-components/src/components/private/ButtonSort.tsx (1 hunks)
  • packages/ui-components/src/components/private/tests/ButtonSort.test.tsx (2 hunks)
Additional comments not posted (4)
packages/ui-components/src/components/private/ButtonSort.tsx (1)

61-61: The addition of focus-within:after:border-transparent enhances focus visibility, which is a good practice for accessibility. The removal of after:z-[-1px] correctly addresses the layering issue with sticky headers.

packages/ui-components/src/components/private/__tests__/ButtonSort.test.tsx (2)

195-195: The test correctly reflects the addition of the focus-within:after:border-transparent class, ensuring that the unit tests are aligned with the component's behavior.


220-220: The test correctly reflects the addition of the focus-within:after:border-transparent class for the dark mode scenario, ensuring consistency across different modes.

packages/documentation/src/Components/Table.stories.tsx (1)

333-333: The update to make cell strictly a string type in sortState enhances type safety and consistency in handling sort identifiers, aligning with best practices.


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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

Bundle Size (components)

Status File Size (Gzip) Limits
style.css 7.23 KB (+1 B +0.01%) 8 KB
index.js 9.29 KB (-3 B -0.03%) 20 KB
vendor.js 65.16 KB 67 KB

Overall bundle size: 81.68 KB (-2 B 0.00%)
Overall status: ✅

Bundle Size (form components)

Status File Size (Gzip) Limits
index.js 4.75 KB 20 KB
vendor.js 44.49 KB 67 KB

Overall bundle size: 49.24 KB
Overall status: ✅

Bundle Size (system)

Status File Size (Gzip) Limits
style.css 7.54 KB (+300 B +4.04%) 8 KB
index.js 1.76 KB (+1 B +0.06%) 3 KB
vendor.js 44.49 KB 46 KB

Overall bundle size: 53.8 KB (+301 B +0.55%)
Overall status: ✅

@aversini aversini merged commit 8408f69 into main Apr 16, 2024
5 checks passed
@aversini aversini deleted the fix(Table)-invalid-sort-indicator-location-when-sticky-is-enabled branch April 16, 2024 22:34
@aversini aversini mentioned this pull request Apr 16, 2024
aversini added a commit that referenced this pull request Apr 16, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>ui-components: 5.17.2</summary>

##
[5.17.2](ui-components-v5.17.1...ui-components-v5.17.2)
(2024-04-16)


### Bug Fixes

* **Table:** invalid sort indicator location when sticky is enabled
([#510](#510))
([8408f69](8408f69))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: aversini <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant