⚡️ Keysho for React
Add ⌘ + K to your React app in less than 5 minutes
Keysho provides an SDK and no-code Admin panel to easily integrate and power a fast popup, omnibox experience for your customers and website visitors.
⚡️ Build a Keysho
Step 1. In order to get started, visit the Keysho Admin Portal. Create an account, and create a new project. Afterwards, customize the project to your liking. Current options include:
- Customizing Colors: Text, Accents, Subtext, etc
- Adding Links: Add hotlinks to URLs (i.e. www.github.com)
- Adding Actions: Add hooks to javascript actions (i.e. toggle dark mode, throw confetti)
- Remove Keysho Branding: removes the keysho branding in the bottom right of the Keysho omnibox
After creating a Keysho, go to the 'installations' tab to see next steps to get everything installed on your web app.
🌊 Installation
Step 2. You can install the Keysho package with the following line:
npm install keysho --force
🚀 Basic Usage
Step 3. After installing the package, you can embed Keysho into the root file of your application by doing the following:
import { Keysho } from "keysho";
import "keysho/dist/index.css";
...
<Keysho
config_uuid='b46acd46-e92c-11ec-995a-1eab7e003dc6'
/>
🪄 Actions (optional)
Step 4. If your Keysho consists of any actions, you'll need to do one extra step which is adding an action map by doing the following:
const ACTION_MAP = {
action_function_1: () => {} // implement action_function_1 here,
action_function_2: () => {} // implement action_function_2 here
...
}
🎊 You're done!
Step 5. Hit cmd
+ k
on your website and enjoy. Please tag me on Twitter at @aakashadesara with your unique implementation of Keysho - I'd love to check it out!
License
MIT © aakashadesara