RN Primitives

https://rnprimitives.com/
Admin
RN Primitives provides unstyled, accessible UI building blocks with a unified API across React...
Tokens:163,461
Snippets:817
Trust Score:6.5
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install @rn-primitives/context-menu

Source: https://rnprimitives.com/context-menu

Install the context-menu primitive via the command line.

```bash
npx expo install @rn-primitives/context-menu
```

--------------------------------

### Install @radix-ui/react-context-menu

Source: https://rnprimitives.com/context-menu

Install the Radix UI context-menu package for web support.

```bash
npx expo install @radix-ui/react-context-menu
```

--------------------------------

### Install @radix-ui/react-switch

Source: https://rnprimitives.com/switch

Install the Radix UI switch for web support.

```bash
npx expo install @radix-ui/react-switch
```

--------------------------------

### Install Toolbar with npx expo install

Source: https://rnprimitives.com/toolbar

Install the @rn-primitives/toolbar component via the command line using npx expo install.

```bash
npx expo install @rn-primitives/toolbar

```

--------------------------------

### Installation (NPM)

Source: https://rnprimitives.com/select

Install the Select component and its required portal primitive via the command line.

```APIDOC
## Installation

### NPM

Install the component via your command line.

```bash
npx expo install @rn-primitives/select
```

If you do not have the portal primitive in your project, you will need to add it as well.

```bash
npx expo install @rn-primitives/portal
```
```

--------------------------------

### Install @radix-ui/react-popover

Source: https://rnprimitives.com/popover

Install the @radix-ui/react-popover package for web support.

```bash
npx expo install @radix-ui/react-popover
```

--------------------------------

### Install Radix UI Tooltip for Universal Projects

Source: https://rnprimitives.com/tooltip

For universal projects, install @radix-ui/react-tooltip.

```bash
npx expo install @radix-ui/react-tooltip
```

--------------------------------

### Install @radix-ui/react-toggle via npx expo install

Source: https://rnprimitives.com/toggle

Run this command to install the @radix-ui/react-toggle package for web support.

```bash
npx expo install @radix-ui/react-toggle
```

--------------------------------

### Install @rn-primitives/accordion via npx expo install

Source: https://rnprimitives.com/accordion

Install the component via your command line using npx expo install.

```bash
npx expo install @rn-primitives/accordion
```

--------------------------------

### Install @radix-ui/react-accordion via npx expo install

Source: https://rnprimitives.com/accordion

Install the @radix-ui/react-accordion package for web support.

```bash
npx expo install @radix-ui/react-accordion
```

--------------------------------

### Install @rn-primitives/toggle via npx expo install

Source: https://rnprimitives.com/toggle

Run this command to install the @rn-primitives/toggle package.

```bash
npx expo install @rn-primitives/toggle
```

--------------------------------

### Install Popover with npx expo install

Source: https://rnprimitives.com/popover

Install the @rn-primitives/popover package using the command line.

```bash
npx expo install @rn-primitives/popover
```

--------------------------------

### Install @radix-ui/react-hover-card

Source: https://rnprimitives.com/hover-card

Install the Radix UI hover-card package for web.

```bash
npx expo install @radix-ui/react-hover-card
```

--------------------------------

### Install @radix-ui/react-select

Source: https://rnprimitives.com/select

Install the Radix UI select package for web support.

```bash
npx expo install @radix-ui/react-select

```

--------------------------------

### Install @rn-primitives/hover-card

Source: https://rnprimitives.com/hover-card

Install the hover-card component via the command line.

```bash
npx expo install @rn-primitives/hover-card
```

--------------------------------

### Install @radix-ui/react-dropdown-menu

Source: https://rnprimitives.com/dropdown-menu

Install the Radix UI dropdown menu package for web support.

```bash
npx expo install @radix-ui/react-dropdown-menu
```

--------------------------------

### Installation Command

Source: https://rnprimitives.com/accordion

Command to install the accordion component dependencies.

```bash
npx create-expo-app@latest
```

--------------------------------

### Install @rn-primitives/switch

Source: https://rnprimitives.com/switch

Install the universal switch component via npm.

```bash
npx expo install @rn-primitives/switch
```

--------------------------------

### Install @radix-ui/react-navigation-menu

Source: https://rnprimitives.com/navigation-menu

Installs the Radix UI navigation menu package for native-only usage.

```bash
npx expo install @radix-ui/react-navigation-menu
```

