Support and document preventFocusOnPress (#6854)

adobe · Aug 22, 2024 · b4093df · b4093df · rspbot · Aug 22, 2024
1 parent 22e803a
commit b4093df
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 8 deletions.
diff --git a/packages/@react-aria/button/src/useButton.ts b/packages/@react-aria/button/src/useButton.ts
@@ -55,7 +55,6 @@ export function useButton(props: AriaButtonOptions<ElementType>, ref: RefObject<
     onPressEnd,
     onPressUp,
     onPressChange,
-    // @ts-ignore - undocumented
     preventFocusOnPress,
     // @ts-ignore - undocumented
     allowFocusWhenDisabled,

diff --git a/packages/@react-aria/combobox/src/useComboBox.ts b/packages/@react-aria/combobox/src/useComboBox.ts
@@ -346,7 +346,6 @@ export function useComboBox<T>(props: AriaComboBoxOptions<T>, state: ComboBoxSta
       ...menuTriggerProps,
       ...triggerLabelProps,
       excludeFromTabOrder: true,
-      // @ts-ignore - undocumented
       preventFocusOnPress: true,
       onPress,
       onPressStart,

diff --git a/packages/@react-aria/searchfield/src/useSearchField.ts b/packages/@react-aria/searchfield/src/useSearchField.ts
@@ -116,7 +116,6 @@ export function useSearchField(
     clearButtonProps: {
       'aria-label': stringFormatter.format('Clear search'),
       excludeFromTabOrder: true,
-      // @ts-ignore
       preventFocusOnPress: true,
       isDisabled: isDisabled || isReadOnly,
       onPress: onClearButtonClick,

diff --git a/packages/@react-types/button/src/index.d.ts b/packages/@react-types/button/src/index.d.ts
@@ -59,7 +59,14 @@ interface AriaBaseButtonProps extends FocusableDOMProps, AriaLabelingProps {
    * The behavior of the button when used in an HTML form.
    * @default 'button'
    */
-  type?: 'button' | 'submit' | 'reset'
+  type?: 'button' | 'submit' | 'reset',
+  /**
+   * Whether to prevent focus from moving to the button when pressing it.
+   *
+   * Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided,
+   * such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.
+   */
+  preventFocusOnPress?: boolean
 }
 
 export interface AriaButtonProps<T extends ElementType = 'button'> extends ButtonProps, LinkButtonProps<T>, AriaBaseButtonProps {}

diff --git a/scripts/compareAPIs.js b/scripts/compareAPIs.js
@@ -292,7 +292,7 @@ function getDiff(pair) {
 ${joinedResult}
 \`\`\``;
     }
-    diffs.push({iname, result: joinedResult, simplifiedName});
+    diffs.push({iname, result: joinedResult, simplifiedName: `${name.replace('/dist/api.json', '')}:${simplifiedName}`});
   });
 
   return {diffs, name};
@@ -535,9 +535,20 @@ function rebuildInterfaces(json) {
         let name = property.name;
         let optional = property.optional;
         let defaultVal = property.default;
-        let value = processType(property.value);
-        // TODO: what to do with defaultVal and optional
-        funcInterface[name] = {optional, defaultVal, value};
+        // this needs to handle types like spreads, but need to build that into the build API's first
+        if (!property.value) {
+          name = 'UNKNOWN';
+          let i = 0;
+          while (funcInterface[name]) {
+            i++;
+            name = 'UNKNOWN' + String(i);
+          }
+          funcInterface[name] = {optional, defaultVal, value: property.type};
+        } else {
+          let value = processType(property.value);
+          // TODO: what to do with defaultVal and optional
+          funcInterface[name] = {optional, defaultVal, value};
+        }
       });
       let name = item.name ?? key;
       if (item.typeParameters?.length > 0) {