JSPM

my-test-joyride

0.0.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q15474F
  • License MIT

Create guided tours for your apps

Package Exports

  • my-test-joyride

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (my-test-joyride) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

My test joyride

in this package we used react-joyride

Joyride example image

Create awesome tours for your app!

Showcase your app to new users or explain functionality of new features.

It uses react-floater for positioning and styling.
And you can use your own components too!

View the demo here (or the codesandbox examples)

Read the docs

Chat about it in our Spectrum community

Setup

npm i my-test-joyride

Getting Started

create new element in your [index.html] for [react portal]

<div id="tour-buttons-container"></div>

in your [App.js] importing [TourBackdrop] and wrap your components by [TourBackdrop] and pass [config] to props in config value [baseUrl] waiting string with backend url it is for saving selected elements from admin tour like in example below

import { TourBackdrop } from 'my-test-joyride';

const tourConfig = {
  baseUrl: 'https://<your backend address>/',
};

function App() {
  return (
    <TourBackdrop config={tourConfig}>
      // the example how can look like your components
      <AppBar />
      <Suspense fallback={<Loading />}>
        <Switch>
          <Route path="/" exact>
            <HomePage />
          </Route>
          <Route path="/movies/:movieId">
            <MovieDetailsPage />
          </Route>

          <Route path="/movies">
            <MoviesPage />
          </Route>
        </Switch>
      </Suspense>
    </TourBackdrop>
  );
}

after this you need wrap your logic part of your app by [IntroductionTour] like this

import { IntroductionTour } from 'my-test-joyride';
// it is AppBar from example before
export function AppBar() {
  return (
    <IntroductionTour className={styles.Header} tag="header" title="navigationInHeader">
      <Navigation />
    </IntroductionTour>
  );
}

Start coding! 🎉