@react-types/shared 3.8.0 → 3.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-types/shared",
-  "version": "3.8.0",
+  "version": "3.11.0",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "types": "src/index.d.ts",
@@ -14,5 +14,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9204e1b8cb61dac767e91087fb16203611dc67c5"
+  "gitHead": "54c2366c4f31bd4bf619126131cd583c12972acc"
 }

package/src/dom.d.ts

@@ -10,7 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import {ClipboardEventHandler, CompositionEventHandler, FormEventHandler, ReactEventHandler} from 'react';
+import {
+  ClipboardEventHandler,
+  CompositionEventHandler,
+  FormEventHandler,
+  ReactEventHandler
+} from 'react';
 
 export interface AriaLabelingProps {
   /**
@@ -125,7 +130,7 @@ export interface TextInputDOMProps extends DOMProps {
    * Handler that is called when a text composition system starts a new text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionstart_event).
    */
   onCompositionStart?: CompositionEventHandler<HTMLInputElement>,
-  
+
   /**
    * Handler that is called when a text composition system completes or cancels the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionend_event).
    */

package/src/events.d.ts

@@ -40,7 +40,14 @@ export interface PressEvent {
   /** Whether the ctrl keyboard modifier was held during the press event. */
   ctrlKey: boolean,
   /** Whether the meta keyboard modifier was held during the press event. */
-  metaKey: boolean
+  metaKey: boolean,
+  /** Whether the alt keyboard modifier was held during the press event. */
+  altKey: boolean
+}
+
+export interface LongPressEvent extends Omit<PressEvent, 'type'> {
+  /** The type of long press event being fired. */
+  type: 'longpressstart' | 'longpressend' | 'longpress'
 }
 
 export interface HoverEvent {
@@ -103,7 +110,15 @@ export interface FocusableProps extends FocusEvents, KeyboardEvents {
 
 interface BaseMoveEvent {
   /** The pointer type that triggered the move event. */
-  pointerType: PointerType
+  pointerType: PointerType,
+  /** Whether the shift keyboard modifier was held during the move event. */
+  shiftKey: boolean,
+  /** Whether the ctrl keyboard modifier was held during the move event. */
+  ctrlKey: boolean,
+  /** Whether the meta keyboard modifier was held during the move event. */
+  metaKey: boolean,
+  /** Whether the alt keyboard modifier was held during the move event. */
+  altKey: boolean
 }
 
 export interface MoveStartEvent extends BaseMoveEvent {

package/src/index.d.ts

@@ -13,7 +13,6 @@
 export * from './dom';
 export * from './inputs';
 export * from './selection';
-export * from './splitview';
 export * from './dnd';
 export * from './collections';
 export * from './removable';

package/src/inputs.d.ts

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 
+import {ReactNode} from 'react';
+
 export type ValidationState = 'valid' | 'invalid';
 
 export interface Validation {
@@ -29,13 +31,13 @@ export interface InputBase {
   isReadOnly?: boolean
 }
 
-export interface ValueBase<T> {
+export interface ValueBase<T, C = T> {
   /** The current value (controlled). */
   value?: T,
   /** The default value (uncontrolled). */
   defaultValue?: T,
   /** Handler that is called when the value changes. */
-  onChange?: (value: T) => void
+  onChange?: (value: C) => void
 }
 
 export interface TextInputBase {
@@ -58,3 +60,18 @@ export interface RangeInputBase<T> {
   /** The amount that the input value changes with each increment or decrement "tick". */
   step?: T // ??
 }
+
+export interface HelpTextProps {
+  /** A description for the field. Provides a hint such as specific requirements for what to choose. */
+  description?: ReactNode,
+  /** An error message for the field. */
+  errorMessage?: ReactNode
+}
+
+// Spectrum specific types. Extends `Validation` so that the `validationState` prop is available.
+export interface SpectrumHelpTextProps extends HelpTextProps, Validation {
+  /** Whether the description is displayed with lighter text. */
+  isDisabled?: boolean,
+  /** Whether an error icon is rendered. */
+  showErrorIcon?: boolean
+}

package/src/selection.d.ts

@@ -16,7 +16,7 @@ export interface SingleSelection {
   /** Whether the collection allows empty selection. */
   disallowEmptySelection?: boolean,
   /** The currently selected key in the collection (controlled). */
-  selectedKey?: Key,
+  selectedKey?: Key | null,
   /** The initial selected key in the collection (uncontrolled). */
   defaultSelectedKey?: Key,
   /** Handler that is called when the selection changes. */
@@ -24,6 +24,7 @@ export interface SingleSelection {
 }
 
 export type SelectionMode = 'none' | 'single' | 'multiple';
+export type SelectionBehavior = 'toggle' | 'replace';
 export type Selection = 'all' | Set<Key>;
 export interface MultipleSelection {
   /** The type of selection that is allowed in the collection. */
@@ -40,4 +41,9 @@ export interface MultipleSelection {
   disabledKeys?: Iterable<Key>
 }
 
+export interface SpectrumSelectionProps {
+  /** How selection should be displayed. */
+  selectionStyle?: 'checkbox' | 'highlight'
+}
+
 export type FocusStrategy = 'first' | 'last';

package/src/splitview.d.ts

@@ -1,83 +0,0 @@
-/*
- * Copyright 2020 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 {
-  Dispatch,
-  MutableRefObject,
-  ReactElement,
-  SetStateAction
-} from 'react';
-import {Orientation} from './orientation';
-
-export interface SplitViewStatelyProps {
-  allowsCollapsing?: boolean,
-  onResize?: (primarySize: number) => void,
-  onResizeEnd?: (primarySize: number) => void,
-  primarySize?: number,
-  defaultPrimarySize?: number
-}
-
-export interface SplitViewHandleState {
-  offset: number,
-  dragging: boolean,
-  hovered: boolean,
-  setOffset: (value: number) => void,
-  setDragging: (value: boolean) => void,
-  setHover: (value: boolean) => void,
-  increment: () => void,
-  decrement: () => void,
-  incrementToMax: () => void,
-  decrementToMin: () => void,
-  collapseToggle: () => void
-}
-
-export interface SplitViewContainerState {
-  minPos: number,
-  maxPos: number,
-  setMinPos: Dispatch<SetStateAction<number>>,
-  setMaxPos: Dispatch<SetStateAction<number>>
-}
-
-export interface SplitViewState {
-  handleState: SplitViewHandleState,
-  containerState: SplitViewContainerState
-}
-
-export interface SplitViewAriaProps {
-  id?: string,
-  allowsResizing?: boolean,
-  orientation?: Orientation,
-  primaryPane?: 0 | 1,
-  primaryMinSize?: number,
-  primaryMaxSize?: number,
-  secondaryMinSize?: number,
-  secondaryMaxSize?: number,
-  'aria-label'?: string,
-  'aria-labelledby'?: string,
-  containerRef?: MutableRefObject<HTMLDivElement>
-}
-
-export interface SplitViewProps {
-  children: [ReactElement, ReactElement],
-  orientation?: Orientation,
-  allowsResizing?: boolean,
-  allowsCollapsing?: boolean,
-  onResize?: (primarySize: number) => void,
-  onResizeEnd?: (primarySize: number) => void,
-  primaryPane?: 0 | 1,
-  primarySize?: number,
-  defaultPrimarySize?: number,
-  primaryMinSize?: number,
-  primaryMaxSize?: number,
-  secondaryMinSize?: number,
-  secondaryMaxSize?: number
-}