Getting Started

Welcome to the Scoutbar documentation!

Overview

Users enjoy hitting CMD + K to search and perform complex actions online on big projects like Slack, Workspace by Facebook, etc. Users with good knowledge of what they are looking for have been proven to be able to navigate apps more effectively by 22%. Introducing Scoutbar, an easy-to-install, portable, and extensible React component for automating your command+k experience.

See Demo On Codesandbox

Installation

You can easily install this package with yarn or npm:

$ yarn add scoutbar

or

$ npm install scoutbar

📖 Usage

One of the best things about it is that it is as simple as integrating one component. you have scoutbar on your app.

import React from 'react';
import { ScoutBar } from 'scoutbar';

export default function App() {
  return (
    <div className="App">
      <ScoutBar
        actions={({ createScoutAction }) => [
          createScoutAction({
            label: 'Get Started',
            description: 'Get started with scoutbar',
            href: '/',
          }),
        ]}
      />
    </div>
  );
}

Seeing is believing! Click CMD + K or Windows + k to see scoutbar in action

Continue Learning

For more information on what to do next, we recommend the following sections: