Giter VIP home page Giter VIP logo

react-spotlight-tour's Introduction


React Spotlight Tour

A self-configuring tutorial library for React.
Blog ย |ย  Docs ย |ย  Demo ย |ย  npm

Features

  • Clean and unobtrusive overlay to highlight the important parts of your app inspired by Chardin.js
  • Lightweight, only depends on React and the Spotlight component can be lazy-loaded
  • Uses composable React hooks to build tutorials rather than selectors
  • Mobile and desktop support
  • Fully typed with TypeScript!

Getting Started

react-spotlight-tour comes with everything you need built into the npm package, no need for integration with bundlers. Install the package with:

$ npm install react-spotlight-tour

Example Usage

import { useState } from 'react';
import { SpotlightTour, useSpotlight } from 'react-spotlight-tour';
import Spotlight from 'react-spotlight-tour/spotlight';

function StatusUpdateInput() {
  const spotlightRef = useSpotlight('Update your status');

  // ...

  return (
    <div ref={spotlightRef}>
      <textarea />
      <button>Update status</button>
    </div>
  );
}

function HomePage() {
  const [isOpen, setOpen] = useState(false);

  return (
    <SpotlightTour
      open={isOpen}
      onClose={() => setOpen(false)}
      Spotlight={Spotlight}
    >
      <StatusUpdateInput />
    </SpotlightTour>
  );
}

Contributing

To test changes locally run:

$ npx tsc --module es2015 --outDir website/src/react-spotlight-tour

You can then see your changes live on the documentation website by running:

$ cd website
$ npm start

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.