npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-dynamic-help

v3.1.2

Published

React Dynamic Help - Create flows of helpful popups in your React App

Downloads

121

Readme

react-dynamic-help

Create flows of helpful prompts in your react application.

This library is intended to pop up help for the user while they use the app.

(In contrast to the common "tour based" help libraries, which "show your user the app in action" while they click "Next".)


V 3.0.2 - As integrated with online-go.com.

Demo at https://github.com/GreenAsJade/react-dynamic-help-demo


The app interaction is intended to be minimally intrusive in the app codebase.

The app interacts primarily by registering elements as "help targets", and calling a callback to indicate that the target has been used.

function AppWithHelp(): JSX.Element {
   return (
       <DynamicHelp.HelpProvider>
           <App />
           <HelpFlows />
       </DynamicHelp.HelpProvider>
   );
}

export const AComponent = (props: ConfigProps): JSX.Element => {

   const { registerTargetItem } = React.useContext(DynamicHelp.Api);

   const { ref: addStatButton, used: signalAddStatUsed } =
       registerTargetItem("add-stat-button");

   const addStat = () => {
       setNewStatEntryOpen(true);
       signalAddStatUsed();
   };

   return ( // ...
                   <FA
                       ref={addStatButton}
                       icon={faCirclePlus}
                       onClick={addStat}
                   />

Help Items and their Flows are specified in a separate JSX tree.

export function HelpFlows(): JSX.Element {
   return (
       <div className="help-flow-container">
           <HelpFlow id="new-user" showInitially={true}>
               <HelpItem target="help-toggle">
                   <div>Click here to see more Dynamic Help</div>
               </HelpItem>
           </HelpFlow>

           <HelpFlow id="basic" showInitially={false}>
               <HelpItem target="add-stat-button">
                   <div>Click to add a stat</div>
               </HelpItem>
               <HelpItem target="stat-name-input" position="bottom-centre">
                   <div>Enter the name for a stat</div>
               </HelpItem>
               <HelpItem target="dice-chooser" position="bottom-center">
                   <div>Choose a dice type</div>
               </HelpItem>
               <HelpItem id="help-for-stat-ok" target="stat-ok">
                   <div>OK?</div>

// …

Things to do:

  • Make sure that deleted flows (and renamed ones) are removed from stored state.

  • Support a no-op pseudo Item somehow, so you can have a break in a flow, with a resume.

    • Wouldn't this just amount to "start another flow?"
      • It's not the same, because "start another flow" calls for app interaction, this should be doable in the HelpFlow/Item definition.
  • Support showing multiple Help Items at a single step in the flow.

  • Have the standard Help Item layout be more "callout like", so it indicates clearly what the target is.

  • Be able to target items via css selector as an alternative to ref

    • Don't know if it is even possible.
    • Note that this would not support registration based features, but would be even less imact on the app.

This library was originally packaged following https://www.youtube.com/watch?v=vRmLTZyq57U . Not great.

Now it's packaged following https://www.youtube.com/watch?v=GVN9d1rFeCo. So far so good.