Skip to content

fix(grid): [grid] add grid no-data icon #3257

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

Merged
merged 5 commits into from
Apr 7, 2025

Conversation

wuyiping0628
Copy link
Collaborator

@wuyiping0628 wuyiping0628 commented Apr 7, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Enhanced visual styling for empty data states with new color accents for both dark and light themes.
    • Introduced a dedicated “No Data” icon for grid displays to improve the clarity of empty state representations.
  • Refactor
    • Streamlined the grid’s empty state appearance by removing redundant background images, ensuring a cleaner and more consistent user interface.

@wuyiping0628 wuyiping0628 added the enhancement New feature or request (功能增强) label Apr 7, 2025
Copy link

coderabbitai bot commented Apr 7, 2025

Walkthrough

The changes add new CSS custom properties and variables for “no data” states in dark theme and related grid styles. Background image settings for empty grid states have been removed. Additionally, a new icon, IconGridNoData, has been introduced and integrated into the Vue grid components, replacing the previous placeholder text for empty states.

Changes

File(s) Change Summary
packages/theme/src/base/dark-theme.less
packages/theme/src/base/vars.less
Added new CSS custom properties/variables (--tv-color-no-data-gary-1, --tv-color-no-data-gary-2, --tv-color-no-data-border, --tv-color-no-data-brand) with defined color values.
packages/theme/src/grid/table.less
packages/theme/src/grid/vars.less
Removed background image settings for empty grid states; deleted the CSS variable --tv-Grid-empty-img that defined a base64-encoded SVG image.
packages/vue-icon-saas/index.ts
packages/vue-icon/index.ts
.../vue-icon/src/grid-no-data/index.ts
Introduced a new icon IconGridNoData: added relevant import, export (with alias), and a new default Vue component that wraps the SVG icon.
packages/vue/src/grid/src/body/src/body.tsx
packages/vue/src/grid/src/table/src/table.ts
Updated grid rendering: replaced a paragraph element for empty states with the new GridNoData icon component to improve visual representation when no data is available.

Sequence Diagram(s)

sequenceDiagram
    participant Grid as Grid Component
    participant Renderer as Render Function
    participant Icon as IconGridNoData (Vue Icon)
    participant SVG as SVG Component

    Grid->>Renderer: Check for empty data
    Renderer->>Icon: Invoke iconGridNoData()
    Icon->>SVG: Render SVG for no data
    SVG-->>Icon: Return rendered icon
    Icon-->>Renderer: Provide icon component
    Renderer-->>Grid: Display no data icon in grid
Loading

Suggested reviewers

  • zzcr

Poem

I'm a rabbit with a hop so keen,
Celebrating code that's crisp and clean.
Dark themes and icons now take the stage,
Grid no data, a modern page.
With leaps of joy, my heart does sing—
A burrow of changes, fresh as spring!

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/vue-icon-saas/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue-icon/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

packages/vue/src/grid/src/body/src/body.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 2 others
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions github-actions bot added bug Something isn't working and removed enhancement New feature or request (功能增强) labels Apr 7, 2025
@wuyiping0628 wuyiping0628 added enhancement New feature or request (功能增强) and removed bug Something isn't working labels Apr 7, 2025
@github-actions github-actions bot added bug Something isn't working and removed enhancement New feature or request (功能增强) labels Apr 7, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
packages/theme/src/base/vars.less (1)

337-341: New CSS Custom Properties for No-Data States

Four new custom properties have been added for empty state (no-data) icon styling. They are defined as follows:

  • --tv-color-no-data-gary-1: var(--tv-base-color-common-4); // #f0f0f0
  • --tv-color-no-data-gary-2: var(--tv-base-color-common-1); // #ffffff
  • --tv-color-no-data-border: var(--tv-base-color-common-8); // #808080
  • --tv-color-no-data-brand: var(--tv-base-color-brand-6); // #317af7

