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(alert): [alert] display title when size is large in mobile-first #2765

Merged
merged 5 commits into from
Jan 8, 2025

Conversation

wuyiping0628
Copy link
Collaborator

@wuyiping0628 wuyiping0628 commented Jan 8, 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

Release Notes

  • New Features

    • Enhanced Alert component with improved title visibility control
    • Added showTitle prop to control title display in mobile-first mode
  • Documentation

    • Updated documentation to explain show-title attribute functionality
    • Clarified title display options for Alert component
  • Bug Fixes

    • Corrected minor text formatting in documentation

The changes provide more flexible title display options for the Alert component across different modes and screen sizes.

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

coderabbitai bot commented Jan 8, 2025

Walkthrough

This pull request introduces enhancements to the alert component's title visibility across different modes (PC and mobile-first). The changes include updating the show-title property's mode, adding a new showTitle prop in the mobile-first implementation, and updating documentation to reflect the new functionality. The modifications allow more flexible control over title display based on component size and mode.

Changes

File Change Summary
examples/sites/demos/apis/alert.js Updated show-title property mode from ['pc'] to ['pc', 'mobile-first']
examples/sites/demos/mobile-first/app/alert/title.vue Added new tiny-alert instance with :show-title="false"
examples/sites/demos/mobile-first/app/alert/webdoc/alert.js Added documentation explaining show-title attribute's title visibility control
examples/sites/demos/pc/app/alert/webdoc/alert.js Removed extra space in Chinese description
packages/vue/src/alert/src/mobile-first.vue Added showTitle prop and updated conditional rendering for title display

Sequence Diagram

sequenceDiagram
    participant Component as Alert Component
    participant Props as Props Configuration
    participant Template as Template Rendering

    Props->>Component: Set showTitle prop
    Props->>Component: Set size prop
    Component->>Template: Evaluate rendering conditions
    Template-->>Component: Render title based on size and showTitle
Loading

Possibly related PRs

Suggested reviewers

  • zzcr

Poem

🐰 Hop, hop, alert's new might!
Titles dance with mobile's light
Props now flex, modes combine
Rendering magic, simply fine
Rabbit's code leaps with delight! 🌈


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 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. (Beta)
  • @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

Walkthrough

This PR introduces a feature to display the title in alerts when the size is set to large, specifically for mobile-first mode. It adds a new property showTitle to control the visibility of the title, enhancing the alert component's flexibility.

Changes

File Summary
examples/sites/demos/apis/alert.js Added mobile-first mode support for displaying titles in large alerts.
examples/sites/demos/mobile-first/app/alert/title.vue Added examples demonstrating the use of showTitle property in alerts.
examples/sites/demos/mobile-first/app/alert/webdoc/alert.js Updated documentation to include showTitle property for large alerts.
examples/sites/demos/pc/app/alert/webdoc/alert.js Updated documentation to reflect changes in title customization for large alerts.
packages/vue/src/alert/src/mobile-first.vue Modified alert component to use showTitle property for controlling title visibility in large alerts.

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

🧹 Nitpick comments (1)
packages/vue/src/alert/src/mobile-first.vue (1)

155-155: Add type validation for the showTitle prop.

Consider adding type validation for better runtime safety:

-    'showTitle',
+    {
+      name: 'showTitle',
+      type: Boolean,
+      default: true
+    },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2e45a76 and b763d8b.

📒 Files selected for processing (5)
  • examples/sites/demos/apis/alert.js (1 hunks)
  • examples/sites/demos/mobile-first/app/alert/title.vue (1 hunks)
  • examples/sites/demos/mobile-first/app/alert/webdoc/alert.js (1 hunks)
  • examples/sites/demos/pc/app/alert/webdoc/alert.js (1 hunks)
  • packages/vue/src/alert/src/mobile-first.vue (3 hunks)
✅ Files skipped from review due to trivial changes (1)
  • examples/sites/demos/pc/app/alert/webdoc/alert.js
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (3)
examples/sites/demos/mobile-first/app/alert/title.vue (1)

8-9: LGTM! Well-structured demo showcasing title visibility options.

The demo effectively demonstrates three different title scenarios: property-based title, slot-based title, and hidden title using show-title=false.

packages/vue/src/alert/src/mobile-first.vue (1)

37-37: LGTM! Consistent implementation of title visibility control.

The conditional rendering of titles is correctly implemented in both foldable and non-foldable sections.

Also applies to: 97-98

examples/sites/demos/apis/alert.js (1)

129-129: LGTM! Proper extension of show-title property to mobile-first mode.

The show-title property is correctly extended to support mobile-first mode while maintaining existing PC mode support.

@zzcr zzcr merged commit f617f42 into opentiny:dev Jan 8, 2025
11 checks passed
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