Getting Started

Simplest way to use this is through link tag (thanks to https://unpkg.com/):

You can also install it from npm:

Usage

According to W3C, the kbd element represents user input (typically keyboard input, although it may also be used to represent other input, such as voice commands).

The main purpose of Keyboard CSS is to enhance look and feel of kbd elements, but it can also be used with button and a elements, for better interactivity (like simulating click).

Basic Usage

You just have to add a single class to kbd, button or a to apply the related styles, i.e. kbc-button

Usage with kbd

When .kbc-button is used with kbd element, font-size and line-height is inherited from parent for better accessibility.

                    <h3>Press <kbd class="kbc-button">/</kbd> to search this site.</h3>
                    <p>Press <kbd class="kbc-button">Ctrl</kbd> + <kbd class="kbc-button">Shift</kbd> + <kbd class="kbc-button">R</kbd> to re-render this page.</p>
                    

                    
Press / to search this site.
                    
Press Ctrl + Shift + R to re-render this page.
                  

Usage with button & a

When used with button and a elements, it starts supporting interactions.

                      <button class="kbc-button">K</button>
                      <a class="kbc-button">K</a>
                    

                    K
                    K
                  

Remove Surface Border

To remove surface border, simply add no-container class.

                      <kbd class="kbc-button no-container">K</kbd>
                      <button class="kbc-button no-container">K</button>
                      <a class="kbc-button no-container">K</a>
                    

                    K
                    K
                    K
                  

Sizing

Total 5 sizes are available. You can respective classes to see the effect.

                    
                      <button class="kbc-button kbc-button-xxs">XXS</button>
                      <button class="kbc-button kbc-button-xs">XS</button>
                      <button class="kbc-button kbc-button-sm">SM</button>
                      <button class="kbc-button">MD</button>
                      <button class="kbc-button kbc-button-lg">LG</button>
                    
                  

                    XXS
                    XS
                    SM
                    MD
                    LG
                  

States

Like all buttons, this also have 4 states: :hover, :focus, :active, and :disabled. You can add classes with same state name to see it statically.

                    
                      <button class="kbc-button hover">Hovered</button>
                      <button class="kbc-button focus">Focused</button>
                      <button class="kbc-button active">Activated</button>
                      <button class="kbc-button disabled">Disabled</button>
                    
                  

                    Hovered
                    Focused
                    Active
                    Disabled
                  

Colors

Colors are directly inspired from Bootstrap.

                    
                      <kbd class="kbc-button">Default</kbd>
                      <kbd class="kbc-button kbc-button-primary">Primary</kbd>
                      <kbd class="kbc-button kbc-button-secondary">Secondary</kbd>
                      <kbd class="kbc-button kbc-button-success">Success</kbd>
                      <kbd class="kbc-button kbc-button-danger">Danger</kbd>
                      <kbd class="kbc-button kbc-button-info">Info</kbd>
                      <kbd class="kbc-button kbc-button-light">Light</kbd>
                      <kbd class="kbc-button kbc-button-dark">Dark</kbd>
                    
                  

                    Default
                    Primary
                    Secondary
                    Success
                    Danger
                    Info
                    Light
                    Dark
                  

Usage with Javascript

You can do a whole bunch of other stuff with Keyboard CSS when you combine it with Javascript. A simple example:

                const element = document.querySelector('.my-element');
                element.classList.add('kbc-button', 'kbc-button-dark');
              

You can also bind keyboard events:

                  <button class="kbc-button" data-keyboard-key="K">K</button>
                

                  document.addEventListener('keydown', (ev) => {
                    const key = ev.key;
                    const element = document.querySelector(
                        '[data-keyboard-key="' + key.toUpperCase() + '"]'
                    );
                    element.classList.add('active');
                });
                
                document.addEventListener('keyup', (ev) => {
                    const key = ev.key;
                    const element = document.querySelector(
                        '[data-keyboard-key="' + key.toUpperCase() + '"]'
                    );
                    element.classList.remove('active');
                });
                

                  K
                

Advanced Configuration Options with SASS

I have used SASS to create this build. Mostly, everything is handled through sass variables, so you can easily override the defaults, thanks to !default flag.

Variables file

You can check all the variables at _variables.scss file.

Change font size

For example, to change the default base font-size of button and a elements, to 20px, you can do like below:

                // assuming you have already done: npm i keyboard-css
      
                // define variables first
                $kbc-font-size-base: 20 / 16 * 1rem;
      
                // and then import
                @import "path/to/node_modules/keyboard-css/dist/scss/main";
              

or with new @use rule, you can achieve the same using below code:

                // assuming you have already done: npm i keyboard-css
      
                @use "path/to/node_modules/keyboard-css/dist/scss/main" with (
                    $kbc-font-size-base: 20 / 16 * 1rem
                );
              

Add new size

You can also introduce your new size:

                // add size in $kbc-btn-size-map
                $kbc-btn-size-map: (
                  "xl": (
                    "padding-y": 0.75rem,
                    "padding-x": 1.25rem,
                    "font-size": 1.5rem,
                    "line-height": 1.5,
                    "depth": 11,
                    "after-border-width": 0.125rem,
                    "after-adjust-x": -0.125rem,
                    "after-adjust-y": -5,
                    "after-border-radius": 0.5rem,
                  ),
                );
      
                // and then import
                @import "path/to/node_modules/keyboard-css/dist/scss/main";
              

And then use it in HTML:

                <button class="kbc-button kbc-button-xl">XL Button</button>
              

Change depth

Depth is calculated and applied as multiple shadows. To increase/decrease it, you can change respective variables:

                // change depth first
                $kbc-kbd-depth: 4;
      
                // and then import
                @import "path/to/node_modules/keyboard-css/dist/scss/main";
              

License and Contributing

Keyboard CSS is licensed under the MIT license. And same is available on Github:

Contributing

🙏 I would ❤️ for you to contribute to Keyboard CSS and help make it even better than it is today! Checkout CONTRIBUTING guidelines for more details.

Code of Conduct

This project and everyone participating in it are governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to shhdharmen@gmail.com.

Contributors

Dharmen Shah 💻 🖋 🎨 📖 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!