@walkthru/react v0.2.0-beta.8

WalkThru React component

This repo is for the React component that displays a compiled walkthru tutorial.

To learn more about WalkThru, see the main repo.

Installation

npm i -S @walkthru/react

Usage

Render the component anywhere in your app.

Note that you'll need a way to get the data object from the WalkThru data module.

import { WalkThru } from '@walkthru/react'

function App () {

  // Logic
  
  return (
    <WalkThru
      data={data}
      tutorialSlug={tutorialSlug}
      stepSlug={stepSlug}
      classes={{
        instructions: ''
      }}
    />
  )
}

Props

• data. Returned from getData.
• tutorialSlug. The slug of the current tutorial e.g. my-tutorial.
• stepSlug. The slug of the current step e.g. introduction.
• classes. An object that can be used to add classes to elements of the component.
  • instructions. Classes to be applied to the instructions content.
  • select. Classes applied to React Select.

Tips

• Don't server render this component.
• The step and tutorial slugs will usually be dynamic segments of the URL. e.g. https://myapp.com/{tutorial-slug}#{step-slug}.