VStack

RSC

VStack is a layout component for arranging elements vertically.

Installation

API Reference

Important Note

This is the documentation for gluestack-ui v2 (beta). For @gluestack-ui/themed (stable) documentation, refer to gluestack-ui v1.

This is an illustration of VStack component.

space

reversed

<Box className="justify-center h-80">
  <VStack space="md" reversed={false}>
    <Box className="h-20 w-20 bg-primary-300" />
    <Box className="h-20 w-20 bg-primary-400" />
    <Box className="h-20 w-20 bg-primary-500" />
  </VStack>
</Box>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add vstack

Step 1: Copy and paste the following code into index.tsx in your project.

import React from "react"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"
import { View } from "react-native"

import { vstackStyle } from "./styles"

type IVStackProps = React.ComponentProps<typeof View> &
  VariantProps<typeof vstackStyle>

const VStack = React.forwardRef(
  ({ className, space, reversed, ...props }: IVStackProps, ref?: any) => {
    return (
      <View
        className={vstackStyle({ space, reversed, class: className })}
        {...props}
        ref={ref}
      />
    )
  }
)

VStack.displayName = "VStack"

export { VStack }

Important Note

Note: Step 2 is optional and only required if you want to add support for React Server Components, You can skip this and jump to Step 3 directly if you don't have this requirement.

Step 2(optional): Copy and paste the following code into index.web.tsx in your project.

import React from "react"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"

import { vstackStyle } from "./styles"

type IVStackProps = React.ComponentProps<"div"> &
  VariantProps<typeof vstackStyle>

const VStack = React.forwardRef(
  ({ className, space, reversed, ...props }: IVStackProps, ref?: any) => {
    return (
      <div
        className={vstackStyle({ space, reversed, class: className })}
        {...props}
        ref={ref}
      />
    )
  }
)

VStack.displayName = "VStack"

export { VStack }

Step 3: Copy and paste the following code into styles.tsx in your project.

import { isWeb } from "@gluestack-ui/nativewind-utils/IsWeb"
import { tva } from "@gluestack-ui/nativewind-utils/tva"

const baseStyle = isWeb
  ? "flex flex-col relative z-0 box-border border-0 list-none min-w-0 min-h-0 bg-transparent items-stretch m-0 p-0 text-decoration-none"
  : ""

export const vstackStyle = tva({
  base: `flex-col ${baseStyle}`,
  variants: {
    space: {
      xs: "gap-1",
      sm: "gap-2",
      md: "gap-3",
      lg: "gap-4",
      xl: "gap-5",
      "2xl": "gap-6",
      "3xl": "gap-7",
      "4xl": "gap-8",
    },
    reversed: {
      true: "flex-col-reverse",
    },
  },
})

Step 4: Update the import paths to match your project setup.

API Reference

To use this component in your project, include the following import statement in your file.

import { VStack } from "@/components/ui/vstack"

export default () => <VStack />

Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

VStack

It inherits all the properties of React Native's View component.

Accessibility

The accessibility of a VStack is primarily determined by the accessibility information of the components it contains. When you pass an accessible component inside a VStack, its accessibility attributes, such as labels and hints, will be utilized by assistive technologies like screen readers.

In essence, the VStack acts as a container that inherits and propagates the accessibility attributes of its child views.

Props

VStack component is created using View component from react-native. It extends all the props supported by React Native View, utility props and the props mentioned below.

VStack

Prop	Type	Default	Description
space	string	-	It sets the space between children. By default there is no space between the VStack items.
reversed	boolean	false	When true, it places the VStack items in reverse direction.

Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

VStack Reversed

A VStack component with the reversed prop reverses the order of vertically stacked elements, enabling customized vertical layouts and visual arrangements of content within a user interface.

<VStack space="md">
  <Box className="w-20 h-20 bg-primary-300" />
  <Box className="w-20 h-20 bg-primary-400" />
  <Box className="w-20 h-20 bg-primary-500" />
</VStack>