BoxShadowValue Object Type

Important: The Vega SDK supports many of the React Native version 0.83 components and APIs. You can use the supported components and APIs in the same manner as an ordinary React Native app. This page lists a specific React Native feature supported by the Vega SDK and contains React Native V0.83 documentation from the reactnative.dev website created by Meta and other contributors and licensed under the Attribution 4.0 International License. For more information about React Native V0.83, see the React Native documentation, version 0.83. For the most current feature information, see the Release Notes.

Note: This feature is not available on Vega.

The BoxShadowValue object is taken by the boxShadow style prop. It is comprised of 2-4 lengths, an optional color, and an optional inset boolean. These values collectively define the box shadow's color, position, size, and blurriness.

Example

{
  offsetX: 10,
  offsetY: -3,
  blurRadius: '15px',
  spreadDistance: '10px',
  color: 'red',
  inset: true,
}

Keys and values

`offsetX`

The offset on the x-axis. This can be positive or negative. A positive value indicates right and negative indicates left.

Type	Optional
number \| string	No

`offsetY`

The offset on the y-axis. This can be positive or negative. A positive value indicates up and negative indicates down.

Type	Optional
number \| string	No

`blurRadius`

Represents the radius used in the Gaussian blur algorithm. The larger the value the blurrier the shadow is. Only non-negative values are valid. The default is 0.

Type	Optional
number \| string	Yes

`spreadDistance`

How much larger or smaller the shadow grows or shrinks. A positive value will grow the shadow, a negative value will shrink the shadow.

Type	Optional
number \| string	Yes

`color`

The color of the shadow. The default is black.

Type	Optional
color	Yes

`inset`

Whether the shadow is inset or not. Inset shadows will appear around the inside of the element's border box as opposed to the outside.

Type	Optional
boolean	Yes

Used by

boxShadow

Last updated: Jul 07, 2026