Please verify that:
• The color values match the design specification for empty states.
• The use of “gary” in the variable names is intentional (or if it should be “gray” for clarity).

packages/theme/src/base/dark-theme.less (1)

337-341: New Dark Theme CSS Properties for No-Data States

In the dark theme file, corresponding custom properties for empty state icons have been added with adjusted color values:

  • --tv-color-no-data-gary-1: var(--tv-base-color-common-10); // #262626
  • --tv-color-no-data-gary-2: var(--tv-base-color-common-9); // #333333
  • --tv-color-no-data-border: var(--tv-base-color-common-5); // #999999
  • --tv-color-no-data-brand: var(--tv-base-color-brand-7); // #317AF7

Again, please check that the chosen values match the intended design for dark mode and that the naming (“gary”) is consistent with your style guidelines.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5fa8d72 and f419d7d.

⛔ Files ignored due to path filters (2)
  • packages/theme-saas/src/svgs/grid-no-data.svg is excluded by !**/*.svg
  • packages/theme/src/svgs/grid-no-data.svg is excluded by !**/*.svg
📒 Files selected for processing (9)
  • packages/theme/src/base/dark-theme.less (1 hunks)
  • packages/theme/src/base/vars.less (1 hunks)
  • packages/theme/src/grid/table.less (0 hunks)
  • packages/theme/src/grid/vars.less (0 hunks)
  • packages/vue-icon-saas/index.ts (3 hunks)
  • packages/vue-icon/index.ts (3 hunks)
  • packages/vue-icon/src/grid-no-data/index.ts (1 hunks)
  • packages/vue/src/grid/src/body/src/body.tsx (2 hunks)
  • packages/vue/src/grid/src/table/src/table.ts (2 hunks)
💤 Files with no reviewable changes (2)
  • packages/theme/src/grid/table.less
  • packages/theme/src/grid/vars.less
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
  • GitHub Check: Parse Affected Components
🔇 Additional comments (11)
packages/vue-icon/src/grid-no-data/index.ts (1)

1-4: Implementation looks good

The new file correctly exports a Vue icon component for the grid's no-data state, following the established pattern in the codebase. The component is properly created using the svg utility with the appropriate name and SVG component.

packages/vue-icon/index.ts (3)

458-458: Correct import statement

The import for the new IconGridNoData is correctly added and follows the established pattern in the codebase.


1524-1525: Exports follow established pattern

Both the standard export (IconGridNoData) and the alias export (iconGridNoData) are correctly added, maintaining consistency with other icons in the file.


2069-2069: Default export updated correctly

The new icon is appropriately added to the default export object, ensuring it's available both as a named export and through the default export.

packages/vue/src/grid/src/table/src/table.ts (3)

46-46: Icon import added correctly

The import statement for the grid-no-data icon is added properly using the camelCase alias.


54-54: Component initialization looks good

The GridNoData constant is correctly initialized by invoking the imported icon function.


126-126: Enhanced empty state visualization

Good improvement replacing the paragraph element with the custom icon for empty states, which provides better visual feedback to users.

packages/vue/src/grid/src/body/src/body.tsx (3)

39-39: Icon import added correctly

The import statement for the grid-no-data icon is properly added alongside existing icon imports.


43-43: Component initialization looks good

The GridNoData constant is correctly initialized by invoking the imported icon function.


755-757: Enhanced empty state visualization

Good improvement replacing the paragraph element with the custom icon. This enhancement provides better visual feedback to users when the grid has no data to display, and maintains consistency with the changes in table.ts.

packages/vue-icon-saas/index.ts (1)

1523-1525: Addition of IconGridNoData Icon

The new IconGridNoData is correctly imported from ./src/grid-no-data and included in both the named and default exports. This aligns with the PR’s objective to supply a dedicated icon for grid empty states. Please make sure that the corresponding source file implements the design and that any related documentation (or tests) is updated if needed.

@zzcr zzcr merged commit 4b7ae8c into opentiny:dev Apr 7, 2025
20 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants