@react-aria/selection - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

dist/types.d.ts

@@ -15,11 +15,37 @@ import { HTMLAttributes, Key, RefObject } from "react";
 interface SelectableCollectionOptions {
+    /**
+     * An interface for reading and updating multiple selection state.
+     */
     selectionManager: MultipleSelectionManager;
+    /**
+     * A delegate object that implements behavior for keyboard focus movement.
+     */
     keyboardDelegate: KeyboardDelegate;
+    /**
+     * The ref attached to the element representing the collection.
+     */
     ref: RefObject<HTMLElement>;
+    /**
+     * Whether the collection or one of its items should be automatically focused upon render.
+     * @default false
+     */
     autoFocus?: boolean | FocusStrategy;
+    /**
+     * Whether focus should wrap around when the end/start is reached.
+     * @default false
+     */
     shouldFocusWrap?: boolean;
+    /**
+     * Whether the collection allows empty selection.
+     * @default false
+     */
     disallowEmptySelection?: boolean;
+    /**
+     * Whether the collection allows the user to select all items via keyboard shortcut.
+     * @default false
+     */
     disallowSelectAll?: boolean;
 }
 interface SelectableCollectionAria {
+    /** Props for the collection element. */
     collectionProps: HTMLAttributes<HTMLElement>;
@@ -26,0 +52,0 @@ }

package.json

 {
   "name": "@react-aria/selection",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Spectrum UI components in React",
@@ -17,13 +17,13 @@ "license": "Apache-2.0",
     "type": "git",
-    "url": "https://github.com/adobe-private/react-spectrum-v3"
+    "url": "https://github.com/adobe/react-spectrum"
   },
   "dependencies": {
     "@babel/runtime": "^7.6.2",
-    "@react-aria/focus": "^3.0.0",
-    "@react-aria/i18n": "^3.0.0",
-    "@react-aria/interactions": "^3.0.0",
-    "@react-aria/utils": "^3.0.0",
-    "@react-stately/collections": "^3.0.0",
-    "@react-stately/selection": "^3.0.0",
-    "@react-types/shared": "^3.0.0"
+    "@react-aria/focus": "^3.0.1",
+    "@react-aria/i18n": "^3.0.1",
+    "@react-aria/interactions": "^3.0.1",
+    "@react-aria/utils": "^3.0.1",
+    "@react-stately/collections": "^3.0.1",
+    "@react-stately/selection": "^3.0.1",
+    "@react-types/shared": "^3.0.1"
   },
@@ -36,3 +36,3 @@ "peerDependencies": {
   },
-  "gitHead": "a32224fdf009d69cf594f32ad18ac86d7ebb8a52"
+  "gitHead": "ac0b7a7ba0edccd1c9ab4f849022ad6d2ccd19ed"
 }

README.md

 # @react-aria/selection
 
-This package is part of [react-spectrum](https://github.com/adobe-private/react-spectrum-v3). See the repo for more details.
+This package is part of [react-spectrum](https://github.com/adobe/react-spectrum). See the repo for more details.

src/useSelectableCollection.ts

@@ -35,8 +35,33 @@ /*
 interface SelectableCollectionOptions {
+  /**
+   * An interface for reading and updating multiple selection state.
+   */
   selectionManager: MultipleSelectionManager,
+  /**
+   * A delegate object that implements behavior for keyboard focus movement.
+   */
   keyboardDelegate: KeyboardDelegate,
+  /**
+   * The ref attached to the element representing the collection.
+   */
   ref: RefObject<HTMLElement>,
+  /**
+   * Whether the collection or one of its items should be automatically focused upon render.
+   * @default false
+   */
   autoFocus?: boolean | FocusStrategy,
+  /**
+   * Whether focus should wrap around when the end/start is reached.
+   * @default false
+   */
   shouldFocusWrap?: boolean,
+  /**
+   * Whether the collection allows empty selection.
+   * @default false
+   */
   disallowEmptySelection?: boolean,
+  /**
+   * Whether the collection allows the user to select all items via keyboard shortcut.
+   * @default false
+   */
   disallowSelectAll?: boolean
@@ -46,2 +71,3 @@ }
 interface SelectableCollectionAria {
+  /** Props for the collection element. */
   collectionProps: HTMLAttributes<HTMLElement>
@@ -48,0 +74,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

168308

increased by1.86%

Lines of code

1896

increased by2.82%

Dependency changes

• Updated@react-aria/focus@^3.0.1

• Updated@react-aria/i18n@^3.0.1

• Updated@react-aria/interactions@^3.0.1

• Updated@react-aria/utils@^3.0.1

• Updated@react-stately/collections@^3.0.1

• Updated@react-stately/selection@^3.0.1

• Updated@react-types/shared@^3.0.1