microsoft / microsoft/pxt-microbit

Extending the "Tour" to allow extensions to use the feature

Open
#4,991 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tour
Dominant language
TypeScript
Stars
804
Forks
721
Avg merge
2d 9h
Merged PRs (30d)
2

Description

As mentioned in our meeting earlier today, it would be really nice for extension developers to be able to use the same help popup mechanism as the beta Tour feature uses to introduce the extension once its loaded into the workspace.

image

Having access to an API to indicate where an extension has been loaded into the toolbox and have it highlighted for the user would be really nice; plus maybe the option to indicate one or more blocks within an extension to highlight functionality.

Perhaps some sensible limit on the number of these that can be shown for a given extension would be good too; to prevent excessive pop-ups when users add an extension (and to inhibit any kind of malicious extension that would pop-up forever)

Personally, I think a nice workflow would be to offer an extension the option to show an initial, single pop-up to indicate where it has been loaded into the toolbox, then have a button on this initial one to continue the tour into the extension where additional blocks could be highlighted, or a second button to just stop the tour at this point.

I've included a super-quick mock-up of the intro popup below (pretending that the loop blocks are an extension)
image

(Pinging @abchatra for reference)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the beta Tour implementation and the extension-loading and toolbox entry points. Define how an extension would request an initial toolbox highlight, optional block highlights, and continuation or dismissal controls, while enforcing a sensible display limit. Done means the API and popup workflow are specified and usable by extension developers.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.