--------------------------------

### Install Radix Alert Dialog

Source: https://rnprimitives.com/alert-dialog

Install @radix-ui/react-alert-dialog for web support.

```bash
npx expo install @radix-ui/react-alert-dialog
```

--------------------------------

### Install @radix-ui/react-radio-group

Source: https://rnprimitives.com/radio-group

Install the @radix-ui/react-radio-group package for web support.

```bash
npx expo install @radix-ui/react-radio-group
```

--------------------------------

### Install @rn-primitives/slider

Source: https://rnprimitives.com/slider

Install the slider component via the command line.

```bash
npx expo install @rn-primitives/slider
```

--------------------------------

### Install Tooltip Primitive via npm

Source: https://rnprimitives.com/tooltip

Run this command to install the @rn-primitives/tooltip package.

```bash
npx expo install @rn-primitives/tooltip
```

--------------------------------

### Install @radix-ui/react-tabs for web

Source: https://rnprimitives.com/tabs

Install the Radix UI Tabs package required for web support.

```bash
npx expo install @radix-ui/react-tabs
```

--------------------------------

### Install @radix-ui/react-menubar

Source: https://rnprimitives.com/menubar

Install the Radix UI Menubar package for web support. Required for the web implementation.

```bash
npx expo install @radix-ui/react-menubar
```

--------------------------------

### Install @radix-ui/react-toolbar

Source: https://rnprimitives.com/toolbar

Install the @radix-ui/react-toolbar package, required for the web implementation of the Toolbar primitive.

```bash
npx expo install @radix-ui/react-toolbar

```

--------------------------------

### Install @radix-ui/react-slider

Source: https://rnprimitives.com/slider

Install the Radix UI slider package for web support.

```bash
npx expo install @radix-ui/react-slider
```

--------------------------------

### Install @rn-primitives/aspect-ratio

Source: https://rnprimitives.com/aspect-ratio

Install the @rn-primitives/aspect-ratio component via the command line using Expo.

```bash
npx expo install @rn-primitives/aspect-ratio
```

--------------------------------

### Install @rn-primitives/menubar

Source: https://rnprimitives.com/menubar

Install the Menubar component via npm using Expo. Required for the Menubar primitive.

```bash
npx expo install @rn-primitives/menubar
```

--------------------------------

### Installation (Manual - Web)

Source: https://rnprimitives.com/select

Install the Radix UI select dependency and copy the provided code for the web implementation.

```APIDOC
## Installation

### Manual - Web

Install @radix-ui/react-select

```bash
npx expo install @radix-ui/react-select
```

Copy/paste the following code for web to `~/components/primitives/select/select.web.tsx`

```tsx
import * as Select from '@radix-ui/react-select';
import {
  useComposedRefs,
  useControllableState,
  useEffectEvent,
  useIsomorphicLayoutEffect,
} from '~/components/primitives/hooks';
import { Slot } from '~/components/primitives/slot';
import * as React from 'react';
import { type GestureResponderEvent, Pressable, Text, View } from 'react-native';
import type {
  ContentProps,
  ContentRef,
  GroupProps,
  GroupRef,
  ItemIndicatorProps,
  ItemIndicatorRef,
  ItemProps,
  ItemRef,
  ItemTextProps,
  ItemTextRef,
  LabelProps,
  LabelRef,
  OverlayProps,
  OverlayRef,
  PortalProps,
  RootProps,
  RootRef,
  ScrollDownButtonProps,
  ScrollUpButtonProps,
  SeparatorProps,
  SeparatorRef,
  SharedRootContext,
  TriggerProps,
  TriggerRef,
  ValueProps,
  ValueRef,
  ViewportProps,
} from './types';


const SelectContext = React.createContext<
  | (SharedRootContext & {
    open: boolean;
    onOpenChange: (open: boolean) => void;
  })
  | null
>(null);
type RootComponentProps = RootProps & React.RefAttributes<RootRef>;


