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

Wizard: Container UI and options endpoint #4700

Closed
jwold opened this issue May 13, 2020 · 3 comments · Fixed by #4765
Closed

Wizard: Container UI and options endpoint #4700

jwold opened this issue May 13, 2020 · 3 comments · Fixed by #4765
Labels
Changelogged Whether the issue/PR has been added to release notes. UX WS:UX Work stream for UX/Front-end
Milestone

Comments

@jwold
Copy link
Collaborator

jwold commented May 13, 2020

Feature description

This is an issue to create the components needed for the wizard container.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

  • Create the framework for the wizard steps.

  • Includes building out the stepper UI

  • Includes the UI framework for buttons, interface elements, etc.

Implementation brief

PHP updates

  • A REST endpoint will be created to allow the retrieval and saving of plugin options relevant to the wizard screen.
  • Will override the setup wizard admin screen by hooking into the admin_head-${screen} hook and generating the markup from the head down. This won't be complicated because the body will just be the empty div for React to render into.

JS/React

  • This will include a main layout component for the setup wizard, with the main parts being the stepper component, the panel, and the navigation.
  • A mobile layout will be included. We're keeping this simple, with a single breakpoint and most things just stacking (the stepper will collapse into a more compact version).
  • Text in the UI will be translatable
  • An alert similar to Gutenberg's UnsavedChangesWarning will prompt the user if they leave with options unsaved.
  • A React context provider will be created to handle interactions with the options endpoint.

QA testing instructions

  1. Inside your local copy of the repo, fetch the latest updates: git fetch
  2. Check out this branch with git checkout feature/4700-setup-onboarding
  3. Rebuild: composer install && npm install && npm run build
  4. Start your environment: ./bin/local-env/start.sh
  5. Navigate to the wizard page: http://localhost:8890/wp-admin/admin.php?page=amp-setup&amp-new-onboarding=1
  6. Verify you can click to the last screen and back.
  7. Verify everything matches the designs.

Demo

Changelog entry

@jwold jwold added the UX label May 13, 2020
@jwold jwold added this to the Sprint 29 milestone May 13, 2020
@jwold
Copy link
Collaborator Author

jwold commented May 13, 2020

This is related to #3728 (example)

@jwold jwold changed the title Example issue during onboarding wizard (one of the four approved issues) Wizard: Design container for steps May 13, 2020
@jwold
Copy link
Collaborator Author

jwold commented May 14, 2020

Notes from meeting:

  • You can go through wizard completely or bail and restart.
  • If you go through wizard again after completely entirely it should show what they selected before
  • If they abort wizard and come back it will have default values or what they selected before
  • Add AC to the “container UI” issue to define the elements we’re building Joshua task

@kmyram kmyram added the WS:UX Work stream for UX/Front-end label May 15, 2020
@johnwatkins0 johnwatkins0 self-assigned this May 19, 2020
@johnwatkins0
Copy link
Contributor

I've updated the implementation brief with a few details about what I'm working on for this. I'll fill in the QA steps when I create the PR.

@johnwatkins0 johnwatkins0 changed the title Wizard: Design container for steps Wizard: Container UI and options endpoint May 22, 2020
@johnwatkins0 johnwatkins0 linked a pull request Jun 1, 2020 that will close this issue
3 tasks
@westonruter westonruter modified the milestones: Sprint 29, v1.6 Jun 2, 2020
@westonruter westonruter added the Changelogged Whether the issue/PR has been added to release notes. label Jul 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelogged Whether the issue/PR has been added to release notes. UX WS:UX Work stream for UX/Front-end
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants