From 101d0772b9df85ad0972b9e8bda2a152affb42ca Mon Sep 17 00:00:00 2001
From: Daniel Lu <dl1644@gmail.com>
Date: Fri, 10 Jan 2025 11:49:32 -0800
Subject: [PATCH] chore: Update JSDocs and apis for release (#7595)

* Update JSDocs and apis for release

* typo
---
 packages/@react-spectrum/s2/src/CardView.tsx  |  1 +
 packages/@react-spectrum/s2/src/TableView.tsx |  1 +
 packages/@react-spectrum/s2/src/Tabs.tsx      | 44 +++++++++++--------
 .../@react-spectrum/s2/src/TabsPicker.tsx     | 17 ++++---
 .../@react-stately/selection/src/types.ts     |  1 +
 packages/react-aria-components/src/index.ts   |  1 +
 6 files changed, 41 insertions(+), 24 deletions(-)

diff --git a/packages/@react-spectrum/s2/src/CardView.tsx b/packages/@react-spectrum/s2/src/CardView.tsx
index 28745d3ae4f..8d275df67ec 100644
--- a/packages/@react-spectrum/s2/src/CardView.tsx
+++ b/packages/@react-spectrum/s2/src/CardView.tsx
@@ -62,6 +62,7 @@ export interface CardViewProps<T> extends Omit<GridListProps<T>, 'layout' | 'key
   onLoadMore?: () => void,
   /** Spectrum-defined styles, returned by the `style()` macro. */
   styles?: StylesPropWithHeight,
+  /** Provides the ActionBar to render when cards are selected in the CardView. */
   renderActionBar?: (selectedKeys: 'all' | Set<Key>) => ReactElement
 }
 
diff --git a/packages/@react-spectrum/s2/src/TableView.tsx b/packages/@react-spectrum/s2/src/TableView.tsx
index dd281833cc2..73663391b86 100644
--- a/packages/@react-spectrum/s2/src/TableView.tsx
+++ b/packages/@react-spectrum/s2/src/TableView.tsx
@@ -105,6 +105,7 @@ interface S2TableProps {
   loadingState?: LoadingState,
   /** Handler that is called when more items should be loaded, e.g. while scrolling near the bottom. */
   onLoadMore?: () => any,
+  /** Provides the ActionBar to display when rows are selected in the TableView. */
   renderActionBar?: (selectedKeys: 'all' | Set<Key>) => ReactElement
 }
 
diff --git a/packages/@react-spectrum/s2/src/Tabs.tsx b/packages/@react-spectrum/s2/src/Tabs.tsx
index 486ded1fdce..7791c902370 100644
--- a/packages/@react-spectrum/s2/src/Tabs.tsx
+++ b/packages/@react-spectrum/s2/src/Tabs.tsx
@@ -53,9 +53,11 @@ export interface TabsProps extends Omit<AriaTabsProps, 'className' | 'style' | '
    */
   density?: 'compact' | 'regular',
   /**
-   * If the tabs should only display icons and no text.
+   * Defines if the text within the tabs should be hidden and only the icon should be shown.
+   * The text is always visible when the item is collapsed into a picker.
+   * @default 'show'
    */