const Root = ({
  asChild,
  value: valueProp,
  defaultValue,
  onValueChange: onValueChangeProp,
  onOpenChange: onOpenChangeProp,
  ref,
  ...viewProps
}: RootComponentProps) => {
  const [value, onValueChange] = useControllableState({
    prop: valueProp,
    defaultProp: defaultValue,
    onChange: onValueChangeProp,
  });
  const [open, setOpen] = React.useState(false);


  function onOpenChange(value: boolean) {
    setOpen(value);
    onOpenChangeProp?.(value);
  }


  function onStrValueChange(val: string) {
    onValueChange({ value: val, label: val });
  }


  const Component = asChild ? Slot : View;
  return (
    <SelectContext.Provider
      value={{
        value,
        onValueChange,
        open,
        onOpenChange,
      }}
    >
      <Select.Root
        value={value?.value}
        defaultValue={defaultValue?.value}
        onValueChange={onStrValueChange}
        open={open}
        onOpenChange={onOpenChange}
      >
        <Component ref={ref} {...viewProps} />
      </Select.Root>
    </SelectContext.Provider>
  );
};


Root.displayName = 'RootWebSelect';


function useRootContext() {
  const context = React.useContext(SelectContext);
  if (!context) {
    throw new Error('Select compound components cannot be rendered outside the Select component');
  }
  return context;
}
type TriggerComponentProps = TriggerProps & React.RefAttributes<TriggerRef>;


const Trigger = ({
  asChild,
  role: _role,
  disabled,
  ref,
  onTouchStart: onTouchStartProp,
  ...props
}: TriggerComponentProps) => {
  const { open, onOpenChange } = useRootContext();
  const triggerRef = React.useRef<TriggerRef>(null);


  const openTriggerEvent = useEffectEvent(() => {
    onOpenChange(true);
  });
  const closeTriggerEvent = useEffectEvent(() => {
    onOpenChange(false);
  });


  const composedRef = useComposedRefs(
    triggerRef,
    ref,
    React.useCallback((node: TriggerRef | null) => {
      if (!node) return;
      node.open = () => openTriggerEvent();
      node.close = () => closeTriggerEvent();
    }, [])
  );


  useIsomorphicLayoutEffect(() => {
    if (triggerRef.current) {
      const augRef = triggerRef.current as unknown as HTMLButtonElement;
      augRef.dataset.state = open ? 'open' : 'closed';
      augRef.type = 'button';
    }
  }, [open]);


  function onTouchStart(ev: GestureResponderEvent) {
    onTouchStartProp?.(ev);
    if (!ev.defaultPrevented) {
      onOpenChange(true);
    }
  }


  const Component = asChild ? Slot : Pressable;
  return (
    <Select.Trigger disabled={disabled ?? undefined} asChild>
      <Component
        ref={composedRef}
        role='button'
        disabled={disabled}
        onTouchStart={onTouchStart}
        {...props}
      />
    </Select.Trigger>
  );
};


Trigger.displayName = 'TriggerWebSelect';
type ValueComponentProps = ValueProps & React.RefAttributes<ValueRef>;


const Value = ({ asChild, placeholder, children, ref, ...props }: ValueComponentProps) => {
  return (
    <Slot ref={ref} {...props}>
      <Select.Value placeholder={placeholder}>{children}</Select.Value>
    </Slot>
  );
};


Value.displayName = 'ValueWebSelect';
```
```

--------------------------------

### Basic Dialog Example

Source: https://rnprimitives.com/dialog

Shows a complete dialog with trigger, portal, overlay, content, title, description, and close button. Use this as a starting point for implementing a dialog in your app.

```tsx
import * as DialogPrimitive from '@rn-primitives/dialog';
import { Text } from 'react-native';


function Example() {
  return (
    <DialogPrimitive.Root>
      <DialogPrimitive.Trigger>
        <Text>Show Dialog</Text>
      </DialogPrimitive.Trigger>


      <DialogPrimitive.Portal>
        <DialogPrimitive.Overlay>
          <DialogPrimitive.Content>
              <DialogPrimitive.Title>Dialog Title</DialogPrimitive.Title>
              <DialogPrimitive.Description>
                Dialog description.
              </DialogPrimitive.Description>
              <DialogPrimitive.Close><Text>Close</Text></DialogPrimitive.Close>
          </DialogPrimitive.Content>
        </DialogPrimitive.Overlay>
      </DialogPrimitive.Portal>
    </DialogPrimitive.Root>
  );
}
```

--------------------------------

### Install @rn-primitives/types via npx expo install

Source: https://rnprimitives.com/types

Install the types package using the command line. This is the recommended installation method.

```bash
npx expo install @rn-primitives/types
```

--------------------------------

### Manual setup: index.ts (exporting)

Source: https://rnprimitives.com/label

Copy this code to ~/components/primitives/label/index.ts to export the label and types.

