@ark-ui/react

Welcome to Ark UI

Ark UI is a headless, open-source UI library with over 30+ components designed for building reusable, scalable Design Systems. It supports a wide range of JavaScript frameworks, offering dedciated packages for each supported framework.

Supported Frameworks

Ark UI is available for the following JavaScript frameworks:

• React: @ark-ui/react
• Solid: @ark-ui/solid
• Vue: @ark-ui/vue

Available Components

• Accordion
• Avatar
• Carousel
• Checkbox
• Color Picker
• Combobox
• Date Picker
• Dialog
• Editable
• File Upload
• Hover Card
• Menu
• Number Input
• Pagination
• Pin Input
• Popover
• Progress
• Radio Group
• Range Slider
• Rating Group
• Segment Group
• Select
• Slider
• Splitter
• Switch
• Tabs
• Tags Input
• Toast
• Toggle Group
• Tooltip

Installation

To install @ark-ui/react, run the following command:

npm install @ark-ui/react

or with yarn:

yarn add @ark-ui/react

Usage

To use a component from @ark-ui/react, import it and include it in your application:

import { Slider, type SliderProps } from '@ark-ui/react'
import { useState } from 'react'

export const MySlider = (props: SliderProps) => {
  const [value, setValue] = useState([42])

  return (
    <Slider.Root
      min={0}
      max={100}
      value={value}
      onValueChange={(e) => setValue(e.value)}
      {...props}
    >
      <Slider.Label>Label</Slider.Label>
      <Slider.ValueText />
      <Slider.Control>
        <Slider.Track>
          <Slider.Range />
        </Slider.Track>
        <Slider.Thumb key={0} index={0} />
      </Slider.Control>
      <Slider.MarkerGroup>
        <Slider.Marker value={25}>25</Slider.Marker>
        <Slider.Marker value={50}>50</Slider.Marker>
        <Slider.Marker value={75}>75</Slider.Marker>
      </Slider.MarkerGroup>
    </Slider.Root>
  )
}

Documentation

For more detailed documentation and examples, please visit the official documentation.

Roadmap

You can request, vote for, and check upcoming features on our roadmap.

Contribution

We welcome contributions to Ark UI. Please read our contributing guidelines for more information on how to contribute.

License

This project is licensed under the terms of the MIT license.