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(tag): remove mini size of tag #2468

Merged
merged 4 commits into from
Oct 29, 2024

Conversation

shenjunjian
Copy link
Collaborator

@shenjunjian shenjunjian commented Oct 29, 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

Release Notes

  • New Features

    • Removed the "mini" tag size from the Tag Group component, simplifying the available options to "medium" and "small."
  • Bug Fixes

    • Updated tests to reflect the removal of the "mini" tag, ensuring validation only for the remaining sizes.
  • Documentation

    • Updated descriptions in the demo documentation and API definitions to align with the new tag size options.
  • Style

    • Adjusted CSS variables and styles for the "small" tag to enhance consistency and alignment with design specifications.

@github-actions github-actions bot added the bug Something isn't working label Oct 29, 2024
Copy link

coderabbitai bot commented Oct 29, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes changes to several Vue components and their corresponding test files, primarily focusing on the removal of the "mini" tag size from the tag group. This involves deleting related template elements, test assertions, and updating descriptions in documentation. The overall structure of the components remains intact, and no changes were made to the script or style sections of the affected files. CSS variables in the vars.less file have also been adjusted to reflect the removal of the "mini" size.

Changes

File Path Change Summary
examples/sites/demos/pc/app/tag-group/tag-group-size-composition-api.vue Removed the display of "超小标签:mini" and the corresponding <tiny-tag-group> component.
examples/sites/demos/pc/app/tag-group/tag-group-size.vue Deleted the section for "超小标签:mini" and its corresponding <tiny-tag-group> component.
examples/sites/demos/pc/app/tag/size-composition-api.vue Removed instances of the tiny-tag component with size="mini".
examples/sites/demos/pc/app/tag/webdoc/tag.js Updated the size demo descriptions to reflect the removal of the "mini" size from optional values.
examples/sites/demos/pc/app/tag/size.vue Deleted instances of the tiny-tag component with size="mini".
examples/sites/demos/pc/app/tag/size.spec.ts Removed references to the "mini" tag in the test case, including assertions for its CSS properties.
examples/sites/demos/pc/app/tag-group/tag-group-size.spec.js Modified the test case to remove assertions related to the "mini" tag.
packages/theme/src/tag/vars.less Updated CSS variables to adjust padding, border-radius, and font size for the "small" tag, reflecting the removal of "mini".
examples/sites/demos/apis/tag-group.js Updated the size property type to remove the 'mini' option from the tag-group component API.
examples/sites/demos/apis/tag.js Modified the ISize type definition to exclude the mini option and corrected an event type syntax error.

Possibly related PRs

Suggested reviewers

  • zzcr

Poem

🐇 In the garden where tags bloom bright,
The "mini" size took its flight.
With "medium" and "small" now in view,
Our tags are simpler, fresh, and new!
Hopping along, we cheer with glee,
For a cleaner look, as fine as can be! 🌼


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

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

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

🧹 Outside diff range and nitpick comments (1)
packages/theme/src/tag/vars.less (1)

51-61: Default tag size reduced significantly

The default tag size has been made more compact with several changes:

  • Font size reduced from md to sm
  • Horizontal padding reduced from 11px to 7px
  • Vertical padding reduced from 2.5px to 2px
  • Border radius reduced from md to sm
  • Icon size reduced from 16px to 14px

This is a significant visual change that affects all tags by default.

Consider:

  1. Adding a migration guide in the changelog
  2. Updating the component documentation
  3. Adding visual examples of the new sizes in the documentation
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f5697e7 and fac12c9.

📒 Files selected for processing (8)
  • examples/sites/demos/pc/app/tag-group/tag-group-size-composition-api.vue (0 hunks)
  • examples/sites/demos/pc/app/tag-group/tag-group-size.spec.js (0 hunks)
  • examples/sites/demos/pc/app/tag-group/tag-group-size.vue (0 hunks)
  • examples/sites/demos/pc/app/tag/size-composition-api.vue (0 hunks)
  • examples/sites/demos/pc/app/tag/size.spec.ts (0 hunks)
  • examples/sites/demos/pc/app/tag/size.vue (0 hunks)
  • examples/sites/demos/pc/app/tag/webdoc/tag.js (1 hunks)
  • packages/theme/src/tag/vars.less (2 hunks)
