type sum
copied!
npm i keybored
copy
Features
keybored is built for React and ready to handle all of your on-screen typing needs
Style Everything
Customize keybored to your heart’s desire. With the included CSS file, you can style every aspect of your keys, including creating one-offs.
Choose your bored
Choose between ‘std’ or ‘wasd’ for an experience that caters to your needs. Check out our futures section for a peek at the roadmap.
Accessible by default
One of the biggest wins with keybored has been creating a keyboard that’s not only clickable and tappable, but also targetable using tabbing.
Install
Let’s get tippity typing
copied!
npm i keybored
copy
link
Usage
A peek behind the curtain
Options
Name
Type
Default
whatKey
boolean
false
Helper function. Logs key input to the console.
Name
Type
Default
keyboard
string
'.std'
Keyboard selector. Input ‘.wasd’ to see an alternative.
Name
Type
Default
nestIn
string
'body'
This value determines where your keybored is placed in your app.
Name
Type
Default
function
function
NA
This is where the magic happens! Create a function that uses keybored’s output values to do the thing.
Futures
Here’s a few things we would love your help creating to make keybored even better
link
Custom keyboreds
This is a big one. How sick would it be to have a ‘custom’ option allowing users to handcraft the keybored they need?
link
TS support
Duh, everyone asks for this.
link
Mobile bugs
As you probably already know, there’s some bugginess on mobile. Hot-ticket item right here!
link