Skip to content

refactor: Rename Steps labelPlacement to titlePlacement#53873

Merged
thinkasany merged 2 commits intonextfrom
steps-label-placement
May 20, 2025
Merged

refactor: Rename Steps labelPlacement to titlePlacement#53873
thinkasany merged 2 commits intonextfrom
steps-label-placement

Conversation

@zombieJ
Copy link
Copy Markdown
Member

@zombieJ zombieJ commented May 20, 2025

中文版模板 / Chinese template

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

🔗 Related Issues

  • Describe the source of related requirements, such as links to relevant issue discussions.
  • For example: close #xxxx, fix #xxxx

💡 Background and Solution

#53328

📝 Change Log

Language Changelog
🇺🇸 English Replace Steps labelPlacement to titlePlacement to unify the API.
🇨🇳 Chinese 重命名 Steps 的 labelPlacementtitlePlacement 以统一 API。

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch steps-label-placement
  • Post Copyable Unit Tests in Comment

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 20, 2025

👁 Visual Regression Report for PR #53873 Failed ❌

🎯 Target branch: next (3b9f6bf)
📖 View Full Report ↗︎
📖 Alternative Report ↗︎
📊 Summary: 🛑 3 removed, 🆕 3 added

Expected (Branch next) Actual (Current PR) Diff
steps-label-placement.compact.png steps-label-placement.compact.png ⛔️⛔️⛔️ Missing ⛔️⛔️⛔️ 🚨🚨🚨 Removed 🚨🚨🚨
steps-label-placement.dark.png steps-label-placement.dark.png ⛔️⛔️⛔️ Missing ⛔️⛔️⛔️ 🚨🚨🚨 Removed 🚨🚨🚨
steps-label-placement.default.png steps-label-placement.default.png ⛔️⛔️⛔️ Missing ⛔️⛔️⛔️ 🚨🚨🚨 Removed 🚨🚨🚨
steps-title-placement.compact.png steps-title-placement.compact.png 🆕🆕🆕 Added 🆕🆕🆕
steps-title-placement.dark.png steps-title-placement.dark.png 🆕🆕🆕 Added 🆕🆕🆕
steps-title-placement.default.png steps-title-placement.default.png 🆕🆕🆕 Added 🆕🆕🆕

Important

There are 6 diffs found in this PR: 🛑 3 removed, 🆕 3 added.
Please check all items:

  • Visual diff is acceptable

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 20, 2025

Preview is ready

@petercat-assistant
Copy link
Copy Markdown

Walkthrough

This pull request refactors the Steps component by renaming the labelPlacement property to titlePlacement to unify the API. It includes updates to the component's tests, demos, and documentation to reflect this change, as well as deprecation warnings for the old property.

Changes

Files Summary
components/config-provider/tests/snapshots/components.test.tsx.snap Updated snapshots to reflect the renaming of labelPlacement to titlePlacement.
components/steps/tests/snapshots/demo-extend.test.ts.snap Updated snapshots to reflect the renaming of labelPlacement to titlePlacement.
components/steps/tests/snapshots/demo.test.ts.snap Updated snapshots to reflect the renaming of labelPlacement to titlePlacement.
components/steps/tests/snapshots/index.test.tsx.snap Updated snapshots to reflect the renaming of labelPlacement to titlePlacement.
components/steps/tests/a11y.test.ts Updated accessibility tests to skip title-placement.tsx instead of label-placement.tsx.
components/steps/tests/index.test.tsx Added deprecation warning for labelPlacement and updated tests to use titlePlacement.
components/steps/demo/_semantic.tsx Replaced labelPlacement with titlePlacement in demo components.
components/steps/demo/label-placement.md Removed file as it is replaced by title-placement.md.
components/steps/demo/title-placement.md Added new file to demonstrate titlePlacement usage.
components/steps/demo/title-placement.tsx Replaced labelPlacement with titlePlacement in demo components.
components/steps/demo/variant-debug.tsx Replaced labelPlacement with titlePlacement in demo components.
components/steps/index.en-US.md Updated documentation to reflect the renaming of labelPlacement to titlePlacement.
components/steps/index.tsx Added titlePlacement property and deprecated labelPlacement. Updated logic to use titlePlacement.
components/steps/index.zh-CN.md Updated documentation to reflect the renaming of labelPlacement to titlePlacement.
components/steps/style/inline.ts Updated styles to use titlePlacement variables.
components/steps/style/label-placement.ts Updated styles to use titlePlacement variables.
components/steps/style/small.ts Updated styles to use titlePlacement variables.
package.json Updated @rc-component/steps version to ~1.1.0.

Comment thread components/steps/index.tsx
@github-actions
Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
dist/antd.min.js 498.86 KB (+7 B 🔺)
dist/antd-with-locales.min.js 590.24 KB (+3 B 🔺)

Comment on lines 325 to 329

warning.deprecated(!labelPlacement, 'labelPlacement', 'titlePlacement');
warning.deprecated(!progressDot, 'progressDot', 'type="dot"');
warning.deprecated(!direction, 'direction', 'orientation');
warning.deprecated(
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

看起来可以和其他地方的 warning 一样用数组或者对象

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

打包不会带进去就直接复制了,下次一定。哈哈哈~

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 20, 2025

@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2025

Bundle Report

Changes will increase total bundle size by 44 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
antd.min-array-push 3.75MB 44 bytes (0.0%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: antd.min-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
antd-with-locales.min.js 22 bytes 2.06MB 0.0%
antd.min.js 22 bytes 1.69MB 0.0%

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying ant-design with  Cloudflare Pages  Cloudflare Pages

Latest commit: f483cae
Status: ✅  Deploy successful!
Preview URL: https://0ef18d3a.ant-design.pages.dev
Branch Preview URL: https://steps-label-placement.ant-design.pages.dev

View logs

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label May 20, 2025
@thinkasany thinkasany merged commit ff61411 into next May 20, 2025
47 checks passed
@thinkasany thinkasany deleted the steps-label-placement branch May 20, 2025 10:00
@codecov
Copy link
Copy Markdown

codecov Bot commented May 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3b9f6bf) to head (f483cae).
Report is 1 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff            @@
##              next    #53873   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          788       788           
  Lines        14304     14305    +1     
  Branches      3784      3784           
=========================================
+ Hits         14304     14305    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants