react-aria-components 1.16.0 → 1.17.0

package/src/SearchField.tsx

@@ -1,152 +0,0 @@
-/*
- * Copyright 2022 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {AriaSearchFieldProps, useSearchField} from 'react-aria';
-import {ButtonContext} from './Button';
-import {
-  ClassNameOrFunction,
-  ContextValue,
-  dom,
-  Provider,
-  RACValidation,
-  removeDataAttributes,
-  RenderProps,
-  SlotProps,
-  useContextProps,
-  useRenderProps,
-  useSlot,
-  useSlottedContext
-} from './utils';
-import {createHideableComponent} from '@react-aria/collections';
-import {FieldErrorContext} from './FieldError';
-import {FieldInputContext} from './RSPContexts';
-import {filterDOMProps} from '@react-aria/utils';
-import {FormContext} from './Form';
-import {GlobalDOMAttributes} from '@react-types/shared';
-import {GroupContext} from './Group';
-import {InputContext} from './Input';
-import {LabelContext} from './Label';
-import React, {createContext, ForwardedRef, useRef} from 'react';
-import {SearchFieldState, useSearchFieldState} from 'react-stately';
-import {TextContext} from './Text';
-
-export interface SearchFieldRenderProps {
-  /**
-   * Whether the search field is empty.
-   * @selector [data-empty]
-   */
-  isEmpty: boolean,
-  /**
-   * Whether the search field is disabled.
-   * @selector [data-disabled]
-   */
-  isDisabled: boolean,
-  /**
-   * Whether the search field is invalid.
-   * @selector [data-invalid]
-   */
-  isInvalid: boolean,
-  /**
-   * Whether the search field is read only.
-   * @selector [data-readonly]
-   */
-  isReadOnly: boolean,
-  /**
-   * Whether the search field is required.
-   * @selector [data-required]
-   */
-  isRequired: boolean,
-  /**
-   * State of the search field.
-   */
-  state: SearchFieldState
-}
-
-export interface SearchFieldProps extends Omit<AriaSearchFieldProps, 'label' | 'placeholder' | 'description' | 'errorMessage' | 'validationState' | 'validationBehavior'>, RACValidation, RenderProps<SearchFieldRenderProps>, SlotProps, GlobalDOMAttributes<HTMLDivElement> {
-  /**
-   * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
-   * @default 'react-aria-SearchField'
-   */
-  className?: ClassNameOrFunction<SearchFieldRenderProps>
-}
-
-export const SearchFieldContext = createContext<ContextValue<SearchFieldProps, HTMLDivElement>>(null);
-
-/**
- * A search field allows a user to enter and clear a search query.
- */
-export const SearchField = /*#__PURE__*/ createHideableComponent(function SearchField(props: SearchFieldProps, ref: ForwardedRef<HTMLDivElement>) {
-  [props, ref] = useContextProps(props, ref, SearchFieldContext);
-  let {validationBehavior: formValidationBehavior} = useSlottedContext(FormContext) || {};
-  let validationBehavior = props.validationBehavior ?? formValidationBehavior ?? 'native';
-  let inputRef = useRef<HTMLInputElement>(null);
-  [props, inputRef as unknown] = useContextProps(props, inputRef, FieldInputContext);
-  let [labelRef, label] = useSlot(
-    !props['aria-label'] && !props['aria-labelledby']
-  );
-  let state = useSearchFieldState({
-    ...props,
-    validationBehavior
-  });
-
-  let {labelProps, inputProps, clearButtonProps, descriptionProps, errorMessageProps, ...validation} = useSearchField({
-    ...removeDataAttributes(props),
-    label,
-    validationBehavior
-  }, state, inputRef);
-
-  let renderProps = useRenderProps({
-    ...props,
-    values: {
-      isEmpty: state.value === '',
-      isDisabled: props.isDisabled || false,
-      isInvalid: validation.isInvalid || false,
-      isReadOnly: props.isReadOnly || false,
-      isRequired: props.isRequired || false,
-      state
-    },
-    defaultClassName: 'react-aria-SearchField'
-  });
-
-  let DOMProps = filterDOMProps(props, {global: true});
-  delete DOMProps.id;
-
-  return (
-    <dom.div
-      {...DOMProps}
-      {...renderProps}
-      ref={ref}
-      slot={props.slot || undefined}
-      data-empty={state.value === '' || undefined}
-      data-disabled={props.isDisabled || undefined}
-      data-invalid={validation.isInvalid || undefined}
-      data-readonly={props.isReadOnly || undefined}
-      data-required={props.isRequired || undefined}>
-      <Provider
-        values={[
-          [LabelContext, {...labelProps, ref: labelRef}],
-          [InputContext, {...inputProps, ref: inputRef}],
-          [ButtonContext, clearButtonProps],
-          [TextContext, {
-            slots: {
-              description: descriptionProps,
-              errorMessage: errorMessageProps
-            }
-          }],
-          [GroupContext, {isInvalid: validation.isInvalid, isDisabled: props.isDisabled || false}],
-          [FieldErrorContext, validation]
-        ]}>
-        {renderProps.children}
-      </Provider>
-    </dom.div>
-  );
-});

package/src/Select.tsx

@@ -1,356 +0,0 @@
-/*
- * Copyright 2022 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {AriaSelectProps, HiddenSelect, useFocusRing, useListFormatter, useLocalizedStringFormatter, useSelect} from 'react-aria';
-import {ButtonContext} from './Button';
-import {
-  ClassNameOrFunction,
-  ContextValue,
-  dom,
-  Provider,
-  RACValidation,
-  removeDataAttributes,
-  RenderProps,
-  SlotProps,
-  useContextProps,
-  useRenderProps,
-  useSlot,
-  useSlottedContext
-} from './utils';
-import {Collection, Node, SelectState, useSelectState} from 'react-stately';
-import {CollectionBuilder, createHideableComponent} from '@react-aria/collections';
-import {FieldErrorContext} from './FieldError';
-import {filterDOMProps, mergeProps, useResizeObserver} from '@react-aria/utils';
-import {FormContext} from './Form';
-import {forwardRefType, GlobalDOMAttributes} from '@react-types/shared';
-// @ts-ignore
-import intlMessages from '../intl/*.json';
-import {ItemRenderProps} from './Collection';
-import {LabelContext} from './Label';
-import {ListBoxContext, ListStateContext} from './ListBox';
-import {OverlayTriggerStateContext} from './Dialog';
-import {PopoverContext} from './Popover';
-import React, {createContext, ForwardedRef, forwardRef, Fragment, HTMLAttributes, ReactNode, useCallback, useContext, useMemo, useRef, useState} from 'react';
-import {TextContext} from './Text';
-
-type SelectionMode = 'single' | 'multiple';
-
-export interface SelectRenderProps {
-  /**
-   * Whether the select is focused, either via a mouse or keyboard.
-   * @selector [data-focused]
-   */
-  isFocused: boolean,
-  /**
-   * Whether the select is keyboard focused.
-   * @selector [data-focus-visible]
-   */
-  isFocusVisible: boolean,
-  /**
-   * Whether the select is disabled.
-   * @selector [data-disabled]
-   */
-  isDisabled: boolean,
-  /**
-   * Whether the select is currently open.
-   * @selector [data-open]
-   */
-  isOpen: boolean,
-  /**
-   * Whether the select is invalid.
-   * @selector [data-invalid]
-   */
-  isInvalid: boolean,
-  /**
-   * Whether the select is required.
-   * @selector [data-required]
-   */
-  isRequired: boolean
-}
-
-export interface SelectProps<T extends object = {}, M extends SelectionMode = 'single'> extends Omit<AriaSelectProps<T, M>, 'children' | 'label' | 'description' | 'errorMessage' | 'validationState' | 'validationBehavior' | 'items'>, RACValidation, RenderProps<SelectRenderProps>, SlotProps, GlobalDOMAttributes<HTMLDivElement> {
-  /**
-   * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
-   * @default 'react-aria-Select'
-   */
-  className?: ClassNameOrFunction<SelectRenderProps>,
-  /**
-   * Temporary text that occupies the select when it is empty.
-   * @default 'Select an item' (localized)
-   */
-  placeholder?: string
-}
-
-export const SelectContext = createContext<ContextValue<SelectProps<any, SelectionMode>, HTMLDivElement>>(null);
-export const SelectStateContext = createContext<SelectState<unknown, SelectionMode> | null>(null);
-
-/**
- * A select displays a collapsible list of options and allows a user to select one of them.
- */
-export const Select = /*#__PURE__*/ (forwardRef as forwardRefType)(function Select<T extends object = {}, M extends SelectionMode = 'single'>(props: SelectProps<T, M>, ref: ForwardedRef<HTMLDivElement>) {
-  [props, ref] = useContextProps(props, ref, SelectContext);
-  let {children, isDisabled = false, isInvalid = false, isRequired = false} = props;
-  let content = useMemo(() => (
-    typeof children === 'function'
-      ? children({
-        isOpen: false,
-        isDisabled,
-        isInvalid,
-        isRequired,
-        isFocused: false,
-        isFocusVisible: false,
-        defaultChildren: null
-      })
-      : children
-  ), [children, isDisabled, isInvalid, isRequired]);
-
-  return (
-    <CollectionBuilder content={content}>
-      {collection => <SelectInner props={props} collection={collection} selectRef={ref} />}
-    </CollectionBuilder>
-  );
-});
-
-// Contexts to clear inside the popover.
-const CLEAR_CONTEXTS = [LabelContext, ButtonContext, TextContext];
-
-interface SelectInnerProps<T extends object> {
-  props: SelectProps<T, SelectionMode>,
-  selectRef: ForwardedRef<HTMLDivElement>,
-  collection: Collection<Node<T>>
-}
-
-function SelectInner<T extends object>({props, selectRef: ref, collection}: SelectInnerProps<T>) {
-  let {validationBehavior: formValidationBehavior} = useSlottedContext(FormContext) || {};
-  let validationBehavior = props.validationBehavior ?? formValidationBehavior ?? 'native';
-  let state = useSelectState({
-    ...props,
-    collection,
-    children: undefined,
-    validationBehavior
-  });
-
-  let {isFocusVisible, focusProps} = useFocusRing({within: true});
-
-  // Get props for child elements from useSelect
-  let buttonRef = useRef<HTMLButtonElement>(null);
-  let [labelRef, label] = useSlot(
-    !props['aria-label'] && !props['aria-labelledby']
-  );
-  let {
-    labelProps,
-    triggerProps,
-    valueProps,
-    menuProps,
-    descriptionProps,
-    errorMessageProps,
-    hiddenSelectProps,
-    ...validation
-  } = useSelect({
-    ...removeDataAttributes(props),
-    label,
-    validationBehavior
-  }, state, buttonRef);
-
-  // Make menu width match input + button
-  let [buttonWidth, setButtonWidth] = useState<string | null>(null);
-  let onResize = useCallback(() => {
-    if (buttonRef.current) {
-      setButtonWidth(buttonRef.current.offsetWidth + 'px');
-    }
-  }, [buttonRef]);
-
-  useResizeObserver({
-    ref: buttonRef,
-    onResize: onResize
-  });
-
-  // Only expose a subset of state to renderProps function to avoid infinite render loop
-  let renderPropsState = useMemo(() => ({
-    isOpen: state.isOpen,
-    isFocused: state.isFocused,
-    isFocusVisible,
-    isDisabled: props.isDisabled || false,
-    isInvalid: validation.isInvalid || false,
-    isRequired: props.isRequired || false
-  }), [state.isOpen, state.isFocused, isFocusVisible, props.isDisabled, validation.isInvalid, props.isRequired]);
-
-  let renderProps = useRenderProps({
-    ...props,
-    values: renderPropsState,
-    defaultClassName: 'react-aria-Select'
-  });
-
-  let DOMProps = filterDOMProps(props, {global: true});
-  delete DOMProps.id;
-
-  let scrollRef = useRef(null);
-
-  return (
-    <Provider
-      values={[
-        [SelectContext, props],
-        [SelectStateContext, state],
-        [SelectValueContext, valueProps],
-        [LabelContext, {...labelProps, ref: labelRef, elementType: 'span'}],
-        [ButtonContext, {...triggerProps, ref: buttonRef, isPressed: state.isOpen, autoFocus: props.autoFocus}],
-        [OverlayTriggerStateContext, state],
-        [PopoverContext, {
-          trigger: 'Select',
-          triggerRef: buttonRef,
-          scrollRef,
-          placement: 'bottom start',
-          style: {'--trigger-width': buttonWidth} as React.CSSProperties,
-          'aria-labelledby': menuProps['aria-labelledby'],
-          clearContexts: CLEAR_CONTEXTS
-        }],
-        [ListBoxContext, {...menuProps, ref: scrollRef}],
-        [ListStateContext, state],
-        [TextContext, {
-          slots: {
-            description: descriptionProps,
-            errorMessage: errorMessageProps
-          }
-        }],
-        [FieldErrorContext, validation]
-      ]}>
-      <dom.div
-        {...mergeProps(DOMProps, renderProps, focusProps)}
-        ref={ref}
-        slot={props.slot || undefined}
-        data-focused={state.isFocused || undefined}
-        data-focus-visible={isFocusVisible || undefined}
-        data-open={state.isOpen || undefined}
-        data-disabled={props.isDisabled || undefined}
-        data-invalid={validation.isInvalid || undefined}
-        data-required={props.isRequired || undefined}>
-        {renderProps.children}
-        <HiddenSelect
-          {...hiddenSelectProps}
-          autoComplete={props.autoComplete} />
-      </dom.div>
-    </Provider>
-  );
-}
-
-export interface SelectValueRenderProps<T> {
-  /**
-   * Whether the value is a placeholder.
-   * @selector [data-placeholder]
-   */
-  isPlaceholder: boolean,
-  /**
-   * The object value of the first selected item.
-   * @deprecated
-   */
-  selectedItem: T | null,
-  /** The object values of the currently selected items. */
-  selectedItems: (T | null)[],
-  /** The textValue of the currently selected items. */
-  selectedText: string,
-  /** The state of the select. */
-  state: SelectState<T, 'single' | 'multiple'>
-}
-
-export interface SelectValueProps<T extends object> extends Omit<HTMLAttributes<HTMLElement>, keyof RenderProps<unknown>>, RenderProps<SelectValueRenderProps<T>, 'span'> {
-  /**
-   * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
-   * @default 'react-aria-SelectValue'
-   */
-  className?: ClassNameOrFunction<SelectValueRenderProps<T>>
-}
-
-export const SelectValueContext = createContext<ContextValue<SelectValueProps<any>, HTMLSpanElement>>(null);
-
-/**
- * SelectValue renders the current value of a Select, or a placeholder if no value is selected.
- * It is usually placed within the button element.
- */
-export const SelectValue = /*#__PURE__*/ createHideableComponent(function SelectValue<T extends object>(props: SelectValueProps<T>, ref: ForwardedRef<HTMLSpanElement>) {
-  [props, ref] = useContextProps(props, ref, SelectValueContext);
-  let state = useContext(SelectStateContext)! as SelectState<T, 'single' | 'multiple'>;
-  let {placeholder} = useSlottedContext(SelectContext)!;
-  let rendered = state.selectedItems.map((item) => {
-    let rendered = item.props?.children;
-    // If the selected item has a function as a child, we need to call it to render to React.JSX.
-    if (typeof rendered === 'function') {
-      let fn = rendered as (s: ItemRenderProps) => ReactNode;
-      rendered = fn({
-        isHovered: false,
-        isPressed: false,
-        isSelected: false,
-        isFocused: false,
-        isFocusVisible: false,
-        isDisabled: false,
-        selectionMode: 'single',
-        selectionBehavior: 'toggle'
-      });
-    }
-
-    return rendered;
-  });
-
-  let formatter = useListFormatter();
-  let textValue = useMemo(() => state.selectedItems.map(item => item?.textValue), [state.selectedItems]);
-  let selectionMode = state.selectionManager.selectionMode;
-  let selectedText = useMemo(() => (
-    selectionMode === 'single' 
-      ? textValue[0] ?? '' 
-      : formatter.format(textValue)
-  ), [selectionMode, formatter, textValue]);
-
-  let defaultChildren = useMemo(() => {
-    if (selectionMode === 'single') {
-      return rendered[0];
-    }
-
-    let parts = formatter.formatToParts(textValue);
-    if (parts.length === 0) {
-      return null;
-    }
-
-    let index = 0;
-    return parts.map(part => {
-      if (part.type === 'element') {
-        return <Fragment key={index}>{rendered[index++]}</Fragment>;
-      } else {
-        return part.value;
-      }
-    });
-  }, [selectionMode, formatter, textValue, rendered]);
-
-  let stringFormatter = useLocalizedStringFormatter(intlMessages, 'react-aria-components');
-
-  let renderProps = useRenderProps({
-    ...props,
-    defaultChildren: defaultChildren ?? placeholder ?? stringFormatter.format('selectPlaceholder'),
-    defaultClassName: 'react-aria-SelectValue',
-    values: {
-      selectedItem: state.selectedItems[0]?.value as T ?? null,
-      selectedItems: useMemo(() => state.selectedItems.map(item => item.value as T ?? null), [state.selectedItems]),
-      selectedText,
-      isPlaceholder: state.selectedItems.length === 0,
-      state
-    }
-  });
-
-  let DOMProps = filterDOMProps(props, {global: true});
-
-  return (
-    <dom.span ref={ref} {...DOMProps} {...renderProps} data-placeholder={state.selectedItems.length === 0 || undefined}>
-      {/* clear description and error message slots */}
-      <TextContext.Provider value={undefined}>
-        {renderProps.children}
-      </TextContext.Provider>
-    </dom.span>
-  );
-});

package/src/SelectionIndicator.tsx

@@ -1,46 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {ClassNameOrFunction, ContextValue, useContextProps} from './utils';
-import React, {createContext, ForwardedRef, forwardRef} from 'react';
-import {SharedElement, SharedElementPropsBase, SharedElementRenderProps} from './SharedElementTransition';
-
-export interface SelectionIndicatorProps extends SharedElementPropsBase {
-  /**
-   * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
-   * @default 'react-aria-SelectionIndicator'
-   */
-  className?: ClassNameOrFunction<SharedElementRenderProps>,
-  /** Whether the SelectionIndicator is visible. This is usually set automatically by the parent component. */
-  isSelected?: boolean
-}
-
-export const SelectionIndicatorContext = createContext<ContextValue<SelectionIndicatorProps, HTMLDivElement>>({
-  isSelected: false
-});
-
-
-/**
- * An animated indicator of selection state within a group of items.
- */
-export const SelectionIndicator = forwardRef(function SelectionIndicator(props: SelectionIndicatorProps, ref: ForwardedRef<HTMLDivElement>) {
-  [props, ref] = useContextProps(props, ref, SelectionIndicatorContext);
-  let {isSelected, ...otherProps} = props;
-  return (
-    <SharedElement
-      {...otherProps}
-      ref={ref}
-      className={props.className || 'react-aria-SelectionIndicator'}
-      name="SelectionIndicator"
-      isVisible={isSelected} />
-  );
-});

package/src/Separator.tsx

@@ -1,76 +0,0 @@
-/*
- * Copyright 2022 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {SeparatorProps as AriaSeparatorProps, useSeparator} from 'react-aria';
-import {BaseCollection, CollectionNode, createLeafComponent} from '@react-aria/collections';
-import {ContextValue, dom, DOMRenderProps, SlotProps, StyleProps, useContextProps} from './utils';
-import {filterDOMProps, mergeProps} from '@react-aria/utils';
-import {GlobalDOMAttributes} from '@react-types/shared';
-import React, {createContext, ForwardedRef} from 'react';
-
-export interface SeparatorProps extends AriaSeparatorProps, StyleProps, SlotProps, DOMRenderProps<'hr' | 'div', undefined>, GlobalDOMAttributes<HTMLElement> {
-  /**
-   * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element.
-   * @default 'react-aria-Separator'
-   */
-  className?: string
-}
-
-export const SeparatorContext = createContext<ContextValue<SeparatorProps, HTMLElement>>({});
-
-export class SeparatorNode extends CollectionNode<any> {
-  static readonly type = 'separator';
-
-  filter(collection: BaseCollection<any>, newCollection: BaseCollection<any>): CollectionNode<any> | null {
-    let prevItem = newCollection.getItem(this.prevKey!);
-    if (prevItem && prevItem.type !== 'separator') {
-      let clone = this.clone();
-      newCollection.addDescendants(clone, collection);
-      return clone;
-    }
-
-    return null;
-  }
-}
-
-/**
- * A separator is a visual divider between two groups of content, e.g. groups of menu items or sections of a page.
- */
-export const Separator = /*#__PURE__*/ createLeafComponent(SeparatorNode, function Separator(props: SeparatorProps, ref: ForwardedRef<HTMLElement>) {
-  [props, ref] = useContextProps(props, ref, SeparatorContext);
-
-  let {elementType, orientation, style, className, slot, ...otherProps} = props;
-  let Element = elementType || 'hr';
-  if (Element === 'hr' && orientation === 'vertical') {
-    Element = 'div';
-  }
-
-  let ElementType = dom[Element];
-
-  let {separatorProps} = useSeparator({
-    ...otherProps,
-    elementType,
-    orientation
-  });
-
-  let DOMProps = filterDOMProps(props, {global: true});
-
-  return (
-    <ElementType
-      render={props.render}
-      {...mergeProps(DOMProps, separatorProps)}
-      style={style}
-      className={className ?? 'react-aria-Separator'}
-      ref={ref}
-      slot={slot || undefined} />
-  );
-});