Divider

Revamp your content organization with the Divider component! Use it to visually separate different sections of a list or group for a more structured and easy-to-read interface.

API Reference

Themed

Unstyled

Spec Doc

This is an illustration of a Themed Divider component with default configuration.

<Center>
  <Text>Easy</Text>
  <Divider my="$0.5" />
  <Text>Difficult</Text>
</Center>

API Reference

Import

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

import { Divider } from "@gluestack-ui/themed"

Anatomy

The structure provided below can help you identify and understand a divider component's various parts.

export default () => <Divider />

Component Props

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

Divider

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

Themed

The themed version of the component is a pre-styled version of the component, which allows you to quickly integrate the component into your project. The component's design and functionality are fully defined, allowing you to focus on the more important aspects of your project. To know more about Themed Library please visit this link.

Props

Divider 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.

Divider

Name	Value	Default
orientation	vertical \| horizontal	horizontal

Note: These props are exclusively applicable when utilizing the default configuration of gluestack-ui/config. If you are using a custom theme, these props may not be available.

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.

Variants

A Divider component with different layouts offers versatile options for visually dividing content in various arrangements, such as horizontal or vertical orientations, enabling flexible and visually appealing designs for organizing and structuring elements within a user interface.

<VStack space="md" justifyContent="center" alignItems="center">
  <HStack h="$10" justifyContent="center" alignItems="center">
    <Text>Simple</Text>
    <Divider
      orientation="vertical"
      mx="$2.5"
      bg="$emerald500"
      h={15}
      sx={{
        _dark: {
          bg: "$emerald400",
        },
      }}
    />
    <Text>Easy</Text>
    <Divider
      orientation="vertical"
      mx="$2.5"
      bg="$indigo500"
      h={15}
      sx={{
        _dark: {
          bg: "$indigo400",
        },
      }}
    />
    <Text>Beautiful</Text>
  </HStack>
  <VStack w={100} justifyContent="center" alignItems="center">
    <Text>Firefox</Text>
    <Divider
      w={55}
      variant="horizontal"
      sx={{
        bg: "$red500",
        _dark: {
          bg: "$red400",
        },
      }}
    />
    <Text>Chrome</Text>
  </VStack>
</VStack>

Orientation

A Divider component with a specified divider orientation allows for clear visual separation of content, either horizontally or vertically, providing a structured and organized layout within a user interface.

<VStack
  space="lg"
  p="$12"
  borderColor="$backgroundLight300"
  borderWidth="$1"
  rounded="$lg"
  mx="$5"
  sx={{
    _dark: {
      borderColor: "$backgroundDark700",
    },
  }}
>
  <Box>
    <Text size="xs" color="$darkBlue600" fontWeight="$bold">
      HEALTH
    </Text>
    <Heading>Benefits of Oranges</Heading>
    <Text size="sm" mt="$1.5">
      Oranges are a great source of vitamin C, which is essential for a healthy
      immune system.
    </Text>
    <HStack space="sm" mt="$3" h="$5">
      <Text size="xs">Wade Warrem</Text>
      <Divider orientation="vertical" bg="$trueGray300" />
      <Text size="xs">6th Oct, 2019</Text>
      <Divider orientation="vertical" bg="$trueGray300" />
      <Text size="xs">5 mins read</Text>
    </HStack>
  </Box>
  <Divider
    sx={{
      bg: "$trueGray300",
      _dark: {
        bg: "$backgroundDark700",
      },
    }}
  />
  <Box>
    <Text size="xs" color="$darkBlue600" fontWeight="$bold">
      TECHNOLOGY
    </Text>
    <Heading>How AI can benefit your business</Heading>
    <Text size="sm" mt="$1.5">
      AI can automate tasks and processes, allowing for increasing efficiency
      and productivity.
    </Text>
    <HStack space="sm" mt="$3" h="$5">
      <Text size="xs">Wade Warrem</Text>
      <Divider orientation="vertical" bg="$trueGray300" />
      <Text size="xs">6th Oct, 2019</Text>
      <Divider orientation="vertical" bg="$trueGray300" />
      <Text size="xs">5 mins read</Text>
    </HStack>
  </Box>
</VStack>

With & Without Inset

A Divider component used with or without inset adds visual hierarchy and distinction by creating a dividing line either with or without indentation, providing options for organizing and structuring content within a user interface.

<VStack space="2xl">
  <HStack
    px="$3"
    h="$8"
    rounded="$sm"
    borderWidth="$1"
    borderColor="$backgroundLight300"
    sx={{
      _dark: {
        borderColor: "$backgroundDark700",
      },
    }}
  >
    <Button variant="link" size="xs">
      <ButtonText>Github</ButtonText>
    </Button>
    <Divider orientation="vertical" mx="$2.5" />
    <Button variant="link" size="xs">
      <ButtonText>Twitter</ButtonText>
    </Button>
    <Divider orientation="vertical" mx="$2.5" />
    <Button variant="link" size="xs">
      <ButtonText>Discord</ButtonText>
    </Button>
  </HStack>
  <HStack
    px="$3"
    h="$8"
    rounded="$sm"
    borderWidth="$1"
    borderColor="$backgroundLight300"
    alignItems="center"
    sx={{
      _dark: {
        borderColor: "$backgroundDark700",
      },
    }}
  >
    <Button variant="link" size="xs">
      <ButtonText>Github</ButtonText>
    </Button>
    <Divider orientation="vertical" h="50%" mx="$2.5" />
    <Button variant="link" size="xs">
      <ButtonText>Twitter</ButtonText>
    </Button>
    <Divider orientation="vertical" h="50%" mx="$2.5" />
    <Button variant="link" size="xs">
      <ButtonText>Discord</ButtonText>
    </Button>
  </HStack>
</VStack>

Adding content within a Divider

A Divider component with added content allows for the inclusion of additional text or elements alongside the dividing line, enhancing the visual and informational aspects of the divider while providing a seamless integration of content within a user interface.

<Box
  py="$9"
  px="$20"
  m="$5"
  rounded="$lg"
  borderColor="$backgroundLight300"
  borderWidth="$1"
  sx={{
    _dark: {
      borderColor: "$backgroundDark700",
    },
  }}
>
  <Heading size="3xl">Search Results</Heading>
  <Divider mt="$4" mb="$6" />
  <Box>
    <Text size="xs" color="$amber700" fontWeight="$bold">
      TECHNOLOGY
    </Text>
    <Heading>How AI can benefit your business</Heading>
    <Text size="sm" mt="$1.5">
      AI can automate tasks and processes, allowing for increasing efficiency
      and productivity.
    </Text>
    <HStack space="sm" mt="$3" alignItems="center">
      <Divider bg="$amber700" w={18} />
      <Text size="xs" color="$amber700">
        5 mins read
      </Text>
    </HStack>
  </Box>
</Box>

Unstyled

All the components in gluestack-ui are unstyled by default. To customize your UI using the extendedTheme, please refer to this link. The import names of components serve as keys to customize each component.

Spec Doc

Explore the comprehensive details of the Divider in this document, including its implementation details, checklist, and potential future additions. Dive into the thought process behind the component and gain insights into its development journey.

Edit this page on GitHub