💤 Files with no reviewable changes (6)
  • examples/sites/demos/pc/app/tag-group/tag-group-size-composition-api.vue
  • examples/sites/demos/pc/app/tag-group/tag-group-size.spec.js
  • examples/sites/demos/pc/app/tag-group/tag-group-size.vue
  • examples/sites/demos/pc/app/tag/size-composition-api.vue
  • examples/sites/demos/pc/app/tag/size.spec.ts
  • examples/sites/demos/pc/app/tag/size.vue
🔇 Additional comments (4)
examples/sites/demos/pc/app/tag/webdoc/tag.js (1)

72-73: LGTM, but this is a breaking change!

The description update correctly reflects the removal of the 'mini' size option. However, this is a breaking change that could affect existing applications using the 'mini' size. Consider:

  1. Adding a migration guide for users
  2. Documenting this in the changelog as a breaking change
  3. Ensuring proper semantic versioning bump (major version)

Let's verify the consistency of size options across the codebase:

✅ Verification successful

Based on the search results, I can now provide a final response regarding the tag size documentation:

Documentation correctly reflects available size options

The changes to the size documentation are accurate and consistent with the codebase:

  • The original documentation mentioned medium/small/mini options
  • The updated documentation now only lists medium/small as available options
  • This aligns with the PR's objective of removing the 'mini' size option
  • The change is consistently documented in both zh-CN and en-US translations
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining references to 'mini' size in tag-related files

# Test 1: Search for 'mini' size references in tag component files
echo "Checking for 'mini' size references in tag files..."
rg -i "(?:size.*mini|mini.*size)" --type vue --type js --type ts

# Test 2: Search for specific CSS classes or variables related to mini size
echo "Checking for mini-related CSS classes..."
rg -i "(?:--ti-tag.*mini|\.ti-tag.*mini)" --type css --type less

Length of output: 371


Script:

#!/bin/bash
# Let's try a different approach to search for 'mini' references

# Search for any mentions of 'mini' in relation to tags
echo "Searching for 'mini' in files containing 'tag'..."
rg -l "tag" | xargs rg -i "mini"

# Search specifically in the tag component directory
echo "Searching in component source files..."
fd "tag" --type f | xargs rg -i "size.*=.*['\"]mini['\"]|mini.*size"

# Look for size-related props in tag component
echo "Checking size prop definitions..."
ast-grep --pattern 'props: {
  $$$
  size: {
    $$$
  }
  $$$
}'

Length of output: 610


Script:

#!/bin/bash
# Let's try simpler commands without piping

# Search for 'mini' in all files
echo "Searching for any 'mini' references..."
rg -i "mini"

# Search for size prop definitions
echo "Searching for size prop definitions..."
rg -i "size.*prop" -A 5 -B 5

# Search for tag component size documentation
echo "Searching for tag size documentation..."
rg -i "size.*medium.*small"

Length of output: 289597

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

Line range hint 20-61: Breaking Changes Alert: Tag Size System Overhaul

This PR introduces significant breaking changes to the tag component's size system:

  1. Removal of mini size (with fallback to small)
  2. Reduction in small tag size dimensions
  3. Reduction in default tag size dimensions

These changes will affect:

  • Visual appearance of all tags
  • Layout calculations in existing applications
  • Design system consistency

Let's check for proper documentation of these breaking changes:

#!/bin/bash
# Search for changelog and documentation files
fd -e md -e mdx "changelog|breaking|migration|upgrade"

40-48: Significant visual changes to small tags

The small tag size has been made more compact with:

  • Reduced horizontal padding (3px)
  • Removed vertical padding (0)
  • Smaller border radius (xs instead of sm)
  • Smaller icon size (12px)

These changes will noticeably affect the appearance of existing small tags.

Let's check for any visual regression tests:

#!/bin/bash
# Search for visual regression tests for tag component
rg -l "tag.*test|test.*tag" --type spec
rg -l "tag.*snapshot|snapshot.*tag" --type spec

20-22: Verify fallback behavior for mini size

The comment indicates that when users use "mini" size, it should fallback to "small" size. This is a breaking change that needs proper handling.

Let's verify the fallback implementation:

@zzcr zzcr merged commit f6b4482 into opentiny:release-3.19.0 Oct 29, 2024
3 checks passed
zzcr pushed a commit that referenced this pull request Nov 4, 2024
* fix(tag): remove mini size

* fix(tag): update tag's demo, which is relate to size

* fix(tag): fix api

* fix(tag): fix
@shenjunjian shenjunjian deleted the refactor-tag-remove-mini branch November 7, 2024 02:11
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