```ts
export * from './label';
export * from './types';

```

--------------------------------

### Install @rn-primitives/select and @rn-primitives/portal

Source: https://rnprimitives.com/select

Install the select and portal primitives via the command line. The portal primitive is required if not already present in the project.

```bash
npx expo install @rn-primitives/select

```

```bash
npx expo install @rn-primitives/portal

```

--------------------------------

### Install @rn-primitives/dropdown-menu and @rn-primitives/portal

Source: https://rnprimitives.com/dropdown-menu

Install the dropdown menu and portal primitives via the command line. The portal primitive is required if not already present in your project.

```bash
npx expo install @rn-primitives/dropdown-menu
```

```bash
npx expo install @rn-primitives/portal
```

--------------------------------

### Install Tabs via npx expo install

Source: https://rnprimitives.com/tabs

Install the @rn-primitives/tabs package using the Expo CLI.

```bash
npx expo install @rn-primitives/tabs
```

--------------------------------

### Install Alert Dialog via npm

Source: https://rnprimitives.com/alert-dialog

Install the @rn-primitives/alert-dialog package using npx expo install.

```bash
npx expo install @rn-primitives/alert-dialog
```

--------------------------------

### Install @rn-primitives/toast and @rn-primitives/portal

Source: https://rnprimitives.com/toast

Install the toast component and its required portal primitive. Run the portal command if you do not have the portal primitive in your project.

```bash
npx expo install @rn-primitives/toast
```

```bash
npx expo install @rn-primitives/portal
```

--------------------------------

### Install @rn-primitives/table with npx expo install

Source: https://rnprimitives.com/table

Install the @rn-primitives/table component via the command line using Expo.

```bash
npx expo install @rn-primitives/table
```

--------------------------------

### Install @radix-ui/react-progress via NPM

Source: https://rnprimitives.com/progress

Install the Radix UI progress package for web support. Run this command in your project directory.

```bash
npx expo install @radix-ui/react-progress

```

--------------------------------

### Install @rn-primitives/separator with npx expo install

Source: https://rnprimitives.com/separator

Install the @rn-primitives/separator component via the command line using Expo.

```bash
npx expo install @rn-primitives/separator
```

--------------------------------

### Menubar example with menus, submenus, and items

Source: https://rnprimitives.com/menubar

Complete example of a menubar using @rn-primitives/menubar. Includes state management for open menus, a submenu with animated content, checkbox items, separators, and disabled items. Demonstrates the component API with File, Edit, and View menus.

