Box

Version 10.3.0Github Storybook

The Box primitive is one of the pillars of our system. It can be any HTML element and can receive many of our token values as props. We use Box to build most of our other components.

Installation

yarn add @twilio-paste/box - or - yarn add @twilio-paste/core

Usage

import {Box} from '@twilio-paste/core/box';

const Component = () => (
  <Box
    as="article"
    backgroundColor="colorBackgroundBody"
    padding="space60"
    _hover={{
      backgroundColor: "colorBackgroundPrimary"
      padding: "space70"
    }}
  >
    Foo
  </Box>
);

Props

Box

__moz_focus_inner

Type: BoxBaseStyleProps

__webkit_calendar_picker_indicator_hover

Type: BoxBaseStyleProps

__webkit_datetime_edit

Type: BoxBaseStyleProps

__webkit_inner_spin_button

Type: BoxBaseStyleProps

__webkit_outer_spin_button

Type: BoxBaseStyleProps

_active

Type: BoxBaseStyleProps

_after

Type: BoxBaseStyleProps

_before

Type: BoxBaseStyleProps

_checked

Type: BoxBaseStyleProps

_checked_hover

Type: BoxBaseStyleProps

_disabled

Type: BoxBaseStyleProps

_disabled_focus

Type: BoxBaseStyleProps

_disabled_focus_after

Type: BoxBaseStyleProps

_even

Type: BoxBaseStyleProps

_expanded

Type: BoxBaseStyleProps

_first

Type: BoxBaseStyleProps

_focus

Type: BoxBaseStyleProps

_focus_hover

Type: BoxBaseStyleProps

_focus_placeholder

Type: BoxBaseStyleProps

_focus_selected_after

Type: BoxBaseStyleProps

_focus_selected_hover_after

Type: BoxBaseStyleProps

_focusVisible

Type: BoxBaseStyleProps

_focusWithin

Type: BoxBaseStyleProps

_grabbed

Type: BoxBaseStyleProps

_groupHover

Type: BoxBaseStyleProps

_hover

Type: BoxBaseStyleProps

_invalid

Type: BoxBaseStyleProps

_last

Type: BoxBaseStyleProps

_mixed

Type: BoxBaseStyleProps

_notFirst

Type: BoxBaseStyleProps

_notLast

Type: BoxBaseStyleProps

_odd

Type: BoxBaseStyleProps

_placeholder

Type: BoxBaseStyleProps

_pressed

Type: BoxBaseStyleProps

_pressed_active

Type: BoxBaseStyleProps

_pressed_disabled

Type: BoxBaseStyleProps

_pressed_focus

Type: BoxBaseStyleProps

_pressed_hover

Type: BoxBaseStyleProps

_readOnly

Type: BoxBaseStyleProps

_selected

Type: BoxBaseStyleProps

_selected_after

Type: BoxBaseStyleProps

_selected_focus

Type: BoxBaseStyleProps

_selected_focusVisible

Type: BoxBaseStyleProps

_selected_hover

Type: BoxBaseStyleProps

_selected_hover_after

Type: BoxBaseStyleProps

_visited

Type: BoxBaseStyleProps

accept

Same as HTML

Type: string

alt

Same as HTML

Type: string

as

Controls the HTML element that that will be rendered in the DOM.

Type: keyof IntrinsicElements

datetime

Same as HTML

Type: string

disabled

Same as HTML

Type: boolean

element

Used to set a custom element name for customization.

Type: string

href

Same as HTML

Type: string

label

Same as HTML

Type: string

multiple

Same as HTML

Type: boolean

rel

Same as HTML

Type: string

src

Same as HTML

Type: string

target

Same as HTML

Type: string

type

Same as HTML

Type: string

variant

Used to style custom variants via customization.

Type: string

Inherited props

Paste components will often extend native HTML elements and as a result will inherit or extend their available properties. Below is a list of the props this component has inherited and are also available to use.

about

Type: string

accessKey

Type: string

aria-activedescendant

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Type: 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.

Type: 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.

Type: "list" | "none" | "inline" | "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.

Type: Booleanish

aria-checked

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

Type: boolean | "true" | "false" | "mixed"

aria-colcount

Defines the total number of columns in a table, grid, or treegrid.

Type: 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.

Type: number

aria-colspan

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

Type: number

aria-controls

Identifies the element (or elements) whose contents or presence are controlled by the current element.

Type: string

aria-current

Indicates the element that represents the current item within a container or set of related elements.

Type: | boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date"

aria-describedby

Identifies the element (or elements) that describes the object.

Type: string

aria-details

Identifies the element that provides a detailed, extended description for the object.

Type: string

aria-disabled

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

Type: Booleanish

aria-dropeffect

Indicates what functions can be performed when a dragged object is released on the drop target.

Type: "link" | "none" | "copy" | "execute" | "move" | "popup"

aria-errormessage

Identifies the element that provides an error message for the object.

Type: string

aria-expanded

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Type: 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.

Type: string

aria-grabbed

Indicates an element's "grabbed" state in a drag-and-drop operation.

Type: Booleanish

aria-haspopup

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Type: | boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"

aria-hidden

Indicates whether the element is exposed to an accessibility API.

Type: Booleanish

aria-invalid

Indicates the entered value does not conform to the format expected by the application.

Type: boolean | "true" | "false" | "grammar" | "spelling"

aria-keyshortcuts

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Type: string

aria-label

Defines a string value that labels the current element.

Type: string

aria-labelledby

Identifies the element (or elements) that labels the current element.

Type: string

aria-level

Defines the hierarchical level of an element within a structure.

Type: 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.

Type: "off" | "assertive" | "polite"

aria-modal

Indicates whether an element is modal when displayed.

Type: Booleanish

aria-multiline

Indicates whether a text box accepts multiple lines of input or only a single line.

Type: Booleanish

aria-multiselectable

Indicates that the user may select more than one item from the current selectable descendants.

Type: Booleanish

aria-orientation

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Type: "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.

Type: 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.

Type: 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.

Type: number

aria-pressed

Indicates the current "pressed" state of toggle buttons.

Type: boolean | "true" | "false" | "mixed"

aria-readonly

Indicates that the element is not editable, but is otherwise operable.

Type: Booleanish

aria-relevant

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

Type: | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

aria-required

Indicates that user input is required on the element before a form may be submitted.

Type: Booleanish

aria-roledescription

Defines a human-readable, author-localized description for the role of an element.

Type: string

aria-rowcount

Defines the total number of rows in a table, grid, or treegrid.

Type: 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.

Type: number

aria-rowspan

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

Type: number

aria-selected

Indicates the current "selected" state of various widgets.

Type: 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.

Type: number

aria-sort

Indicates if items in a table or grid are sorted in ascending or descending order.

Type: "none" | "ascending" | "descending" | "other"

aria-valuemax

Defines the maximum allowed value for a range widget.

Type: number

aria-valuemin

Defines the minimum allowed value for a range widget.

Type: number

aria-valuenow

Defines the current value for a range widget.

Type: number

aria-valuetext

Defines the human readable text alternative of aria-valuenow for a range widget.

Type: string

autoCapitalize

Type: string

autoCorrect

Type: string

autoSave

Type: string

className

Type: string

color

Type: string

contentEditable

Type: Booleanish | "inherit"

contextMenu

Type: string

dangerouslySetInnerHTML

Type: { __html: string }

datatype

Type: string

defaultChecked

Type: boolean

defaultValue

Type: string | number | readonly string[]

dir

Type: string

draggable

Type: Booleanish

hidden

Type: boolean

id

Type: string

inlist

Type: any

inputMode

Hints at the type of data that might be entered by the user while editing the element or its contents

Type: | "text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal"

is

Specify that a standard HTML element should behave like a defined custom built-in element

Type: string

itemID

Type: string

itemProp

Type: string

itemRef

Type: string

itemScope

Type: boolean

itemType

Type: string

lang

Type: string

nonce

Type: string

onAbort

Type: ReactEventHandler<HTMLElement>

onAbortCapture

Type: ReactEventHandler<HTMLElement>

onAnimationEnd

Type: AnimationEventHandler<HTMLElement>

onAnimationEndCapture

Type: AnimationEventHandler<HTMLElement>

onAnimationIteration

Type: AnimationEventHandler<HTMLElement>

onAnimationIterationCapture

Type: AnimationEventHandler<HTMLElement>

onAnimationStart

Type: AnimationEventHandler<HTMLElement>

onAnimationStartCapture

Type: AnimationEventHandler<HTMLElement>

onAuxClick

Type: MouseEventHandler<HTMLElement>

onAuxClickCapture

Type: MouseEventHandler<HTMLElement>

onBeforeInput

Type: FormEventHandler<HTMLElement>

onBeforeInputCapture

Type: FormEventHandler<HTMLElement>

onBlur

Type: FocusEventHandler<HTMLElement>

onBlurCapture

Type: FocusEventHandler<HTMLElement>

onCanPlay

Type: ReactEventHandler<HTMLElement>

onCanPlayCapture

Type: ReactEventHandler<HTMLElement>

onCanPlayThrough

Type: ReactEventHandler<HTMLElement>

onCanPlayThroughCapture

Type: ReactEventHandler<HTMLElement>

onChange

Type: FormEventHandler<HTMLElement>

onChangeCapture

Type: FormEventHandler<HTMLElement>

onClick

Type: MouseEventHandler<HTMLElement>

onClickCapture

Type: MouseEventHandler<HTMLElement>

onCompositionEnd

Type: CompositionEventHandler<HTMLElement>

onCompositionEndCapture

Type: CompositionEventHandler<HTMLElement>

onCompositionStart

Type: CompositionEventHandler<HTMLElement>

onCompositionStartCapture

Type: CompositionEventHandler<HTMLElement>

onCompositionUpdate

Type: CompositionEventHandler<HTMLElement>

onCompositionUpdateCapture

Type: CompositionEventHandler<HTMLElement>

onContextMenu

Type: MouseEventHandler<HTMLElement>

onContextMenuCapture

Type: MouseEventHandler<HTMLElement>

onCopy

Type: ClipboardEventHandler<HTMLElement>

onCopyCapture

Type: ClipboardEventHandler<HTMLElement>

onCut

Type: ClipboardEventHandler<HTMLElement>

onCutCapture

Type: ClipboardEventHandler<HTMLElement>

onDoubleClick

Type: MouseEventHandler<HTMLElement>

onDoubleClickCapture

Type: MouseEventHandler<HTMLElement>

onDrag

Type: DragEventHandler<HTMLElement>

onDragCapture

Type: DragEventHandler<HTMLElement>

onDragEnd

Type: DragEventHandler<HTMLElement>

onDragEndCapture

Type: DragEventHandler<HTMLElement>

onDragEnter

Type: DragEventHandler<HTMLElement>

onDragEnterCapture

Type: DragEventHandler<HTMLElement>

onDragExit

Type: DragEventHandler<HTMLElement>

onDragExitCapture

Type: DragEventHandler<HTMLElement>

onDragLeave

Type: DragEventHandler<HTMLElement>

onDragLeaveCapture

Type: DragEventHandler<HTMLElement>

onDragOver

Type: DragEventHandler<HTMLElement>

onDragOverCapture

Type: DragEventHandler<HTMLElement>

onDragStart

Type: DragEventHandler<HTMLElement>

onDragStartCapture

Type: DragEventHandler<HTMLElement>

onDrop

Type: DragEventHandler<HTMLElement>

onDropCapture

Type: DragEventHandler<HTMLElement>

onDurationChange

Type: ReactEventHandler<HTMLElement>

onDurationChangeCapture

Type: ReactEventHandler<HTMLElement>

onEmptied

Type: ReactEventHandler<HTMLElement>

onEmptiedCapture

Type: ReactEventHandler<HTMLElement>

onEncrypted

