/scoutbar

⌨️ A User-friendly, easy-to-use, scalable, and highly customizable component for automating your command+k experience.

Primary LanguageTypeScriptMIT LicenseMIT


ScoutBar

⌨️ Spotlight for your app



npm

NPM

See Demo On Codesandbox

See Documentation

⚡️Overview

It has been observed that users who are familiar with the CMD + K shortcut for searching and performing complex actions within applications like Slack and Workspace by Facebook are able to navigate these apps more efficiently by 21%. This highlights the value of providing users with effective search and navigation tools.

With this in mind, we are excited to introduce Scoutbar - an easy-to-install React component that automates the CMD + K experience. Scoutbar is portable and extensible, making it a convenient solution for improving the search and navigation capabilities of your application. Give your users the ability to quickly find what they are looking for and increase their productivity with Scoutbar.

🔧 Installation

You can easily install this package with yarn or npm:

$ yarn add scoutbar

or

$ npm install scoutbar

✨ Features

  • 🤘 Super easy to install
  • 📦 It's tiny, only 400b gzipped
  • 🙅‍♂️ It's got keyboard nav support
    • And keyboard shortcuts to configure specific actions
  • 🔧 Flexible API
    • A simple data structure and function helper to customize your experience
  • 💪 Fully tested, typed, and reliable
  • 🌍 Works in CommonJS, ESM, and the browser
  • 🤓 Handy helpers included
  • 🧑 Zero dependencies

📖 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! There are clear descriptions of each utility, as well as instructions on how to use them, in the documentation.

🍷 Documentation See All

tutorial

Type -> Boolean

Default -> true

Allows you the ability to disable / hide scoutbar tutorial hints. i'e the section that tells users to navigate with the arrows or tabs. e.g

  <ScoutBar
    tutorial={false}
    ...
  />

noAnimation

Type -> Boolean

Default -> false

Allows you to disable every animation on scoutbar Disables every animations on scoutbar. this is by default true if scoutbar detects that the user has requested that the system minimize the amount of non-essential motion it uses.

  <ScoutBar
    noAnimation={false}
    ...
  />

theme

Type -> 'light' | 'dark' | 'auto'

Default -> 'light'

Allows you to switch the theme of the scoutbar depending on how you want it. auto switches to the theme of the current system.

  <ScoutBar
    theme="light"
    ...
  />

acknowledgement

Type -> Boolean

Default -> true

Show the scoutbar acknowledgement logo on the top right of the input bar.

  <ScoutBar
   acknowledgement={true}
    ...
  />

brandColor

Type -> String

Default -> #000

Allows you to set the official scoutbar brand color. it helps to match the color grade on your application

  <ScoutBar
   brandColor="red"
    ...
  />

placeholder

Type -> String | String[]

Default -> ['What would you like to do today ?','What do you need?', 'Lets help you navigate'],

Allows you to switch between different placeholder texts or just a single one.

  <ScoutBar
    placeholder={[
      'What products do you need ? ',
      'Whats the name of your phone ?'
    ]}

    or

    placeholder="What do you need ?"
    ...
  />

revealScoutbar

Type -> boolean

Default -> false

Reveal the scoutbar with an external action. PS forcefully opens the scoutbar

  <ScoutBar
revealScoutbar={// your state hook here }
    ...
  />

See All Documentation

🤔Thought Process

Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue. This can be a feature request or a bug report. After a maintainer has triaged your issue, you are welcome to collaborate on a pull request. If your change is small or uncomplicated, you are welcome to open an issue and pull request simultaneously.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Running Scoutbar Locally

A local test environment has been setup for developers that wants to develop and contribute to scoutbar. to start up the dev server do the following

$ yarn install
$ yarn run dev // server running on http://localhost:3008

Linking Scoutbar Locally

Run

$ npm link

This will create a symbolic link in the /usr/local/lib/node_modules/ folder, that contains the global npm packages in the system, the ones installed using npm -g.

npm link scoutbar

Then we run this in the project we want to link scoutbar locally to

See More on contributing

🤝 License

MIT © codewonders.dev  ·  GitHub @adenekan41 / codewonders