-  isIconOnly?: boolean
+  labelBehavior?: 'show' | 'hide'
 }
 
 export interface TabProps extends Omit<AriaTabProps, 'children' | 'style' | 'className'>, StyleProps {
@@ -96,7 +98,7 @@ export const Tabs = forwardRef(function Tabs(props: TabsProps, ref: DOMRef<HTMLD
     isDisabled,
     disabledKeys,
     orientation = 'horizontal',
-    isIconOnly = false
+    labelBehavior = 'show'
   } = props;
   let domRef = useDOMRef(ref);
   let [value, setValue] = useControlledState(props.selectedKey, props.defaultSelectedKey ?? null!, props.onSelectionChange);
@@ -112,7 +114,7 @@ export const Tabs = forwardRef(function Tabs(props: TabsProps, ref: DOMRef<HTMLD
           disabledKeys,
           selectedKey: value,
           onSelectionChange: setValue,
-          isIconOnly,
+          labelBehavior,
           onFocus: () => pickerRef.current?.focus(),
           pickerRef
         }]
@@ -141,10 +143,12 @@ const tablist = style({
           compact: 24,
           regular: 32
         },
-        isIconOnly: {
-          density: {
-            compact: 16,
-            regular: 24
+        labelBehavior: {
+          hide: {
+            density: {
+              compact: 16,
+              regular: 24
+            }
           }
         }
       }
@@ -170,7 +174,7 @@ const tablist = style({
 });
 
 export function TabList<T extends object>(props: TabListProps<T>) {
-  let {density, isDisabled, disabledKeys, orientation, isIconOnly, onFocus} = useContext(InternalTabsContext) ?? {};
+  let {density, isDisabled, disabledKeys, orientation, labelBehavior, onFocus} = useContext(InternalTabsContext) ?? {};
   let {showItems} = useContext(CollapseContext) ?? {};
   let state = useContext(TabListStateContext);
   let [selectedTab, setSelectedTab] = useState<HTMLElement | undefined>(undefined);
@@ -208,7 +212,7 @@ export function TabList<T extends object>(props: TabListProps<T>) {
       <RACTabList
         {...props}
         ref={tablistRef}
-        className={renderProps => tablist({...renderProps, isIconOnly, density})} />
+        className={renderProps => tablist({...renderProps, labelBehavior, density})} />
       {orientation === 'horizontal' &&
         <TabLine showItems={showItems} disabledKeys={disabledKeys} isDisabled={isDisabled} selectedTab={selectedTab} orientation={orientation} density={density} />}
     </div>
@@ -255,7 +259,7 @@ const selectedIndicator = style({
   transitionTimingFunction: 'in-out'
 });
 
-function TabLine(props: TabLineProps & {isIconOnly?: boolean}) {
+function TabLine(props: TabLineProps) {
   let {
     disabledKeys,
     isDisabled: isTabsDisabled,
@@ -342,7 +346,9 @@ const tab = style({
   flexShrink: 0,
   transition: 'default',
   paddingX: {
-    isIconOnly: size(6)
+    labelBehavior: {
+      hide: size(6)
+    }
   }
 }, getAllowedOverrides());
 
@@ -356,7 +362,7 @@ const icon = style({
 });
 
 export function Tab(props: TabProps) {
-  let {density, isIconOnly} = useContext(InternalTabsContext) ?? {};
+  let {density, labelBehavior} = useContext(InternalTabsContext) ?? {};
 
   return (
     <RACTab
@@ -364,7 +370,7 @@ export function Tab(props: TabProps) {
       // @ts-ignore
       originalProps={props}
       style={props.UNSAFE_style}
-      className={renderProps => (props.UNSAFE_className || '') + tab({...renderProps, density, isIconOnly}, props.styles)}>
+      className={renderProps => (props.UNSAFE_className || '') + tab({...renderProps, density, labelBehavior}, props.styles)}>
       {({
           // @ts-ignore
           isMenu
@@ -380,9 +386,11 @@ export function Tab(props: TabProps) {
                     style({
                       order: 1,
                       display: {
-                        isIconOnly: 'none'
+                        labelBehavior: {
+                          hide: 'none'
+                        }
                       }
-                    })({isIconOnly})
+                    })({labelBehavior})
                 }],
                 [IconContext, {
                   render: centerBaseline({slot: 'icon', styles: style({order: 0})}),
@@ -479,7 +487,7 @@ let HiddenTabs = function (props: {
 let TabsMenu = (props: {items: Array<Node<any>>, onSelectionChange: TabsProps['onSelectionChange']}) => {
   let stringFormatter = useLocalizedStringFormatter(intlMessages, '@react-spectrum/s2');
   let {items} = props;
-  let {density, onSelectionChange, selectedKey, isDisabled, disabledKeys, pickerRef, isIconOnly} = useContext(InternalTabsContext);
+  let {density, onSelectionChange, selectedKey, isDisabled, disabledKeys, pickerRef, labelBehavior} = useContext(InternalTabsContext);
   let state = useContext(TabListStateContext);
   let allKeysDisabled = useMemo(() => {
     return isAllTabsDisabled(state?.collection, disabledKeys ? new Set(disabledKeys) : new Set());
@@ -501,7 +509,7 @@ let TabsMenu = (props: {items: Array<Node<any>>, onSelectionChange: TabsProps['o
           ref={pickerRef ? pickerRef : undefined}
           isDisabled={isDisabled || allKeysDisabled}
           density={density!}
-          isIconOnly={isIconOnly}
+          labelBehavior={labelBehavior}
           items={items}
           disabledKeys={disabledKeys}
           selectedKey={selectedKey}
diff --git a/packages/@react-spectrum/s2/src/TabsPicker.tsx b/packages/@react-spectrum/s2/src/TabsPicker.tsx
index c66c8c264e0..4f8473de94b 100644
--- a/packages/@react-spectrum/s2/src/TabsPicker.tsx
+++ b/packages/@react-spectrum/s2/src/TabsPicker.tsx
@@ -88,8 +88,9 @@ export interface PickerProps<T extends object> extends
     density: 'compact' | 'regular',
     /**
      * If the tab picker should only display icon and no text for the button label.
+     * @default 'show
      */
-    isIconOnly?: boolean
+    labelBehavior?: 'show' | 'hide'
 }
 
 export const PickerContext = createContext<ContextValue<Partial<PickerProps<any>>, FocusableRefValue<HTMLButtonElement>>>(null);
@@ -162,7 +163,9 @@ const iconCenterWrapper = style({
   display: 'flex',
   gridArea: 'icon',
   paddingStart: {
-    isIconOnly: size(6)
+    labelBehavior: {
+      hide: size(6)
+    }
   }
 });
 
@@ -181,7 +184,7 @@ function Picker<T extends object>(props: PickerProps<T>, ref: FocusableRef<HTMLB
     items,
     placeholder = stringFormatter.format('picker.placeholder'),
     density,
-    isIconOnly,
+    labelBehavior = 'show',
     ...pickerProps
   } = props;
   let isQuiet = true;
@@ -217,7 +220,7 @@ function Picker<T extends object>(props: PickerProps<T>, ref: FocusableRef<HTMLB
                       [IconContext, {
                         slots: {
                           icon: {
-                            render: centerBaseline({slot: 'icon', styles: iconCenterWrapper({isIconOnly})}),
+                            render: centerBaseline({slot: 'icon', styles: iconCenterWrapper({labelBehavior})}),
                             styles: icon
                           }
                         }
@@ -228,11 +231,13 @@ function Picker<T extends object>(props: PickerProps<T>, ref: FocusableRef<HTMLB
                           [DEFAULT_SLOT]: {styles: style({
                             display: {
                               default: 'block',
-                              isIconOnly: 'none'
+                              labelBehavior: {
+                                hide: 'none'
+                              }
                             },
                             flexGrow: 1,
                             truncate: true
-                          })({isIconOnly})}
+                          })({labelBehavior})}
                         }
                       }],
                       [InsideSelectValueContext, true]
diff --git a/packages/@react-stately/selection/src/types.ts b/packages/@react-stately/selection/src/types.ts
index f6adaff5cf9..8eafe03307b 100644
--- a/packages/@react-stately/selection/src/types.ts
+++ b/packages/@react-stately/selection/src/types.ts
@@ -108,5 +108,6 @@ export interface MultipleSelectionManager extends FocusState {
   isLink(key: Key): boolean,
   /** Returns the props for the given item. */
   getItemProps(key: Key): any,
+  /** The collection of nodes that the selection manager handles. */
   collection: Collection<Node<unknown>>
 }
diff --git a/packages/react-aria-components/src/index.ts b/packages/react-aria-components/src/index.ts
index 1950d15570c..e8c3bb8f04c 100644
--- a/packages/react-aria-components/src/index.ts
+++ b/packages/react-aria-components/src/index.ts
@@ -83,6 +83,7 @@ export {FormValidationContext} from 'react-stately';
 export {parseColor, getColorChannels} from '@react-stately/color';
 export {ListLayout as UNSTABLE_ListLayout, GridLayout as UNSTABLE_GridLayout} from '@react-stately/layout';
 
+export type {AutocompleteProps} from './Autocomplete';
 export type {BreadcrumbsProps, BreadcrumbProps, BreadcrumbRenderProps} from './Breadcrumbs';
 export type {ButtonProps, ButtonRenderProps} from './Button';
 export type {CalendarCellProps, CalendarProps, CalendarRenderProps, CalendarGridProps, CalendarGridHeaderProps, CalendarGridBodyProps, CalendarHeaderCellProps, CalendarCellRenderProps, RangeCalendarProps, RangeCalendarRenderProps} from './Calendar';