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

Plugin web API onInstall dialog for onboarding users #22

Open
richardguerre opened this issue Oct 15, 2023 · 0 comments
Open

Plugin web API onInstall dialog for onboarding users #22

richardguerre opened this issue Oct 15, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@richardguerre
Copy link
Owner

Context

  • Currently when the user installs a plugin, it shows a toast saying "Plugin installed". There is no indication what the plugin does or how it works.
  • The user has to wonder around their Flow instance to see if something changed.

Solution

Plugins should be able to have users go through an onboarding experience after installing the plugin:

  • Expose web.onInstall as an API for plugins to use.
  • If the plugin returns null, then no onboarding experience is shown.
  • If the plugin returns a component/JSX, then that content is shown within Dialog or Modal with a close button so the user know what to do.
@richardguerre richardguerre added the enhancement New feature or request label Oct 15, 2023
@github-project-automation github-project-automation bot moved this to Todo in Flow 1.0 Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant