@react-stately/select

What is @react-stately/select?

@react-stately/select is a library that provides state management for select components in React applications. It is part of the React Spectrum collection of libraries, which are designed to work together to build accessible, high-quality user interfaces.

What are @react-stately/select's main functionalities?

Basic Select State Management

This feature allows you to manage the state of a select component, including the list of items and the currently selected item.

import { useSelectState } from '@react-stately/select';

const state = useSelectState({
  items: [
    { key: 'red', name: 'Red' },
    { key: 'green', name: 'Green' },
    { key: 'blue', name: 'Blue' }
  ],
  selectedKey: 'red'
});

console.log(state.selectedKey); // 'red'

Handling Selection Changes

This feature allows you to handle changes in the selection state, providing a callback function that is called whenever the selected item changes.

import { useSelectState } from '@react-stately/select';

const state = useSelectState({
  items: [
    { key: 'red', name: 'Red' },
    { key: 'green', name: 'Green' },
    { key: 'blue', name: 'Blue' }
  ],
  selectedKey: 'red',
  onSelectionChange: (key) => console.log('Selected:', key)
});

state.setSelectedKey('green'); // Logs: 'Selected: green'

Multiple Selection

This feature allows you to manage multiple selections within a select component, including handling changes to the set of selected items.

import { useSelectState } from '@react-stately/select';

const state = useSelectState({
  items: [
    { key: 'red', name: 'Red' },
    { key: 'green', name: 'Green' },
    { key: 'blue', name: 'Blue' }
  ],
  selectedKeys: new Set(['red']),
  selectionMode: 'multiple',
  onSelectionChange: (keys) => console.log('Selected keys:', keys)
});

state.setSelectedKeys(new Set(['green', 'blue'])); // Logs: 'Selected keys: Set { 'green', 'blue' }'

Other packages similar to @react-stately/select

react-select

react-select is a flexible and customizable library for building select components in React. It provides a wide range of features, including async loading, custom styling, and multi-select capabilities. Compared to @react-stately/select, react-select offers more out-of-the-box customization options and a larger community of users.

downshift

downshift is a library for building flexible, accessible, and customizable dropdown components in React. It provides hooks for managing state and behavior, allowing developers to create highly customized select components. Compared to @react-stately/select, downshift offers more control over the rendering and behavior of the dropdown, but requires more manual setup.

react-dropdown

react-dropdown is a simple and lightweight library for creating dropdown menus in React. It provides basic functionality for single and multi-select dropdowns with minimal configuration. Compared to @react-stately/select, react-dropdown is easier to set up but offers fewer features and customization options.

README

@react-stately/select

This package is part of react-spectrum. See the repo for more details.