@react-types/actionbar 3.0.0-alpha.9 → 3.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/src/index.d.ts +5 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@react-types/actionbar",
3
- "version": "3.0.0-alpha.9",
3
+ "version": "3.0.0-beta.0",
4
4
  "description": "Spectrum UI components in React",
5
5
  "license": "Apache-2.0",
6
6
  "types": "src/index.d.ts",
@@ -9,7 +9,7 @@
9
9
  "url": "https://github.com/adobe/react-spectrum"
10
10
  },
11
11
  "dependencies": {
12
- "@react-types/shared": "^3.14.1"
12
+ "@react-types/shared": "^3.17.0"
13
13
  },
14
14
  "peerDependencies": {
15
15
  "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0"
@@ -17,5 +17,5 @@
17
17
  "publishConfig": {
18
18
  "access": "public"
19
19
  },
20
- "gitHead": "b03ef51e6317547dd0a840f151e59d039b1e1fd3"
20
+ "gitHead": "a0efee84aa178cb1a202951dfd6d8de02b292307"
21
21
  }
package/src/index.d.ts CHANGED
@@ -14,17 +14,20 @@ import {CollectionBase, DOMProps, StyleProps} from '@react-types/shared';
14
14
  import {Key, ReactNode} from 'react';
15
15
 
16
16
  export interface ActionBarProps<T> extends CollectionBase<T> {
17
- // Required. When zero, the ActionBar is hidden.
17
+ /** The number of selected items that the ActionBar is currently linked to. If 0, the ActionBar is hidden. */
18
18
  selectedItemCount: number | 'all',
19
- // Also required. When clicked, the selection should be cleared.
19
+ /** Handler that is called when the ActionBar clear button is pressed. */
20
20
  onClearSelection: () => void,
21
+ /** Whether the ActionBar should be displayed with a emphasized style. */
21
22
  isEmphasized?: boolean,
23
+ /** Handler that is called when an ActionBar button is pressed. */
22
24
  onAction?: (key: Key) => void
23
25
  }
24
26
 
25
27
  export interface SpectrumActionBarProps<T> extends ActionBarProps<T>, DOMProps, StyleProps {}
26
28
 
27
29
  interface ActionBarContainerProps {
30
+ /** The contents of the ActionBarContainer. Should include a ActionBar and the renderable content it is associated with. */
28
31
  children: ReactNode
29
32
  }
30
33