Skip to content

Add new Tour component #817

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

Merged
merged 26 commits into from
Apr 20, 2024
Merged

Conversation

snowe2010
Copy link
Contributor

Proposed changes

This PR adds a new Tour component to the list of components, allowing creators to provide a product tour for their apps.

Types of changes

What types of changes does your code introduce to Lowcoder?
Put an x in the boxes that apply.

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist

  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

This PR adds a new Antd Tour Component to the list of components available in Lowcoder. It adds a majority of the properties and configuration settings that are available in the Antd version, but not all of them.

Here are several example apps showing the component working as intended, in a majority of the cases.

show tour settings.json
show step settings.json
test all against tour.json

Some cases do not work:

  • chart
  • table
  • list view
  • grid
  • tabs that aren't visible

Here are some videos showing the feature:

Screen.Recording.2024-04-19.at.5.48.06.PM.mov
Screen.Recording.2024-04-19.at.5.49.59.PM.mov

currently only shows a tour modal, not connected to any components
can be triggered with the Control a Component event handler
still doesn't work, but I think I'm closer. Currently the step refs are
always undefined.
I don't know exactly what I was doing wrong, so I copied the dropdown
control and modified it to accept the editor state. this could most
likely be done cleaner by allowing for the existing dropdown control to
accept a function with generic arguments, but that can be cleaned up
later.
update title and description to allow any html
also fixes issues with step properties always being set, thus making
root properties do nothing.
also disable indicators for now
Copy link

netlify bot commented Apr 19, 2024

👷 Deploy request for lowcoder-test pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 781c09b

Copy link
Contributor

@FalkWolsky FalkWolsky left a comment

Choose a reason for hiding this comment

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

Impressive! We feel honored about your truly valuable Contribution! Thank you very much in the name of all Lowcoders!

@FalkWolsky FalkWolsky merged commit 199dca0 into lowcoder-org:dev Apr 20, 2024
3 checks passed
@snowe2010 snowe2010 deleted the add-tour-component branch April 22, 2024 16:54
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