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

[New Feature] Add a Tour Component for User Guides on website. #45039

Closed
sohail9744 opened this issue Jan 16, 2025 · 3 comments
Closed

[New Feature] Add a Tour Component for User Guides on website. #45039

sohail9744 opened this issue Jan 16, 2025 · 3 comments
Assignees
Labels
duplicate This issue or pull request already exists new feature New feature or request

Comments

@sohail9744
Copy link

sohail9744 commented Jan 16, 2025

Summary

I recently completed User Acceptance Testing (UAT) for my project and realized that a built-in Tour component would be extremely helpful. A Tour component helps in guiding users through the product, step-by-step, making it easier for them to understand the features and functionalities of the application.

but it would be fantastic if Material UI had its own Tour component. This component could provide a customizable, easy-to-use user guide or walkthrough directly integrated into the Material UI ecosystem.

Examples

//Something like this below to call the component

import { Guider } from '@mui/icons-material';

const MyTour = () => {
const steps = [
{ target: '#feature-1', content: 'This is feature 1' },
{ target: '#feature-2', content: 'Here is feature 2' },
];

return ;
};

Motivation

I believe that adding a Tour component would be a valuable addition to Material UI. It would simplify the implementation of user guides and enhance the user experience across a wide range of applications. Before proceeding with a pull request, I would like to gauge whether this feature would align with the project's goals and whether the maintainers would be interested in its implementation.

Search keywords: tour

@sohail9744 sohail9744 added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Jan 16, 2025
@sai6855
Copy link
Contributor

sai6855 commented Jan 17, 2025

duplicate of mui/mui-x#13933?

@zannager zannager added the new feature New feature or request label Jan 17, 2025
@DiegoAndai
Copy link
Member

duplicate of mui/mui-x#13933?

It is. I'll close it as such.

@sohail9744 thanks for reaching out. If you wish to see this feature, please upvote (👍🏼) mui/mui-x#13933.

@DiegoAndai DiegoAndai added duplicate This issue or pull request already exists and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jan 17, 2025
Copy link

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

Note

@sohail9744 How did we do? Your experience with our support team matters to us. If you have a moment, please share your thoughts in this short Support Satisfaction survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists new feature New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants