Blanket

A blanket covers the underlying UI for a layered component, such as a modal dialog or a tooltip.

Examples Code Usage Changelog

Installation

Package installation information
Install	`yarn add @atlaskit/blanket`
Source	Bitbucket.org, (opens new window)
npm	@atlaskit/blanket, (opens new window)
Bundle	unpkg.com, (opens new window)

Props

`analyticsContext`
Description	Additional information to be included in the `context` of analytics events.
Type	`{ [x: string]: any; }`

`children`
Description	The children to be rendered within the blanket.
Type	`string \| number \| boolean \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal`

`isTinted`
Description	Sets whether the blanket has a tinted background color.
Type	`boolean`

`onBlanketClicked`
Description	Handler function to be called when the blanket is clicked.
Type	`(event: MouseEvent<HTMLDivElement, globalThis.MouseEvent>, analyticsEvent: UIAnalyticsEvent) => void`

`ref`
Description	No description.
Type	`((instance: HTMLDivElement) => void) \| RefObject<HTMLDivElement>`

`shouldAllowClickThrough`
Description	Whether mouse events can pass through the blanket. If `true`, `onBlanketClicked` will not be called.
Type	`boolean`

`testId`
Description	A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
Type	`string`

Was this page helpful?

We use this feedback to improve our documentation.