```tsx
import * as React from 'react';
import { StyleSheet, View, Text } from 'react-native';
import Animated, { FadeIn } from 'react-native-reanimated';
import * as MenubarPrimitive from '@rn-primitives/menubar';


function Example() {
  const [value, setValue] = React.useState<string | undefined>();
  const [isSubOpen, setIsSubOpen] = React.useState(false);
  const [isChecked, setIsChecked] = React.useState(false);
  const [radio, setRadio] = React.useState('michael');


  // TODO: handle closing menus when pressing/clicking outside of this Example component. Ex: when navigating to another screen


  function closeSubs() {
    setIsSubOpen(false);
  }


  function onValueChange(val: string | undefined) {
    if (typeof val === 'string') {
      setValue(val);
      return;
    }
    closeSubs();
    setValue(undefined);
  }


  return (
    <>
      {!!value && (
        <MenubarPrimitive.Overlay
          style={StyleSheet.absoluteFillObject}
        />
      )}
      <MenubarPrimitive.Root value={value} onValueChange={onValueChange}>
        <MenubarPrimitive.Menu value='file'>
          <MenubarPrimitive.Trigger onPress={closeSubs}>
            <Text>File</Text>
          </MenubarPrimitive.Trigger>
          <MenubarPrimitive.Portal>
            <MenubarPrimitive.Content>
              <MenubarPrimitive.Item>
                <Text>New Tab</Text>
              </MenubarPrimitive.Item>
              <MenubarPrimitive.Item>
                <Text>New Window</Text>
              </MenubarPrimitive.Item>
              <MenubarPrimitive.Item disabled>
                <Text>New Incognito Window</Text>
              </MenubarPrimitive.Item>
              <MenubarPrimitive.Separator />
              <MenubarPrimitive.Sub open={isSubOpen} onOpenChange={setIsSubOpen}>
                <MenubarPrimitive.SubTrigger>
                  <Text>Share</Text>
                </MenubarPrimitive.SubTrigger>
                <MenubarPrimitive.SubContent>
                  <Animated.View entering={FadeIn.duration(200)}>
                    <MenubarPrimitive.Item>
                      <Text>Email link</Text>
                    </MenubarPrimitive.Item>
                    <MenubarPrimitive.Item>
                      <Text>Messages</Text>
                    </MenubarPrimitive.Item>
                    <MenubarPrimitive.Item>
                      <Text>Notes</Text>
                    </MenubarPrimitive.Item>
                  </Animated.View>
                </MenubarPrimitive.SubContent>
              </MenubarPrimitive.Sub>
              <MenubarPrimitive.Separator />
              <MenubarPrimitive.Item>
                <Text>Print...</Text>
              </MenubarPrimitive.Item>
            </MenubarPrimitive.Content>
          </MenubarPrimitive.Portal>
        </MenubarPrimitive.Menu>
        <MenubarPrimitive.Menu value='edit'>
          <MenubarPrimitive.Trigger onPress={closeSubs}>
            <Text>Edit</Text>
          </MenubarPrimitive.Trigger>
          <MenubarPrimitive.Content className='native:w-48'>
            <MenubarPrimitive.Item>
              <Text>Undo</Text>
            </MenubarPrimitive.Item>
            <MenubarPrimitive.Item>
              <Text>Redo</Text>
            </MenubarPrimitive.Item>
            <MenubarPrimitive.Separator />
            <MenubarPrimitive.Item>
              <Text>Cut</Text>
            </MenubarPrimitive.Item>
            <MenubarPrimitive.Item>
              <Text>Copy</Text>
            </MenubarPrimitive.Item>
            <MenubarPrimitive.Item>
              <Text>Paste</Text>
            </MenubarPrimitive.Item>
          </MenubarPrimitive.Content>
        </MenubarPrimitive.Menu>
        <MenubarPrimitive.Menu value='view'>
          <MenubarPrimitive.Trigger onPress={closeSubs}>
            <Text>View</Text>
          </MenubarPrimitive.Trigger>
          <MenubarPrimitive.Portal>
            <MenubarPrimitive.Content>
              <MenubarPrimitive.CheckboxItem
                checked={isChecked}
                onCheckedChange={setIsChecked}
                closeOnPress={false}
              >
                <Text>Always Show Bookmarks Bar</Text>
              </MenubarPrimitive.CheckboxItem>
              <MenubarPrimitive.Item>
                <Text>Reload</Text>
              </MenubarPrimitive.Item>
              <MenubarPrimitive.Item disabled>
                <Text>Force Reload</Text>
              </MenubarPrimitive.Item>
              <MenubarPrimitive.Separator />
              <MenubarPrimitive.Item>
                <Text>Toggle Fullscreen</Text>
              </MenubarPrimitive.Item>
            </MenubarPrimitive.Content>
          </MenubarPrimitive.Portal>
        </MenubarPrimitive.Menu>
      </MenubarPrimitive.Root>
    </>
  );
}
```

--------------------------------

### Install @rn-primitives/avatar with npx expo install

Source: https://rnprimitives.com/avatar

Install the @rn-primitives/avatar component via the command line using Expo.

```bash
npx expo install @rn-primitives/avatar
```

--------------------------------

### Install @radix-ui/react-collapsible with npx expo

Source: https://rnprimitives.com/collapsible

Installs the @radix-ui/react-collapsible package via Expo CLI. This is required for the Native Only installation variant.

```bash
npx expo install @radix-ui/react-collapsible
```

--------------------------------

### Install @rn-primitives/slot with npx expo install

Source: https://rnprimitives.com/slot

Install the @rn-primitives/slot package via the command line using Expo's CLI.

```bash
npx expo install @rn-primitives/slot
```

--------------------------------

### Install @rn-primitives/collapsible with npx expo

Source: https://rnprimitives.com/collapsible

Installs the @rn-primitives/collapsible package via Expo CLI. This is the recommended installation method for the collapsible primitive.

```bash
npx expo install @rn-primitives/collapsible
```

--------------------------------

### Install Navigation Menu with npx expo install

Source: https://rnprimitives.com/navigation-menu

Installs the @rn-primitives/navigation-menu package via the command line. Required for using the Navigation Menu primitive.

```bash
npx expo install @rn-primitives/navigation-menu
```
Tokens:
Raw