HStack
RSC
HStack is a layout component for arranging elements horizontally.
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 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
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>