feat(Tour): support ConfigProvider by thinkasany · Pull Request #52250 · ant-design/ant-design

thinkasany · 2025-01-06T02:22:20Z

🤔 This is a ...

🆕 New feature

🔗 Related Issues

📝 Change Log

Language	Changelog
🇺🇸 English	feat: ConfigProvider support Tour
🇨🇳 Chinese	feat: ConfigProvider 支持 Tour 组件的配置

bolt-new-by-stackblitz · 2025-01-06T02:22:23Z

Run & review this pull request in StackBlitz Codeflow.

github-actions · 2025-01-06T02:22:32Z

👁 Visual Regression Report for PR #52250 Passed ✅

🎯 Target branch: next (2055bcf)
📖 View Full Report ↗︎
📖 Alternative Report ↗︎

🎊 Congrats! No visual-regression diff found.

github-actions · 2025-01-06T02:22:33Z

petercat-assistant · 2025-01-06T02:22:37Z

Walkthrough

This pull request introduces support for the Tour component in the ConfigProvider. It enhances the Tour component by adding customizable classNames and styles, allowing for more flexible styling options. Additionally, semantic DOM elements are introduced for better accessibility and styling.

Changes

Files	Summary
`.dumi/components/SemanticPreview.tsx`	Added `component` prop and logic to handle semantic class names.
`components/config-provider/context.ts`	Extended `TourConfig` to include `classNames` and `styles`.
`components/config-provider/index.en-US.md`, `components/config-provider/index.zh-CN.md`	Updated documentation to reflect new Tour properties.
`components/tour/TourContext.ts`	Created a new context for Tour component styles and classNames.
`components/tour/__tests__/index.test.tsx`	Added tests for custom styles and classNames support.
`components/tour/demo/_semantic.tsx`	Added a demo for semantic DOM elements.
`components/tour/index.en-US.md`, `components/tour/index.zh-CN.md`	Added documentation for semantic DOM.
`components/tour/index.tsx`	Integrated `TourContext` and merged styles/classNames logic.
`components/tour/interface.ts`	Defined `SemanticName` type and extended `TourProps`.
`components/tour/panelRender.tsx`	Applied context-based styles and classNames to panel elements.
`components/tour/style/index.ts`	Updated styles to use semantic class names.

components/tour/index.tsx

pkg-pr-new · 2025-01-06T02:25:49Z

Open in Stackblitz

More templates

npm i https://pkg.pr.new/ant-design/ant-design/antd@52250

commit: 8fec1bf

codecov · 2025-01-06T02:26:47Z

Bundle Report

Changes will increase total bundle size by 10.51kB (0.09%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
antd.min-array-push	11.69MB	10.51kB (0.09%) ⬆️

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.js`	5.25kB	6.15MB	0.09%
`antd.js`	5.25kB	5.54MB	0.09%

Files in antd-with-locales.js:

./components/config-provider/context.ts → Total Size: 1.51kB
./components/tour/style/index.ts → Total Size: 7.29kB

Files in antd.js:

./components/tour/style/index.ts → Total Size: 7.29kB
./components/config-provider/context.ts → Total Size: 1.51kB

.dumi/components/SemanticPreview.tsx

codecov · 2025-01-06T03:10:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2055bcf) to head (8fec1bf).
Report is 13 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff            @@
##              next    #52250   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          766       766           
  Lines        13776     13781    +5     
  Branches      3615      3617    +2     
=========================================
+ Hits         13776     13781    +5

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

components/tour/demo/_semantic.tsx

zombieJ · 2025-03-02T09:57:36Z

components/tour/TourContext.ts

+
+import type { SemanticName } from './interface';
+
+export interface TourContextProps {


这个好像没地方用到

已移除，确实用不上了，一开始是为了解决内部使用的调试面板。

petercat-assistant bot reviewed Jan 6, 2025

View reviewed changes

components/tour/index.tsx Outdated Show resolved Hide resolved

thinkasany mentioned this pull request Jan 6, 2025

Ant Design v6 tasks #52115

Closed

thinkasany commented Jan 6, 2025

View reviewed changes

.dumi/components/SemanticPreview.tsx Outdated Show resolved Hide resolved

thinkasany force-pushed the cp-tour branch 8 times, most recently from 5e90a15 to 1dd037c Compare January 26, 2025 13:23

zombieJ reviewed Jan 27, 2025

View reviewed changes

components/tour/demo/_semantic.tsx Show resolved Hide resolved

thinkasany force-pushed the cp-tour branch 2 times, most recently from 7a5e647 to 1935264 Compare February 21, 2025 02:00

zombieJ reviewed Feb 21, 2025

View reviewed changes

components/tour/demo/_semantic.tsx Show resolved Hide resolved

zombieJ self-assigned this Feb 24, 2025

thinkasany force-pushed the cp-tour branch 4 times, most recently from da3b88c to 74e0951 Compare February 27, 2025 14:21

zombieJ reviewed Feb 28, 2025

View reviewed changes

components/tour/demo/_semantic.tsx Show resolved Hide resolved

zombieJ reviewed Feb 28, 2025

View reviewed changes

components/tour/demo/_semantic.tsx Show resolved Hide resolved

thinkasany force-pushed the cp-tour branch from 74e0951 to 7b3691f Compare February 28, 2025 07:59

zombieJ reviewed Mar 2, 2025

View reviewed changes

thinkasany force-pushed the cp-tour branch from 807876d to 5f2802a Compare March 2, 2025 12:14

feat: ConfigProvider support classname and styles for tour

28109bd

thinkasany force-pushed the cp-tour branch from 5f2802a to 28109bd Compare March 2, 2025 12:18

fix

8fec1bf

zombieJ approved these changes Mar 3, 2025

View reviewed changes

zombieJ merged commit 7f11800 into ant-design:next Mar 3, 2025
37 checks passed

thinkasany mentioned this pull request Mar 5, 2025

feat: Tour step add coverStyle prop #53065

Closed

17 tasks

Wxh16144 changed the title ~~feat: ConfigProvider support Tour~~ feat(Tour): support ConfigProvider Nov 28, 2025


		import type { SemanticName } from './interface';

		export interface TourContextProps {

Uh oh!

Conversation

thinkasany commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤔 This is a ...

🔗 Related Issues

📝 Change Log

Uh oh!

bolt-new-by-stackblitz bot commented Jan 6, 2025

Uh oh!

github-actions bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

👁 Visual Regression Report for PR #52250 Passed ✅

Uh oh!

github-actions bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petercat-assistant bot commented Jan 6, 2025

Walkthrough

Changes

Uh oh!

Uh oh!

pkg-pr-new bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Uh oh!

Uh oh!

codecov bot commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zombieJ Mar 2, 2025

Choose a reason for hiding this comment

Uh oh!

thinkasany Mar 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

thinkasany commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 6, 2025 •

edited

Loading

codecov bot commented Jan 6, 2025 •

edited

Loading

codecov bot commented Jan 6, 2025 •

edited

Loading