Type: ReactEventHandler<HTMLElement>

onEncryptedCapture

Type: ReactEventHandler<HTMLElement>

onEnded

Type: ReactEventHandler<HTMLElement>

onEndedCapture

Type: ReactEventHandler<HTMLElement>

onError

Type: ReactEventHandler<HTMLElement>

onErrorCapture

Type: ReactEventHandler<HTMLElement>

onFocus

Type: FocusEventHandler<HTMLElement>

onFocusCapture

Type: FocusEventHandler<HTMLElement>

onGotPointerCapture

Type: PointerEventHandler<HTMLElement>

onGotPointerCaptureCapture

Type: PointerEventHandler<HTMLElement>

onInput

Type: FormEventHandler<HTMLElement>

onInputCapture

Type: FormEventHandler<HTMLElement>

onInvalid

Type: FormEventHandler<HTMLElement>

onInvalidCapture

Type: FormEventHandler<HTMLElement>

onKeyDown

Type: KeyboardEventHandler<HTMLElement>

onKeyDownCapture

Type: KeyboardEventHandler<HTMLElement>

onKeyPress

Type: KeyboardEventHandler<HTMLElement>

onKeyPressCapture

Type: KeyboardEventHandler<HTMLElement>

onKeyUp

Type: KeyboardEventHandler<HTMLElement>

onKeyUpCapture

Type: KeyboardEventHandler<HTMLElement>

onLoad

Type: ReactEventHandler<HTMLElement>

onLoadCapture

Type: ReactEventHandler<HTMLElement>

onLoadedData

Type: ReactEventHandler<HTMLElement>

onLoadedDataCapture

Type: ReactEventHandler<HTMLElement>

onLoadedMetadata

Type: ReactEventHandler<HTMLElement>

onLoadedMetadataCapture

Type: ReactEventHandler<HTMLElement>

onLoadStart

Type: ReactEventHandler<HTMLElement>

onLoadStartCapture

Type: ReactEventHandler<HTMLElement>

onLostPointerCapture

Type: PointerEventHandler<HTMLElement>

onLostPointerCaptureCapture

Type: PointerEventHandler<HTMLElement>

onMouseDown

Type: MouseEventHandler<HTMLElement>

onMouseDownCapture

Type: MouseEventHandler<HTMLElement>

onMouseEnter

Type: MouseEventHandler<HTMLElement>

onMouseLeave

Type: MouseEventHandler<HTMLElement>

onMouseMove

Type: MouseEventHandler<HTMLElement>

onMouseMoveCapture

Type: MouseEventHandler<HTMLElement>

onMouseOut

Type: MouseEventHandler<HTMLElement>

onMouseOutCapture

Type: MouseEventHandler<HTMLElement>

onMouseOver

Type: MouseEventHandler<HTMLElement>

onMouseOverCapture

Type: MouseEventHandler<HTMLElement>

onMouseUp

Type: MouseEventHandler<HTMLElement>

onMouseUpCapture

Type: MouseEventHandler<HTMLElement>

onPaste

Type: ClipboardEventHandler<HTMLElement>

onPasteCapture

Type: ClipboardEventHandler<HTMLElement>

onPause

Type: ReactEventHandler<HTMLElement>

onPauseCapture

Type: ReactEventHandler<HTMLElement>

onPlay

Type: ReactEventHandler<HTMLElement>

onPlayCapture

Type: ReactEventHandler<HTMLElement>

onPlaying

Type: ReactEventHandler<HTMLElement>

onPlayingCapture

Type: ReactEventHandler<HTMLElement>

onPointerCancel

Type: PointerEventHandler<HTMLElement>

onPointerCancelCapture

Type: PointerEventHandler<HTMLElement>

onPointerDown

Type: PointerEventHandler<HTMLElement>

onPointerDownCapture

Type: PointerEventHandler<HTMLElement>

onPointerEnter

Type: PointerEventHandler<HTMLElement>

onPointerEnterCapture

Type: PointerEventHandler<HTMLElement>

onPointerLeave

Type: PointerEventHandler<HTMLElement>

onPointerLeaveCapture

Type: PointerEventHandler<HTMLElement>

onPointerMove

Type: PointerEventHandler<HTMLElement>

onPointerMoveCapture

Type: PointerEventHandler<HTMLElement>

onPointerOut

Type: PointerEventHandler<HTMLElement>

onPointerOutCapture

Type: PointerEventHandler<HTMLElement>

onPointerOver

Type: PointerEventHandler<HTMLElement>

onPointerOverCapture

Type: PointerEventHandler<HTMLElement>

onPointerUp

Type: PointerEventHandler<HTMLElement>

onPointerUpCapture

Type: PointerEventHandler<HTMLElement>

onProgress

Type: ReactEventHandler<HTMLElement>

onProgressCapture

Type: ReactEventHandler<HTMLElement>

onRateChange

Type: ReactEventHandler<HTMLElement>

onRateChangeCapture

Type: ReactEventHandler<HTMLElement>

onReset

Type: FormEventHandler<HTMLElement>

onResetCapture

Type: FormEventHandler<HTMLElement>

onResize

Type: ReactEventHandler<HTMLElement>

onResizeCapture

Type: ReactEventHandler<HTMLElement>

onScroll

Type: UIEventHandler<HTMLElement>

onScrollCapture

Type: UIEventHandler<HTMLElement>

onSeeked

Type: ReactEventHandler<HTMLElement>

onSeekedCapture

Type: ReactEventHandler<HTMLElement>

onSeeking

Type: ReactEventHandler<HTMLElement>

onSeekingCapture

Type: ReactEventHandler<HTMLElement>

onSelect

Type: ReactEventHandler<HTMLElement>

onSelectCapture

Type: ReactEventHandler<HTMLElement>

onStalled

Type: ReactEventHandler<HTMLElement>

onStalledCapture

Type: ReactEventHandler<HTMLElement>

onSubmit

Type: FormEventHandler<HTMLElement>

onSubmitCapture

Type: FormEventHandler<HTMLElement>

onSuspend

Type: ReactEventHandler<HTMLElement>

onSuspendCapture

Type: ReactEventHandler<HTMLElement>

onTimeUpdate

Type: ReactEventHandler<HTMLElement>

onTimeUpdateCapture

Type: ReactEventHandler<HTMLElement>

onTouchCancel

Type: TouchEventHandler<HTMLElement>

onTouchCancelCapture

Type: TouchEventHandler<HTMLElement>

onTouchEnd

Type: TouchEventHandler<HTMLElement>

onTouchEndCapture

Type: TouchEventHandler<HTMLElement>

onTouchMove

Type: TouchEventHandler<HTMLElement>

onTouchMoveCapture

Type: TouchEventHandler<HTMLElement>

onTouchStart

Type: TouchEventHandler<HTMLElement>

onTouchStartCapture

Type: TouchEventHandler<HTMLElement>

onTransitionEnd

Type: TransitionEventHandler<HTMLElement>

onTransitionEndCapture

Type: TransitionEventHandler<HTMLElement>

onVolumeChange

Type: ReactEventHandler<HTMLElement>

onVolumeChangeCapture

Type: ReactEventHandler<HTMLElement>

onWaiting

Type: ReactEventHandler<HTMLElement>

onWaitingCapture

Type: ReactEventHandler<HTMLElement>

onWheel

Type: WheelEventHandler<HTMLElement>

onWheelCapture

Type: WheelEventHandler<HTMLElement>

placeholder

Type: string

prefix

Type: string

property

Type: string

radioGroup

Type: string

resource

Type: string

results

Type: number

role

Type: AriaRole

security

Type: string

slot

Type: string

spellCheck

Type: Booleanish

style

Type: CSSProperties

suppressContentEditableWarning

Type: boolean

suppressHydrationWarning

Type: boolean

tabIndex

Type: number

title

Type: string

translate

Type: "yes" | "no"

typeof

Type: string

unselectable

Type: "on" | "off"

vocab

Type: string