General UI improvements #3 by kulczy · Pull Request #17586 · Sylius/Sylius

kulczy · 2024-12-19T12:20:20Z

Hide filters box if none are present

Display disabled limit button if there are no other limits - related to Sylius/Stack#163

Summary by CodeRabbit

New Features
- Improved rendering logic for filters, ensuring the filter section only displays when filters are available.
- Updated pagination interface to show a disabled button when no other pagination limits are available, enhancing user experience.
Bug Fixes
- Fixed potential display issues by preventing unnecessary HTML generation for filters.

coderabbitai · 2024-12-19T12:20:28Z

Walkthrough

The pull request introduces two template modifications in the Sylius Admin Bundle. The first change updates the filter rendering logic in the grid template to conditionally display filters only when they are available. The second change enhances the pagination helper template by adding a disabled button state when no alternative pagination limits exist, improving the user interface's responsiveness and clarity.

Changes

File	Change Summary
`src/Sylius/Bundle/.../templates/shared/crud/index/content/grid/filters.html.twig`	Conditionally render filter form only when filters are present
`src/Sylius/Bundle/.../templates/shared/helper/pagination.html.twig`	Add disabled button state for pagination limits when no alternatives exist

Poem

🐰 Filters and pages, a rabbit's delight,
Rendering smart, with logic so tight!
No empty spaces, no clutter in view,
Sylius admin, clean and true!
Hop along code, with elegance bright! 🌟

🪧 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.
- 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 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 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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 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

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Sylius/Bundle/AdminBundle/templates/shared/helper/pagination.html.twig (1)
28-31: LGTM! Consider adding aria-label for better accessibility.

The implementation correctly handles the case when no other pagination limits are available, maintaining UI consistency with the disabled state. The use of btn-ghost-secondary class aligns well with Bootstrap conventions.

Consider adding an aria-label to improve accessibility:
-        <button type="button" class="btn btn-ghost-secondary dropdown-toggle" disabled>
+        <button type="button" class="btn btn-ghost-secondary dropdown-toggle" disabled aria-label="{{ 'sylius.ui.show'|trans }} {{ paginator.maxPerPage }} {{ 'sylius.ui.items_per_page'|trans }}">
src/Sylius/Bundle/AdminBundle/templates/shared/crud/index/content/grid/filters.html.twig (1)
15-19: Consider caching the filtered and sorted filters collection.

The current implementation filters and sorts the collection on each template render. Consider moving this logic to the controller or caching the result.
-                        {% for filter in resources.definition.enabledFilters|filter(filter => filter.enabled)|sylius_sort_by('position') %}
+                        {% set sorted_filters = resources.definition.enabledFilters|filter(filter => filter.enabled)|sylius_sort_by('position') %}
+                        {% for filter in sorted_filters %}

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d3293b3 and be0776f.

📒 Files selected for processing (2)

src/Sylius/Bundle/AdminBundle/templates/shared/crud/index/content/grid/filters.html.twig (1 hunks)
src/Sylius/Bundle/AdminBundle/templates/shared/helper/pagination.html.twig (1 hunks)

🔇 Additional comments (1)

src/Sylius/Bundle/AdminBundle/templates/shared/crud/index/content/grid/filters.html.twig (1)

9-9: LGTM! Efficient implementation of conditional filter display.

The condition correctly checks for enabled filters before rendering the entire filters section, which aligns perfectly with the PR objective to hide the filters box when no filters are present.

github-actions · 2024-12-19T12:45:48Z

Bunnyshell Preview Environment deleted

Available commands:

/bns:deploy to redeploy the environment

kulczy added 2 commits December 19, 2024 13:06

Display disabled limit button if there are no other limits

69dad97

Hide filters box if none are present

be0776f

kulczy requested review from a team as code owners December 19, 2024 12:20

probot-autolabeler bot added the Admin AdminBundle related issues and PRs. label Dec 19, 2024

coderabbitai bot reviewed Dec 19, 2024

View reviewed changes

diimpp approved these changes Dec 19, 2024

View reviewed changes

loic425 approved these changes Dec 20, 2024

View reviewed changes

loic425 mentioned this pull request Dec 20, 2024

General UI improvements Sylius/Stack#187

Closed

Wojdylak approved these changes Dec 20, 2024

View reviewed changes

Wojdylak merged commit 07b0025 into Sylius:2.0 Dec 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

General UI improvements #3#17586

General UI improvements #3#17586
Wojdylak merged 2 commits intoSylius:2.0from
kulczy:SYL-4222/improvements3

kulczy commented Dec 19, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Dec 19, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

github-actions bot commented Dec 19, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

kulczy commented Dec 19, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bunnyshell Preview Environment deleted

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kulczy commented Dec 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 19, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Dec 19, 2024 •

edited

Loading