skip to content

Kbd

Use a single keyboard key to trigger sounds, toggle props, or do just about anything.

class
Kbd
extends
Set
tag
<kbd-blam>
see

Props

name type default description
key string Spacebar (‘ ’)

The relevant key (corresponding to event.key)

ramp number

In beats. Where the prop is an audioParam, whether to ramp the value. For example, for gain, whether to fade/slide between the start and end values.

revert boolean false

When revert is applied, values do not stick. Once set, the next event reverts them to the original value (the one taken from the element during initialization). Used with a low chance, you create the effect of a regular value that just occasionally, and momentarily, strays.

prop string null

Can be the name of a property (which may map to an audioParam), an attribute, a method/function, or prepend with -- to make it a CSS custom property.

value string null

Set-derived elements support special value syntax. Separate with | and one value is chosen at random. You can “prefer” certian values by including them more than once, like 0.1|0.1|0.2. Separate with ~ and a value is chosen within the range [x]~[n]. Separate with (a single space) if you are supplying multiple args to an element’s method.

once boolean false

Whether to only handle the event one time. Interesting, compositionally, when paired with a low chance.

robin boolean false

Only applies when using |-separated value syntax. Whether to cycle from first to last and back again (a “round robin”).

from string

A CSS selector representing all elements from which events will be listened to. If not set, the node array defaults to the element’s defaultFrom function’s return value.

to string

A CSS selector representing all elements to affect in response to the event. If not set, the node array defaults to the element’s defaultTo function’s return value.

event string blam

The event type to listen for. For many Event-based elements, this is the generic custom event blam.

bypass boolean false

Whether to stop responding to events as they happen.

chance boolean 1

The probability that the event will be responded to. From 0 to 1.

Examples

Examples that use the Kbd element: