Fab

A dynamic button that stays visible, offering convenient access to a primary action.

Installation

API Reference

This is an illustration of Fab component.

size

placement

isHovered

isDisabled

isPressed

<Box className="h-[360px] w-80 bg-background-50 rounded-md">
  <Fab
    size="md"
    placement="bottom right"
    isHovered={false}
    isDisabled={false}
    isPressed={false}
  >
    <FabIcon as={AddIcon} />
    <FabLabel>Quick start</FabLabel>
  </Fab>
</Box>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add fab

Step 1: Install the following dependencies:

npm i @gluestack-ui/fab

Step 2: Copy and paste the following code into your project.

"use client"
import React from "react"
import { createFab } from "@gluestack-ui/fab"
import { Pressable, Text } from "react-native"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { cssInterop } from "nativewind"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"
import { PrimitiveIcon, UIIcon } from "@gluestack-ui/icon"

const SCOPE = "FAB"
const Root = withStyleContext(Pressable, SCOPE)
const UIFab = createFab({
  Root: Root,
  Label: Text,
  Icon: UIIcon,
})

cssInterop(PrimitiveIcon, {
  className: {
    target: "style",
    nativeStyleToProp: {
      height: true,
      width: true,
      fill: true,
      color: "classNameColor",
      stroke: true,
    },
  },
})

const fabStyle = tva({
  base: "group/fab bg-primary-500 rounded-full z-20 p-4 flex-row items-center justify-center absolute hover:bg-primary-600 active:bg-primary-700 disabled:opacity-40 disabled:pointer-events-all disabled:cursor-not-allowed data-[focus=true]:web:outline-none data-[focus-visible=true]:web:ring-2 data-[focus-visible=true]:web:ring-indicator-info shadow-hard-2",
  variants: {
    size: {
      sm: "px-2.5 py-2.5",
      md: "px-3 py-3",
      lg: "px-4 py-4",
    },
    placement: {
      "top right": "top-4 right-4",
      "top left": "top-4 left-4",
      "bottom right": "bottom-4 right-4",
      "bottom left": "bottom-4 left-4",
      "top center": "top-4 self-center",
      "bottom center": "bottom-4 self-center",
    },
  },
})

const fabLabelStyle = tva({
  base: "text-typography-50 font-normal font-body tracking-md text-left mx-2",
  variants: {
    isTruncated: {
      true: "",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    size: {
      "2xs": "text-2xs",
      xs: "text-xs",
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
      xl: "text-xl",
      "2xl": "text-2xl",
      "3xl": "text-3xl",
      "4xl": "text-4xl",
      "5xl": "text-5xl",
      "6xl": "text-6xl",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
  parentVariants: {
    size: {
      sm: "text-sm",
      md: "text-base",
      lg: "text-lg",
    },
  },
})

const fabIconStyle = tva({
  base: "text-typography-50 fill-none",
  variants: {
    size: {
      "2xs": "h-3 w-3",
      xs: "h-3.5 w-3.5",
      sm: "h-4 w-4",
      md: "w-[18px] h-[18px]",
      lg: "h-5 w-5",
      xl: "h-6 w-6",
    },
  },
})

type IFabProps = Omit<React.ComponentPropsWithoutRef<typeof UIFab>, "context"> &
  VariantProps<typeof fabStyle>

const Fab = React.forwardRef<React.ElementRef<typeof UIFab>, IFabProps>(
  ({ size = "md", placement = "bottom right", className, ...props }, ref) => {
    return (
      <UIFab
        ref={ref}
        {...props}
        className={fabStyle({ size, placement, class: className })}
        context={{ size }}
      />
    )
  }
)

type IFabLabelProps = React.ComponentPropsWithoutRef<typeof UIFab.Label> &
  VariantProps<typeof fabLabelStyle>

const FabLabel = React.forwardRef<
  React.ElementRef<typeof UIFab.Label>,
  IFabLabelProps
>(
  (
    {
      size,
      isTruncated = false,
      bold = false,
      underline = false,
      strikeThrough = false,
      className,
      ...props
    },
    ref
  ) => {
    const { size: parentSize } = useStyleContext(SCOPE)
    return (
      <UIFab.Label
        ref={ref}
        {...props}
        className={fabLabelStyle({
          parentVariants: {
            size: parentSize,
          },
          size,
          isTruncated,
          bold,
          underline,
          strikeThrough,
          class: className,
        })}
      />
    )
  }
)

type IFabIconProps = React.ComponentPropsWithoutRef<typeof UIFab.Icon> &
  VariantProps<typeof fabIconStyle> & {
    height?: number
    width?: number
  }

const FabIcon = React.forwardRef<
  React.ElementRef<typeof UIFab.Icon>,
  IFabIconProps
>(({ size, className, ...props }, ref) => {
  const { size: parentSize } = useStyleContext(SCOPE)

  if (typeof size === "number") {
    return (
      <UIFab.Icon
        ref={ref}
        {...props}
        className={fabIconStyle({ class: className })}
        size={size}
      />
    )
  } else if (
    (props.height !== undefined || props.width !== undefined) &&
    size === undefined
  ) {
    return (
      <UIFab.Icon
        ref={ref}
        {...props}
        className={fabIconStyle({ class: className })}
      />
    )
  }
  return (
    <UIFab.Icon
      ref={ref}
      {...props}
      className={fabIconStyle({
        parentVariants: {
          size: parentSize,
        },
        size,
        class: className,
      })}
    />
  )
})

Fab.displayName = "Fab"
FabLabel.displayName = "FabLabel"
FabIcon.displayName = "FabIcon"

export { Fab, FabLabel, FabIcon }

Step 3: 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 { Fab, FabLabel, FabIcon } from "@/components/ui/fab"

export default () => (
  <Fab>
    <FabLabel />
    <FabIcon />
  </Fab>
)

Fab

Contains all fab related layout style props and actions. It inherits all the properties of React Native's Pressable component.

Prop	Type	Default	Description
placement	"top left" \| "top right" \| "bottom left" \| "bottom right" \| "top center" \| "bottom center"	"bottom right"	Placement of the Fab
isHovered	bool	false	To manually set hover to the fab.
isPressed	bool	false	To manually set pressable state to the fab.
isFocused	bool	false	To manually set focused state to the fab.
isDisabled	bool	false	To manually set disable to the fab.

FabLabel

Contains all text related layout style props and actions. It inherits all the properties of React Native's Text component.

FabIcon

Contains all Icon related layout style props and actions. It inherits all the properties of gluestack Style's AsForwarder component.

Features

Keyboard support for actions.
Support for hover, focus and active states.
Option to add your styles or use the default styles.

Accessibility

We have outlined the various features that ensure the Fab component is accessible to all users, including those with disabilities. These features help ensure that your application is inclusive and meets accessibility standards.Adheres to the WAI-ARIA design pattern

Keyboard

Tab: Moves focus to the next focusable element.
Shift + Tab: Moves focus to the previous focusable element.
Enter: Triggers the fab's action.

VoiceOver: When the fab is focused, the screen reader will announce the fab's label and its current state.

Focus Management

The onFocus and onBlur props manage focus states and provide visual cues to users. This is especially important for users who rely on keyboard navigation.

Dependencies

The following are the lists of all the libraries and packages the component relies on. This information will help you ensure that your project has all the necessary dependencies installed to use the component.

@gluestack-ui/utils
@react-native-aria/focus
@react-native-aria/interactions

Props

Fab component is created using Pressable component from react-native. It extends all the props supported by React Native Pressable.

Data Attributes Table

Component receives states as props as boolean values, which are applied as data-* attributes. These attributes are then used to style the component via classNames, enabling state-based styling.

State	Data Attribute	Values
focus	data-focus	true \| false
focusVisible	data-focus-visible	true \| false

Fab

Name	Value	Default
size	sm \| md \| lg	md
placement	top right \| top left \| bottom right \| bottom left \| top center \| bottom center	bottom right

Important Note

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.

FAB with Icon

A Fab component with an icon adds a visually striking and easily recognizable button that triggers a specific action or function within a user interface.

function App() {
  const data = [
    {
      uri: "https://images.unsplash.com/photo-1599566150163-29194dcaad36?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=774&q=80",
      name: "Kevin James",
      msg: "Hi Rachel, What's up",
    },
    {
      uri: "https://images.unsplash.com/photo-1527980965255-d3b416303d12?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1180&q=80",
      name: "Jacob Jones",
      msg: "Good Morning!",
    },
    {
      uri: "https://images.unsplash.com/photo-1633332755192-727a05c4013d?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1180&q=80",
      name: "Albert Flores",
      msg: "Coffee?",
    },
  ]
  return (
    <Box className="border rounded-lg border-outline-200 p-6 bg-background-100 min-w-[240px] sm:min-w-[360px] md:min-w-[476px]">
      <VStack space="md">
        {data.map((chatData, index) => {
          return (
            <HStack space="sm" className="items-center" key={index}>
              <Avatar size="sm">
                <AvatarImage
                  source={{
                    uri: chatData.uri,
                  }}
                  alt="image"
                />
              </Avatar>
              <VStack>
                <Heading size="xs">{chatData.name}</Heading>
                <Text size="xs">{chatData.msg}</Text>
              </VStack>
            </HStack>
          )
        })}
      </VStack>
      <Fab
        size="lg"
        className="bg-primary-600 hover:bg-primary-700 active:bg-primary-800"
      >
        {/* EditIcon is imported from 'lucide-react-native' */}
        <FabIcon as={EditIcon} color="white" />
      </Fab>
    </Box>
  )
}

FAB with Icon and Text

A Fab component with an icon and text combines a visual icon with accompanying text to create a prominent and descriptive button that triggers a specific action or function within a user interface.

<Box className="max-w-96 border rounded-lg border-outline-200 py-[56px] px-6 mx-5 bg-background-100">
  <Fab className="top-4 h-10 bg-primary-600 hover:bg-primary-700 active:bg-primary-900 py-2">
    <FabIcon as={SearchIcon} />
    <FabLabel>Search</FabLabel>
  </Fab>
  <VStack space="lg">
    <Box>
      <Text className="text-xs text-primary-600 font-bold">HEALTH</Text>
      <Heading size="sm">Benefits of Oranges</Heading>
      <Text size="xs" className="mt-1.5">
        Oranges are a great source of vitamin C, which is essential for a
        healthy immune system.
      </Text>
      <HStack space="sm" className="mt-3 h-5">
        <Text size="xs">Wade Warrem</Text>
        <Divider orientation="vertical" className="bg-background-300" />
        <Text size="xs">6th Oct, 2019</Text>
        <Divider orientation="vertical" className="bg-background-300" />
        <Text size="xs">5 mins read</Text>
      </HStack>
    </Box>
    <Divider />
    <Box>
      <Text className="text-xs text-primary-600 font-bold">TECHNOLOGY</Text>
      <Heading size="sm">How AI can benefit your business</Heading>
      <Text size="xs" className="mt-1.5">
        AI can automate tasks and processes, allowing for increasing efficiency
        and productivity.
      </Text>
      <HStack space="sm" className="mt-3 h-5">
        <Text size="xs">Wade Warrem</Text>
        <Divider orientation="vertical" className="bg-background-300" />
        <Text size="xs">6th Oct, 2019</Text>
        <Divider orientation="vertical" className="bg-background-300" />
        <Text size="xs">5 mins read</Text>
      </HStack>
    </Box>
  </VStack>
</Box>

Placement

A Fab component with placement options allows for flexible positioning of the button within a user interface, enabling convenient and intuitive access to key actions or functionalities in various locations.

<Box className="border rounded-lg border-outline-300 py-4 bg-background-0 mx-5">
  <VStack space="lg" className="mb-2 px-6 py-2">
    <Checkbox size="sm">
      <CheckboxIndicator>
        <CheckboxIcon as={CheckIcon} />
      </CheckboxIndicator>
      <CheckboxLabel>
        <Text fontSize="$sm">Prepare any feedback or updates.</Text>
      </CheckboxLabel>
    </Checkbox>
    <Checkbox size="sm">
      <CheckboxIndicator>
        <CheckboxIcon as={CheckIcon} />
      </CheckboxIndicator>
      <CheckboxLabel>
        <Text fontSize="$sm">Review progress on goals and projects.</Text>
      </CheckboxLabel>
    </Checkbox>
    <Checkbox size="sm">
      <CheckboxIndicator>
        <CheckboxIcon as={CheckIcon} />
      </CheckboxIndicator>
      <CheckboxLabel>
        <Text fontSize="$sm">Ask challenges and discuss.</Text>
      </CheckboxLabel>
    </Checkbox>
  </VStack>
  <Fab size="sm" placement="bottom center" className="top-0 relative">
    <FabIcon as={AddIcon} size="sm" />
  </Fab>
</Box>

Custom Placement

A Fab component with custom placement allows for flexible positioning of the button according to specific design requirements or user interface preferences, providing tailored and intuitive access to key actions or functionalities.

<Box className="max-w-96 border rounded-lg border-outline-200 overflow-hidden mx-5  bg-background-100">
  <Box>
    <Image
      className="h-[185px] w-[416px]"
      source={{
        uri: "https://images.unsplash.com/photo-1591206369811-4eeb2f03bc95?w=800&auto=format&fit=crop&q=60&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8NDJ8fG9yYW5nZXxlbnwwfHwwfHx8MA%3D%3D",
      }}
      fallbackSource={{
        uri: "https://drive.google.com/uc?export=view&id=1h1e89BtQCp6JdGiKo92dlf5bjHC8hLjt",
      }}
      alt="image"
    />
  </Box>
  <VStack className="px-6 pt-4 pb-6">
    <Heading size="sm">Fresh Orange - Imported (Loose)</Heading>
    <Text className="my-1.5 text-sm">Rs 146(Rs.24.33/pc)</Text>
    <Text className="text-xs">DETAILS</Text>
    <Text className="my-1.5 text-xs">
      Oranges are a great source of vitamin C, which is essential for a healthy
      immune system. Oranges are a great source of vitamin C, which is important
      for maintaining a healthy immune system. Vitamin C also helps with the
      absorption of iron and the production of collagen, which supports healthy
      skin, teeth, and bones.
    </Text>
    <Link href="https://gluestack.io/" isExternal>
      <Text className="text-xs text-primary-600">READ MORE</Text>
    </Link>
  </VStack>
  <Fab
    size="lg"
    className="bg-primary-600 right-4 bottom-16 hover:bg-primary-700 active:bg-primary-800"
  >
    {/* ShoppingCartIcon is imported from 'lucide-react-native' */}
    <FabIcon as={ShoppingCartIcon} className="h-4 w-4" />
  </Fab>
</Box>

Fab

Installation

Run the following command:

Step 1: Install the following dependencies:

Step 2: Copy and paste the following code into your project.

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

API Reference

Fab

FabLabel

FabIcon

Features

Accessibility

Keyboard

Screen Reader

Focus Management

Dependencies

Props

Data Attributes Table

Fab

Examples

FAB with Icon

FAB with Icon and Text

Placement

Custom Placement