No Preview

Sorry, but you either have no stories or none are selected somehow.

If the problem persists, check the browser console, or the terminal you've run Storybook from.

PWA
NameDescriptionDefault
onInstall
Function which runs after a user clicks install then accepts the prompt and installs the app.
() => void
-
onCancel
Function which runs after a user clicks install an   d then dismisses the prompt.
() => void
-
icon
A React Child to use as an icon which will appear on the left hand side of any text.
ReactChild
-
element
An alternative custom element to use as the install button (if this is used all icon, background and color props will be ignored).
ReactElement<any, string | ((props: any) => ReactElement<any, string | ... | (new (props: any) => Component<any, any, any>)>) | (new (props: any) => Component<any, any, any>)>
-
background
A CSS color string to use as the background color.
string
-
color
A CSS color string to use as the font color.
string
-
fakeIt
Whether to skip checks for a real PWA and just show the button with a fake install dialogue. Useful for testing.
boolean
-
defaultChecked
boolean
-
defaultValue
string | number | string[]
-
suppressContentEditableWarning
boolean
-
suppressHydrationWarning
boolean
-
accessKey
string
-
className
string
-
contentEditable
boolean | "true" | "false" | "inherit"
-
contextMenu
string
-
dir
string
-
draggable
Booleanish
-
hidden
boolean
-
id
string
-
lang
string
-
placeholder
string
-
slot
string
-
spellCheck
Booleanish
-
style
CSSProperties
-
tabIndex
number
-
title
string
-
translate
"yes" | "no"
-
radioGroup
string
-
role
string
-
about
string
-
datatype
string
-
inlist
any
-
prefix
string
-
property
string
-
resource
string
-
typeof
string
-
vocab
string
-
autoCapitalize
string
-
autoCorrect
string
-
autoSave
string
-
itemProp
string
-
itemScope
boolean
-
itemType
string
-
itemID
string
-
itemRef
string
-
results
number
-
security
string
-
unselectable
"on" | "off"
-
inputMode
Hints at the type of data that might be entered by the user while editing the element or its contents
"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"
-
is
Specify that a standard HTML element should behave like a defined custom built-in element
string
-
aria-activedescendant
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
string
-
aria-atomic
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
Booleanish
-
aria-autocomplete
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
presented if they are made.
"none" | "inline" | "list" | "both"
-
aria-busy
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
Booleanish
-
aria-checked
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
boolean | "true" | "false" | "mixed"
-
aria-colcount
Defines the total number of columns in a table, grid, or treegrid.
number
-
aria-colindex
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
number
-
aria-colspan
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
number
-
aria-controls
Identifies the element (or elements) whose contents or presence are controlled by the current element.
string
-
aria-current
Indicates the element that represents the current item within a container or set of related elements.
boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"
-
aria-describedby
Identifies the element (or elements) that describes the object.
string
-
aria-details
Identifies the element that provides a detailed, extended description for the object.
string
-
aria-disabled
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Booleanish
-
aria-dropeffect
Indicates what functions can be performed when a dragged object is released on the drop target.
"none" | "copy" | "execute" | "link" | "move" | "popup"
-
aria-errormessage
Identifies the element that provides an error message for the object.
string
-
aria-expanded
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Booleanish
-
aria-flowto
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
allows assistive technology to override the general default of reading in document source order.
string
-
aria-grabbed
Indicates an element's "grabbed" state in a drag-and-drop operation.
Booleanish
-
aria-haspopup
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"
-
aria-hidden
Indicates whether the element is exposed to an accessibility API.
Booleanish
-
aria-invalid
Indicates the entered value does not conform to the format expected by the application.
boolean | "true" | "false" | "grammar" | "spelling"
-
aria-keyshortcuts
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
string
-
aria-label
Defines a string value that labels the current element.
string
-
aria-labelledby
Identifies the element (or elements) that labels the current element.
string
-
aria-level
Defines the hierarchical level of an element within a structure.
number
-
aria-live
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
"off" | "assertive" | "polite"
-
aria-modal
Indicates whether an element is modal when displayed.
Booleanish
-
aria-multiline
Indicates whether a text box accepts multiple lines of input or only a single line.
Booleanish
-
aria-multiselectable
Indicates that the user may select more than one item from the current selectable descendants.
Booleanish
-
aria-orientation
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
"horizontal" | "vertical"
-
aria-owns
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
string
-
aria-placeholder
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
A hint could be a sample value or a brief description of the expected format.
string
-
aria-posinset
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
number
-
aria-pressed
Indicates the current "pressed" state of toggle buttons.
boolean | "true" | "false" | "mixed"
-
aria-readonly
Indicates that the element is not editable, but is otherwise operable.
Booleanish
-
aria-relevant
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
"text" | "additions" | "additions text" | "all" | "removals"
-
aria-required
Indicates that user input is required on the element before a form may be submitted.
Booleanish
-
aria-roledescription
Defines a human-readable, author-localized description for the role of an element.
string
-
aria-rowcount
Defines the total number of rows in a table, grid, or treegrid.
number
-
aria-rowindex
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
number
-
aria-rowspan
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
number
-
aria-selected
Indicates the current "selected" state of various widgets.
Booleanish
-
aria-setsize
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
number
-
aria-sort
Indicates if items in a table or grid are sorted in ascending or descending order.
"none" | "ascending" | "descending" | "other"
-
aria-valuemax
Defines the maximum allowed value for a range widget.
number
-
aria-valuemin
Defines the minimum allowed value for a range widget.
number
-
aria-valuenow
Defines the current value for a range widget.
number
-
aria-valuetext
Defines the human readable text alternative of aria-valuenow for a range widget.
string
-
dangerouslySetInnerHTML
{ __html: string; }
-
onCopy
(event: ClipboardEvent<HTMLButtonElement>) => void
-
onCopyCapture
(event: ClipboardEvent<HTMLButtonElement>) => void
-
onCut
(event: ClipboardEvent<HTMLButtonElement>) => void
-
onCutCapture
(event: ClipboardEvent<HTMLButtonElement>) => void
-
onPaste
(event: ClipboardEvent<HTMLButtonElement>) => void
-
onPasteCapture
(event: ClipboardEvent<HTMLButtonElement>) => void
-
onCompositionEnd
(event: CompositionEvent<HTMLButtonElement>) => void
-
onCompositionEndCapture
(event: CompositionEvent<HTMLButtonElement>) => void
-
onCompositionStart
(event: CompositionEvent<HTMLButtonElement>) => void
-
onCompositionStartCapture
(event: CompositionEvent<HTMLButtonElement>) => void
-
onCompositionUpdate
(event: CompositionEvent<HTMLButtonElement>) => void
-
onCompositionUpdateCapture
(event: CompositionEvent<HTMLButtonElement>) => void
-
onFocus
(event: FocusEvent<HTMLButtonElement>) => void
-
onFocusCapture
(event: FocusEvent<HTMLButtonElement>) => void
-
onBlur
(event: FocusEvent<HTMLButtonElement>) => void
-
onBlurCapture
(event: FocusEvent<HTMLButtonElement>) => void
-
onChange
(event: FormEvent<HTMLButtonElement>) => void
-
onChangeCapture
(event: FormEvent<HTMLButtonElement>) => void
-
onBeforeInput
(event: FormEvent<HTMLButtonElement>) => void
-
onBeforeInputCapture
(event: FormEvent<HTMLButtonElement>) => void
-
onInput
(event: FormEvent<HTMLButtonElement>) => void
-
onInputCapture
(event: FormEvent<HTMLButtonElement>) => void
-
onReset
(event: FormEvent<HTMLButtonElement>) => void
-
onResetCapture
(event: FormEvent<HTMLButtonElement>) => void
-
onSubmit
(event: FormEvent<HTMLButtonElement>) => void
-
onSubmitCapture
(event: FormEvent<HTMLButtonElement>) => void
-
onInvalid
(event: FormEvent<HTMLButtonElement>) => void
-
onInvalidCapture
(event: FormEvent<HTMLButtonElement>) => void
-
onLoad
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onError
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onErrorCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onKeyDown
(event: KeyboardEvent<HTMLButtonElement>) => void
-
onKeyDownCapture
(event: KeyboardEvent<HTMLButtonElement>) => void
-
onKeyPress
(event: KeyboardEvent<HTMLButtonElement>) => void
-
onKeyPressCapture
(event: KeyboardEvent<HTMLButtonElement>) => void
-
onKeyUp
(event: KeyboardEvent<HTMLButtonElement>) => void
-
onKeyUpCapture
(event: KeyboardEvent<HTMLButtonElement>) => void
-
onAbort
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onAbortCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onCanPlay
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onCanPlayCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onCanPlayThrough
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onCanPlayThroughCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onDurationChange
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onDurationChangeCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onEmptied
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onEmptiedCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onEncrypted
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onEncryptedCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onEnded
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onEndedCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadedData
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadedDataCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadedMetadata
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadedMetadataCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadStart
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onLoadStartCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onPause
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onPauseCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onPlay
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onPlayCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onPlaying
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onPlayingCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onProgress
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onProgressCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onRateChange
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onRateChangeCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSeeked
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSeekedCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSeeking
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSeekingCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onStalled
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onStalledCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSuspend
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSuspendCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onTimeUpdate
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onTimeUpdateCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onVolumeChange
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onVolumeChangeCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onWaiting
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onWaitingCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onAuxClick
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onAuxClickCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onClick
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onClickCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onContextMenu
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onContextMenuCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onDoubleClick
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onDoubleClickCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onDrag
(event: DragEvent<HTMLButtonElement>) => void
-
onDragCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDragEnd
(event: DragEvent<HTMLButtonElement>) => void
-
onDragEndCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDragEnter
(event: DragEvent<HTMLButtonElement>) => void
-
onDragEnterCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDragExit
(event: DragEvent<HTMLButtonElement>) => void
-
onDragExitCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDragLeave
(event: DragEvent<HTMLButtonElement>) => void
-
onDragLeaveCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDragOver
(event: DragEvent<HTMLButtonElement>) => void
-
onDragOverCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDragStart
(event: DragEvent<HTMLButtonElement>) => void
-
onDragStartCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onDrop
(event: DragEvent<HTMLButtonElement>) => void
-
onDropCapture
(event: DragEvent<HTMLButtonElement>) => void
-
onMouseDown
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseDownCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseEnter
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseLeave
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseMove
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseMoveCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseOut
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseOutCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseOver
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseOverCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseUp
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onMouseUpCapture
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onSelect
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onSelectCapture
(event: SyntheticEvent<HTMLButtonElement, Event>) => void
-
onTouchCancel
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchCancelCapture
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchEnd
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchEndCapture
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchMove
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchMoveCapture
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchStart
(event: TouchEvent<HTMLButtonElement>) => void
-
onTouchStartCapture
(event: TouchEvent<HTMLButtonElement>) => void
-
onPointerDown
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerDownCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerMove
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerMoveCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerUp
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerUpCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerCancel
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerCancelCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerEnter
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerEnterCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerLeave
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerLeaveCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerOver
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerOverCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerOut
(event: PointerEvent<HTMLButtonElement>) => void
-
onPointerOutCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onGotPointerCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onGotPointerCaptureCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onLostPointerCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onLostPointerCaptureCapture
(event: PointerEvent<HTMLButtonElement>) => void
-
onScroll
(event: UIEvent<HTMLButtonElement, UIEvent>) => void
-
onScrollCapture
(event: UIEvent<HTMLButtonElement, UIEvent>) => void
-
onWheel
(event: WheelEvent<HTMLButtonElement>) => void
-
onWheelCapture
(event: WheelEvent<HTMLButtonElement>) => void
-
onAnimationStart
(event: AnimationEvent<HTMLButtonElement>) => void
-
onAnimationStartCapture
(event: AnimationEvent<HTMLButtonElement>) => void
-
onAnimationEnd
(event: AnimationEvent<HTMLButtonElement>) => void
-
onAnimationEndCapture
(event: AnimationEvent<HTMLButtonElement>) => void
-
onAnimationIteration
(event: AnimationEvent<HTMLButtonElement>) => void
-
onAnimationIterationCapture
(event: AnimationEvent<HTMLButtonElement>) => void
-
onTransitionEnd
(event: TransitionEvent<HTMLButtonElement>) => void
-
onTransitionEndCapture
(event: TransitionEvent<HTMLButtonElement>) => void
-
css
InterpolationWithTheme<any>
-
Stories
Install Button Custom Colors
Install Button With Icon
Install Button With Children
Install Button With Events
Install Button With Custom Element
Install App