HomeBytesheetsUI TemplatesUI ToolsRoad MapsStack DiscussionByte Camp
Bytes UIv0.1.0
⌘K

Getting Started

Add @bytesui/react to your React application in seconds.

Installation

npm install @bytesui/react react-router-dom

Quick Usage

Wrap your application layout inside `ToursProvider` and pass the active route path using `useLocation` from React Router.

import { BrowserRouter, useLocation, useNavigate } from 'react-router-dom';
import { ToursProvider, ToursOverlay } from '@bytesui/react';
import { Guides } from './guides';

function AppContent() {
  const location = useLocation();
  const navigate = useNavigate();

  return (
    <ToursProvider
      currentRoutePath={location.pathname + location.search}
      guides={Guides}
      onNavigate={(path) => navigate(path)}
    >
      <div>My Application Content</div>
      <ToursOverlay />
    </ToursProvider>
  );
}

export default function App() {
  return (
    <BrowserRouter>
      <AppContent />
    </BrowserRouter>
  );
}