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

feat(modal): [modal] modify smb theme #2146

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

James-9696
Copy link
Collaborator

@James-9696 James-9696 commented Sep 19, 2024

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

    • The modal alert now displays the header when triggered, enhancing user visibility.
    • Updated styling for modal text content to improve visual presentation.
  • Bug Fixes

    • Adjusted test cases to reflect the new expected visibility of the modal header.
  • Style

    • Introduced new styling variables for improved customization of modal appearance.
    • Modified padding and color variables for better visual consistency of modal components.

@github-actions github-actions bot added the enhancement New feature or request label Sep 19, 2024
Copy link

coderabbitai bot commented Sep 19, 2024

Walkthrough

The changes in this pull request focus on modifying the modal component's functionality and styling. Key adjustments include enabling the display of the modal header, updating related test cases, and enhancing the CSS styling for modal text and variables. These alterations collectively improve the user interface and visual coherence of the modal, ensuring a more consistent user experience.

Changes

File Change Summary
examples/sites/demos/pc/app/modal/*.vue Updated the Modal.alert function to show the header in the modal. Test cases were modified to expect the header to be visible.
packages/theme/src/modal/index.less Introduced a new class for styling modal text, enhancing visual presentation with specific CSS properties.
packages/theme/src/modal/vars.less Added and modified CSS variables for modal styling, including font color and padding adjustments, improving customization and visual consistency.

Possibly related PRs

Suggested reviewers

  • zzcr

🐇 In a world of modals bright,
The header's now in sight!
With styles that dance and play,
Our alerts will shine today!
Let the users hop with glee,
In this UI jubilee! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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 generate interesting stats about this repository and render them as a table.
    -- @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.

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

Outside diff range and nitpick comments (2)
examples/sites/demos/pc/app/modal/show-header-footer.vue (1)

14-14: Consider externalizing UI text for localization support

The message '控制显示头部及底部' is hardcoded in the code. For better maintainability and internationalization, consider using a localization mechanism to manage UI text, which will facilitate translations and support for multiple languages.

packages/theme/src/modal/index.less (1)

Line range hint 385-409: Remove duplicate @keyframes definitions.

The @keyframes modal-fade-in and modal-fade-out are defined twice at the end of the file. This duplication is unnecessary and could lead to confusion or maintenance issues. Please remove the duplicate definitions to keep the code clean and efficient.

Apply this diff to eliminate the duplicates:

-@keyframes modal-fade-in {
-  0% {
-    transform: translate3d(0, -20px, 0);
-    opacity: 0;
-  }
-
-  100% {
-    transform: translate3d(0, 0, 0);
-    opacity: 1;
-  }
-}
-
-@keyframes modal-fade-out {
-  0% {
-    transform: translate3d(0, 0, 0);
-    opacity: 1;
-  }
-
-  100% {
-    transform: translate3d(0, -20px, 0);
-    opacity: 0;
-  }
-}
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6a298bc and 142bb86.

Files selected for processing (5)
  • examples/sites/demos/pc/app/modal/show-header-footer-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/modal/show-header-footer.spec.ts (1 hunks)
  • examples/sites/demos/pc/app/modal/show-header-footer.vue (1 hunks)
  • packages/theme/src/modal/index.less (1 hunks)
  • packages/theme/src/modal/vars.less (3 hunks)
Additional comments not posted (7)
examples/sites/demos/pc/app/modal/show-header-footer-composition-api.vue (1)

9-9: Confirm change aligns with SMB theme modifications

Changing showHeader to true ensures that both the header and footer are displayed in the modal, which appears to align with the modifications to the SMB theme as outlined in the PR objectives.

examples/sites/demos/pc/app/modal/show-header-footer.vue (1)

14-14: Confirm that showHeader: true aligns with design expectations

By setting showHeader: true, the modal will now display the header, altering the previous behavior where the header was hidden. Please verify that this change aligns with the intended SMB theme modifications and meets the design specifications.

examples/sites/demos/pc/app/modal/show-header-footer.spec.ts (1)

9-9: Confirm Intentional Change in Modal Header Visibility

The test now expects the modal header to be visible after clicking the button, which alters the previous behavior where the header was expected to be not visible. Please verify that this change aligns with the intended modification of the modal component's functionality and update relevant documentation or other tests if necessary.

Run the following script to check for other test cases that may need updates to remain consistent with this change:

packages/theme/src/modal/vars.less (3)

52-53: Addition of new variable --ti-modal-body-message-font-color approved

The new variable --ti-modal-body-message-font-color follows the existing naming conventions and enhances customization options for the message modal content.


80-80: Adjustment of right padding is appropriate

Updating --ti-modal-message-padding-right to var(--ti-common-space-4x) aligns the right padding with the intended design specifications.


82-82: Simplification of vertical padding value

Changing --ti-modal-message-padding-vertical from a calculated value to var(--ti-common-space-3x) simplifies the code and maintains consistency with spacing variables. Please ensure this alteration preserves the desired vertical spacing in the modal layout.

packages/theme/src/modal/index.less (1)

192-196: LGTM!

The addition of the .@{modal-prefix-cls}__text class within .@{modal-prefix-cls}__content is well-implemented. The styles appropriately utilize the design tokens and maintain consistency with the existing codebase.

@@ -123,5 +125,5 @@
// 头部底线边框设置(hide)
--ti-modal-header-border-bottom: none;
// 关闭按钮颜色
--ti-modal-btn-close-color: var(--ti-modal-close-btn-icon-color);
--ti-modal-btn-close-color: var(--ti-common-color-icon-normal);
Copy link

Choose a reason for hiding this comment

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

Tip

Codebase Verification

Variable --ti-modal-close-btn-icon-color is still present and used in the codebase

The variable --ti-modal-close-btn-icon-color is still defined in packages/theme/src/modal/vars.less and used in packages/theme/src/modal/index.less. This conflicts with the change made to --ti-modal-btn-close-color. To resolve this:

  • Update the usage in packages/theme/src/modal/index.less to use --ti-modal-btn-close-color instead.
  • Remove the definition of --ti-modal-close-btn-icon-color from packages/theme/src/modal/vars.less.

These changes will ensure consistency and remove the unused variable.

Analysis chain

Verify usage of --ti-modal-close-btn-icon-color

The variable --ti-modal-btn-close-color now references var(--ti-common-color-icon-normal) instead of var(--ti-modal-close-btn-icon-color). Ensure that --ti-modal-close-btn-icon-color is not used elsewhere in the codebase to prevent inconsistencies or unused variables.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for usage of `--ti-modal-close-btn-icon-color` in the codebase.

# Test: Search for occurrences of the variable. Expect: No matches if it's unused.
rg --type less $'--ti-modal-close-btn-icon-color'

Length of output: 482


Script:

#!/bin/bash
# Description: Check for usage of `--ti-modal-close-btn-icon-color` in the codebase.

# Search for the exact variable name
echo "Searching for exact variable name:"
rg -i --type less '--ti-modal-close-btn-icon-color'

# Search for the variable name without leading dashes
echo "Searching for variable name without leading dashes:"
rg -i --type less 'ti-modal-close-btn-icon-color'

Length of output: 917

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.

2 participants