HStack

RSC

HStack is a layout component for arranging elements horizontally.

Installation

API Reference

This is an illustration of HStack component.

space

reversed

<HStack 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" />
</HStack>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add hstack

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 type { ViewProps } from "react-native"
import { hstackStyle } from "./styles"

type IHStackProps = ViewProps & VariantProps<typeof hstackStyle>

const HStack = React.forwardRef<React.ElementRef<typeof View>, IHStackProps>(
  ({ className, space, reversed, ...props }, ref) => {
    return (
      <View
        className={hstackStyle({ space, reversed, class: className })}
        {...props}
        ref={ref}
      />
    )
  }
)

HStack.displayName = "HStack"

export { HStack }

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 { hstackStyle } from "./styles"

type IHStackProps = React.ComponentPropsWithoutRef<"div"> &
  VariantProps<typeof hstackStyle>

const HStack = React.forwardRef<React.ElementRef<"div">, IHStackProps>(
  ({ className, space, reversed, ...props }, ref) => {
    return (
      <div
        className={hstackStyle({ space, reversed, class: className })}
        {...props}
        ref={ref}
      />
    )
  }
)

HStack.displayName = "HStack"

export { HStack }

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 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 hstackStyle = tva({
  base: `flex-row ${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-row-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 { HStack } from "@/components/ui/hstack"

export default () => <HStack />

Component Props

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

HStack

Renders a <div /> on web and a View on native.

Platform	Output
Web	<div />
Native	<View />

Accessibility

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

Props

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

Prop	Type	Default	Description
space	string	-	It sets the space between children. By default there is no space between the HStack items.
reversed	boolean	false	When true, it places the HStack 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.

HStack Reversed

An HStack component with the reversed prop reverses the order of horizontally stacked elements, allowing for customized layouts and visual arrangements of content within a user interface.

<HStack space="md" reversed>
  <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" />
</HStack>