Skip to content

Conversation

@Vijaykv5
Copy link
Member

@Vijaykv5 Vijaykv5 commented Oct 5, 2024

Requirements

  • This PR has a title that briefly describes the work done including a conventional commit type prefix and a Jira ticket number if applicable. See existing PR titles for inspiration.

For changes to apps

If applicable

  • My work includes tests or is validated by existing tests.

Summary

This PR add a config to the onboarding module to enable/disable the tutorials.
It is disabled by default

Screenshots

enable.disable.tutorials.mov

Related Issue

O3-4060

Other

cc : @jayasanka-sack

Copy link
Member

@jayasanka-sack jayasanka-sack left a comment

Choose a reason for hiding this comment

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

The "tutorials" menu item should be hidden if the config is set to false.

@jayasanka-sack
Copy link
Member

Thanks @Vijaykv5. Could you please send me a screenshot? Also, shall we rename the config to enableTutorials?

<div onClick={handleOpenModal}>{t('tutorials', 'Tutorials')}</div>
</>
);
return <>{showTutorial && <div onClick={handleOpenModal}>{t('tutorials', 'Tutorials')}</div>}</>;
Copy link
Member

Choose a reason for hiding this comment

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

We should return null here to completely avoid rendering the component. We need to do the same for the root component so that the joyride component won't get rendered too.

@Vijaykv5
Copy link
Member Author

Thanks @Vijaykv5. Could you please send me a screenshot? Also, shall we rename the config to enableTutorials?

updated.mov

@Vijaykv5
Copy link
Member Author

@jayasanka-sack How can we modify the test, since the tutorials are disabled by default, this results in failing tests(missing the tutorials section)

@jayasanka-sack
Copy link
Member

@gracepotma should we enable tutorials by default? The plan is to include this config to bundle this package with the release, and implementors can enable/disable or add their tutorials.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants