Skip to content
Components
@app-studio/components

Background

A comprehensive collection of background effects, including animated particles, gradients, images, and videos.

View component source

Import

ts
import { Background } from '@app-studio/components';

New to the library? Complete installation and provider setup first.

Interactive examples

Try the component, then open Code to copy the complete example.

INTERACTIVE EXAMPLE

Loading preview…

Props

Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.

Scroll horizontally to see every column.

Background
PropTypeDefaultDescription
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—Content rendered inside the component.Source
views{ container?: ViewProps; content?: ViewProps; }—Style overrides for the named internal parts.Source
shape"square" | "rounded" | "pill"
"square""rounded""pill"
—Shape preset for the component.Source
decorationRotationnumber—See the type and source declaration for this property.Source
decorationScalenumber—See the type and source declaration for this property.Source
decorationOpacitynumber—See the type and source declaration for this property.Source
Common inherited styling props (7)

Scroll horizontally to see every column.

Background inherited
PropTypeDefaultDescription
mediaRecord<string, CssProps>—See the type and source declaration for this property.
onClickany—Called when the user activates the component.
askeyof JSX.IntrinsicElements
"symbol""object""slot""style""title""pattern""form""animate""clipPath""filter""marker""mask""a""abbr""address""area""article""aside""audio""b""base""bdi""bdo""big""blockquote""body""br""button""canvas""caption""center""cite""code""col""colgroup""data""datalist""dd""del""details""dfn""dialog""div""dl""dt""em""embed""fieldset""figcaption""figure""footer""h1""h2""h3""h4""h5""h6""head""header""hgroup""hr""html""i""iframe""img""input""ins""kbd""keygen""label""legend""li""link""main""map""mark""menu""menuitem""meta""meter""nav""noindex""noscript""ol""optgroup""option""output""p""param""picture""pre""progress""q""rp""rt""ruby""s""samp""search""script""section""select""small""source""span""strong""sub""summary""sup""table""template""tbody""td""textarea""tfoot""th""thead""time""tr""track""u""ul""var""video""wbr""webview""svg""animateMotion""animateTransform""circle""defs""desc""ellipse""feBlend""feColorMatrix""feComponentTransfer""feComposite""feConvolveMatrix""feDiffuseLighting""feDisplacementMap""feDistantLight""feDropShadow""feFlood""feFuncA""feFuncB""feFuncG""feFuncR""feGaussianBlur""feImage""feMerge""feMergeNode""feMorphology""feOffset""fePointLight""feSpecularLighting""feSpotLight""feTile""feTurbulence""foreignObject""g""image""line""linearGradient""metadata""mpath""path""polygon""polyline""radialGradient""rect""set""stop""switch""text""textPath""tspan""use""view"
—See the type and source declaration for this property.
themeMode"light" | "dark"
"light""dark"
—See the type and source declaration for this property.
_hoverstring | CssProps—See the type and source declaration for this property.
_activestring | CssProps—See the type and source declaration for this property.
_focusstring | CssProps—See the type and source declaration for this property.

Background.Layout

Scroll horizontally to see every column.

Background.Layout
PropTypeDefaultDescription
shape"square" | "rounded" | "pill"—Shape preset for the component.Source
views{ container?: ViewProps; content?: ViewProps; back?: ViewProps; front?: ViewProps; }—Style overrides for the named internal parts.Source
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—Content rendered inside the component.Source
decorationRotationnumber—See the type and source declaration for this property.Source
decorationScalenumber—See the type and source declaration for this property.Source
decorationOpacitynumber—See the type and source declaration for this property.Source

Background.Aurora

Scroll horizontally to see every column.

Background.Aurora
PropTypeDefaultDescription
showRadialGradientboolean—See the type and source declaration for this property.Source
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—Content rendered inside the component.Source
views{ container?: ViewProps; content?: ViewProps; }—Style overrides for the named internal parts.Source
shape"square" | "rounded" | "pill"—Shape preset for the component.Source
decorationRotationnumber—See the type and source declaration for this property.Source
decorationScalenumber—See the type and source declaration for this property.Source
decorationOpacitynumber—See the type and source declaration for this property.Source

Background.Meteors

Scroll horizontally to see every column.

Background.Meteors
PropTypeDefaultDescription
numbernumber—See the type and source declaration for this property.Source
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—Content rendered inside the component.Source

Background.Wall

Scroll horizontally to see every column.

Background.Wall
PropTypeDefaultDescription
rowsnumber—See the type and source declaration for this property.Source
colsnumber—See the type and source declaration for this property.Source
squareSizenumber—See the type and source declaration for this property.Source

Background.Particles

Scroll horizontally to see every column.

Background.Particles
PropTypeDefaultDescription
countnumber—See the type and source declaration for this property.Source
colorsstring[]—See the type and source declaration for this property.Source
speed"slow" | "medium" | "fast"—See the type and source declaration for this property.Source
shapes("circle" | "square" | "triangle")[]—See the type and source declaration for this property.Source

Background.Grid

Scroll horizontally to see every column.

Background.Grid
PropTypeDefaultDescription
gridSizenumber—See the type and source declaration for this property.Source
lineColorstring—See the type and source declaration for this property.Source
pulseColorstring—See the type and source declaration for this property.Source
animationSpeed"slow" | "medium" | "fast"—See the type and source declaration for this property.Source

Background.Ripples

Scroll horizontally to see every column.

Background.Ripples
PropTypeDefaultDescription
rippleCountnumber—See the type and source declaration for this property.Source
colorsstring[]—See the type and source declaration for this property.Source
maxSizenumber—See the type and source declaration for this property.Source
frequencynumber—See the type and source declaration for this property.Source

Background.Image

Scroll horizontally to see every column.

Background.Image
PropTypeDefaultDescription
src Requiredstring—Source URL of the media.Source
backgroundSizestring—This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015. **Syntax**: `<bg-size>#` **Initial value**: `auto auto` | Chrome | Firefox | Safari | Edge | IE | | :-----: | :-----: | :-----: | :----: | :---: | | **3** | **4** | **5** | **12** | **9** | | 1 _-x-_ | | 3 _-x-_ | | |Source
backgroundPositionstring—This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015. **Syntax**: `<bg-position>#` **Initial value**: `0% 0%` | Chrome | Firefox | Safari | Edge | IE | | :----: | :-----: | :----: | :----: | :---: | | **1** | **1** | **1** | **12** | **4** |Source
backgroundRepeatBackgroundRepeat—This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015. **Syntax**: `<repeat-style>#` **Initial value**: `repeat` | Chrome | Firefox | Safari | Edge | IE | | :----: | :-----: | :----: | :----: | :---: | | **1** | **1** | **1** | **12** | **4** |Source
backgroundAttachment"scroll" | "fixed" | "local"—This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015. **Syntax**: `<attachment>#` **Initial value**: `scroll` | Chrome | Firefox | Safari | Edge | IE | | :----: | :-----: | :----: | :----: | :---: | | **1** | **1** | **1** | **12** | **4** |Source
imageOpacitynumber—See the type and source declaration for this property.Source
blendModeBlendMode—See the type and source declaration for this property.Source
overlay
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—See the type and source declaration for this property.Source
views{ container?: ViewProps; content?: ViewProps; image?: ViewProps; }—Style overrides for the named internal parts.Source
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—Content rendered inside the component.Source
shape"square" | "rounded" | "pill"—Shape preset for the component.Source
decorationRotationnumber—See the type and source declaration for this property.Source
decorationScalenumber—See the type and source declaration for this property.Source
decorationOpacitynumber—See the type and source declaration for this property.Source

Background.Video

Scroll horizontally to see every column.

Background.Video
PropTypeDefaultDescription
src Requiredstring—Source URL of the media.Source
autoPlayboolean—See the type and source declaration for this property.Source
loopboolean—See the type and source declaration for this property.Source
mutedboolean—See the type and source declaration for this property.Source
playsInlineboolean—See the type and source declaration for this property.Source
overlay
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—See the type and source declaration for this property.Source
blendModeBlendMode—See the type and source declaration for this property.Source
views{ container?: ViewProps; content?: ViewProps; video?: ViewProps; }—Style overrides for the named internal parts.Source
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null
—Content rendered inside the component.Source
shape"square" | "rounded" | "pill"—Shape preset for the component.Source
decorationRotationnumber—See the type and source declaration for this property.Source
decorationScalenumber—See the type and source declaration for this property.Source
decorationOpacitynumber—See the type and source declaration for this property.Source

Background.Gradient

Scroll horizontally to see every column.

Background.Gradient
PropTypeDefaultDescription
typeGradientType—See the type and source declaration for this property.Source
directionstring—See the type and source declaration for this property.Source
shapeRadialShape—Shape preset for the component.Source
positionstring—Position of the element or notification.Source
fromstring—See the type and source declaration for this property.Source
tostring—Destination URL or application route.Source
colorsColorStop[]—See the type and source declaration for this property.Source
animateboolean—See the type and source declaration for this property.Source
animationDurationnumber—See the type and source declaration for this property.Source
children
View typestring | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactNode> | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | Promise<string | number | bigint | boolean | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactPortal | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactElement<unknown, string | import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").JSXElementConstructor<any>> | Iterable<import("/Volumes/workspace/open-source/app-studio-components/node_modules/@types/react/index").ReactNode> | null | undefined> | null
—Content rendered inside the component.Source
viewsGradientStyles—Style overrides for the named internal parts.Source

Background.Overlay

Scroll horizontally to see every column.

Background.Overlay
PropTypeDefaultDescription
contentPosition"bottom" | "left" | "right" | "top" | "center"—See the type and source declaration for this property.Source

For shared layout, color, and responsive properties, read Styling & composition and Responsive layouts. Additional native element attributes depend on the target platform.

Usage guidance

  • Give controls a visible label or an accessible name, and verify keyboard interaction. See Accessibility.
  • For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
  • These previews run in the browser. Check React Native setup for platform requirements and differences.
Browse documentation source