downshift 9.3.2 → 9.4.0-alpha.0

package/typings/index.d.ts

@@ -1,23 +1,15 @@
-export * from './index.legacy'
-import Downshift from './index.legacy'
-export default Downshift
+// Downshift (legacy class component)
+export * from '../src/downshift.types'
+export {default} from '../src/downshift.types'
 
-export {
-  UseTagGroupState,
-  UseTagGroupProps,
-  UseTagGroupReturnValue,
-  GetTagGroupProps,
-  GetTagGroupPropsOptions,
-  GetTagGroupPropsReturnValue,
-  GetTagProps,
-  GetTagPropsOptions,
-  GetTagPropsReturnValue,
-  GetTagRemoveProps,
-  GetTagRemovePropsOptions,
-  GetTagRemovePropsReturnValue,
-  UseTagGroupStateChangeTypes,
-} from '../dist/hooks/useTagGroup/index.types'
+// useSelect
+export * from '../src/hooks/useSelect/index.types'
 
-import {UseTagGroupInterface} from '../dist/hooks/useTagGroup/index.types'
-export const useTagGroup: UseTagGroupInterface
-export {UseTagGroupInterface}
+// useCombobox
+export * from '../src/hooks/useCombobox/index.types'
+
+// useMultipleSelection
+export * from '../src/hooks/useMultipleSelection/index.types'
+
+// useTagGroup
+export * from '../src/hooks/useTagGroup/index.types'

package/dist/hooks/reducer.d.ts

@@ -1 +0,0 @@
-export default function downshiftCommonReducer(state: any, props: any, action: any, stateChangeTypes: any): any;

package/dist/hooks/useSelect/utils/defaultProps.d.ts

@@ -1,8 +0,0 @@
-export declare const defaultProps: {
-    isItemDisabled(): boolean;
-    itemToString(item: unknown): string;
-    itemToKey(item: unknown): unknown;
-    stateReducer: typeof import("../../utils-ts").stateReducer;
-    scrollIntoView: typeof import("../../../utils-ts").scrollIntoView;
-    environment: (Window & typeof globalThis) | undefined;
-};

package/dist/hooks/utils-ts/callOnChangeProps.d.ts

@@ -1,2 +0,0 @@
-import { Action, Props, State } from '../../utils-ts';
-export declare function callOnChangeProps<S extends State, P extends Partial<S> & Props<S, T>, T>(action: Action<T>, props: P, state: S, newState: S): void;

package/dist/hooks/utils-ts/getDefaultValue.d.ts

@@ -1,2 +0,0 @@
-import { State } from '../../utils-ts';
-export declare function getDefaultValue<S extends State, P extends Partial<S>>(props: P, propKey: keyof S, defaultStateValues: S): S[keyof S];

package/dist/hooks/utils-ts/getInitialValue.d.ts

@@ -1,2 +0,0 @@
-import { State } from '../../utils-ts';
-export declare function getInitialValue<S extends State, P extends Partial<S>>(props: P, propKey: keyof S, defaultStateValues: S): S[keyof S];

package/dist/hooks/utils-ts/index.d.ts

@@ -1,11 +0,0 @@
-export { useControlledReducer } from './useControlledReducer';
-export { useEnhancedReducer } from './useEnhancedReducer';
-export { callOnChangeProps } from './callOnChangeProps';
-export { getItemAndIndex } from './getItemAndIndex';
-export { useIsInitialMount } from './useIsInitialMount';
-export { stateReducer } from './stateReducer';
-export { propTypes as commonPropTypes } from './propTypes';
-export { capitalizeString } from './capitalizeString';
-export { getDefaultValue } from './getDefaultValue';
-export { getInitialValue } from './getInitialValue';
-export { useA11yMessageStatus } from './useA11yMessageStatus';

package/dist/hooks/utils-ts/stateReducer.d.ts

@@ -1,6 +0,0 @@
-import { Action, State } from '../../utils-ts';
-/**
- * Default state reducer that returns the changes.
- *
- */
-export declare function stateReducer<T>(_s: State, a: Action<T>): unknown;

package/dist/hooks/utils-ts/useControlledReducer.d.ts

@@ -1,12 +0,0 @@
-import { type Action, type State, type Props } from '../../utils-ts';
-/**
- * Wraps the useEnhancedReducer and applies the controlled prop values before
- * returning the new state.
- *
- * @param {Function} reducer Reducer function from downshift.
- * @param {Object} props The hook props, also passed to createInitialState.
- * @param {Function} createInitialState Function that returns the initial state.
- * @param {Function} isStateEqual Function that checks if a previous state is equal to the next.
- * @returns {Array} An array with the state and an action dispatcher.
- */
-export declare function useControlledReducer<S extends State, P extends Partial<S> & Props<S, T>, T, A extends Action<T>>(reducer: (state: S, props: P, action: A) => S, props: P, createInitialState: (props: P) => S, isStateEqual: (prevState: S, newState: S) => boolean): [S, (action: A) => void];

package/dist/hooks/utils-ts/useEnhancedReducer.d.ts

@@ -1,13 +0,0 @@
-import { type Action, type Props, type State } from '../../utils-ts';
-/**
- * Computes the controlled state using a the previous state, props,
- * two reducers, one from downshift and an optional one from the user.
- * Also calls the onChange handlers for state values that have changed.
- *
- * @param {Function} reducer Reducer function from downshift.
- * @param {Object} props The hook props, also passed to createInitialState.
- * @param {Function} createInitialState Function that returns the initial state.
- * @param {Function} isStateEqual Function that checks if a previous state is equal to the next.
- * @returns {Array} An array with the state and an action dispatcher.
- */
-export declare function useEnhancedReducer<S extends State, P extends Partial<S> & Props<S, T>, T, A extends Action<T>>(reducer: (state: S, props: P, action: A) => S, props: P, createInitialState: (props: P) => S, isStateEqual: (prevState: S, newState: S) => boolean): [S, (action: A) => void];

package/dist/hooks/utils.d.ts

@@ -1,58 +0,0 @@
-export let useControlPropsValidator: typeof noop;
-export function useScrollIntoView({ highlightedIndex, isOpen, itemRefs, getItemNodeFromIndex, menuElement, scrollIntoView: scrollIntoViewProp, }: {
-    highlightedIndex: any;
-    isOpen: any;
-    itemRefs: any;
-    getItemNodeFromIndex: any;
-    menuElement: any;
-    scrollIntoView: any;
-}): React.MutableRefObject<boolean>;
-export function useGetterPropsCalledChecker(): typeof noop;
-/**
- * Tracks mouse and touch events, such as mouseDown, touchMove and touchEnd.
- *
- * @param {Window} environment The environment to add the event listeners to, for instance window.
- * @param {() => void} handleBlur The function that is called if mouseDown or touchEnd occured outside the downshiftElements.
- * @param {Array<{current: HTMLElement}>} downshiftElementsRefs The refs for the elements that should not trigger a blur action from mouseDown or touchEnd.
- * @returns {{isMouseDown: boolean, isTouchMove: boolean, isTouchEnd: boolean}} The mouse and touch events information, if any of are happening.
- */
-export function useMouseAndTouchTracker(environment: Window, handleBlur: () => void, downshiftRefs: any): {
-    isMouseDown: boolean;
-    isTouchMove: boolean;
-    isTouchEnd: boolean;
-};
-export function getHighlightedIndexOnOpen(props: any, state: any, offset: any): any;
-export function isAcceptedCharacterKey(key: any): boolean;
-/**
- * Handles selection on Enter / Alt + ArrowUp. Closes the menu and resets the highlighted index, unless there is a highlighted.
- * In that case, selects the item and resets to defaults for open state and highlighted idex.
- * @param {Object} props The useCombobox props.
- * @param {number} highlightedIndex The index from the state.
- * @param {boolean} inputValue Also return the input value for state.
- * @returns The changes for the state.
- */
-export function getChangesOnSelection(props: Object, highlightedIndex: number, inputValue?: boolean): any;
-/**
- * Check if a state is equal for dropdowns, by comparing isOpen, inputValue, highlightedIndex and selected item.
- * Used by useSelect and useCombobox.
- *
- * @param {Object} prevState
- * @param {Object} newState
- * @returns {boolean} Wheather the states are deeply equal.
- */
-export function isDropdownsStateEqual(prevState: Object, newState: Object): boolean;
-/**
- * Returns the new highlightedIndex based on the defaultHighlightedIndex prop, if it's not disabled.
- *
- * @param {Object} props Props from useCombobox or useSelect.
- * @returns {number} The highlighted index.
- */
-export function getDefaultHighlightedIndex(props: Object): number;
-export function getInitialState(props: any): {
-    highlightedIndex: any;
-    isOpen: unknown;
-    selectedItem: unknown;
-    inputValue: unknown;
-};
-import { noop } from "../utils-ts";
-import * as React from "react";

package/dist/hooks/utils.dropdown/defaultProps.d.ts

@@ -1,9 +0,0 @@
-import { scrollIntoView } from '../../utils-ts';
-import { stateReducer } from '../utils-ts';
-export declare const defaultProps: {
-    itemToString(item: unknown): string;
-    itemToKey(item: unknown): unknown;
-    stateReducer: typeof stateReducer;
-    scrollIntoView: typeof scrollIntoView;
-    environment: (Window & typeof globalThis) | undefined;
-};

package/dist/hooks/utils.dropdown/index.d.ts

@@ -1,3 +0,0 @@
-export { propTypes as dropdownPropTypes } from './propTypes';
-export { defaultProps as dropdownDefaultProps } from './defaultProps';
-export { defaultStateValues as dropdownDefaultStateValues } from './defaultStateValues';

package/dist/utils-ts/getState.d.ts

@@ -1,22 +0,0 @@
-export interface Action<T> extends Record<string, unknown> {
-    type: T;
-}
-export type State = Record<string, unknown>;
-export interface Props<S, T> {
-    onStateChange?(typeAndChanges: unknown): void;
-    stateReducer(state: S, actionAndChanges: Action<T> & {
-        changes: Partial<S>;
-    }): Partial<S>;
-}
-/**
- * This will perform a shallow merge of the given state object
- * with the state coming from props
- * (for the controlled component scenario)
- * This is used in state updater functions so they're referencing
- * the right state regardless of where it comes from.
- *
- * @param state The state of the component/hook.
- * @param props The props that may contain controlled values.
- * @returns The merged controlled state.
- */
-export declare function getState<S extends State, P extends Partial<S> & Props<S, T>, T>(state: S, props?: P): S;

package/dist/utils-ts/handleRefs.d.ts

@@ -1,2 +0,0 @@
-import * as React from 'react';
-export declare function handleRefs(...refs: (React.MutableRefObject<HTMLElement> | React.RefCallback<HTMLElement> | undefined)[]): (node: HTMLElement) => void;

package/dist/utils-ts/validatePropTypes.d.ts

@@ -1,2 +0,0 @@
-import PropTypes from 'prop-types';
-export declare let validatePropTypes: (options: unknown, caller: Function, propTypes: Record<string, PropTypes.Requireable<(...args: unknown[]) => unknown>>) => void;

package/dist/utils.d.ts

@@ -1,123 +0,0 @@
-/**
- * Accepts a parameter and returns it if it's a function
- * or a noop function if it's not. This allows us to
- * accept a callback, but not worry about it if it's not
- * passed.
- * @param {Function} cb the callback
- * @return {Function} a function
- */
-export function cbToCb(cb: Function): Function;
-/**
- * This is intended to be used to compose event handlers.
- * They are executed in order until one of them sets
- * `event.preventDownshiftDefault = true`.
- * @param {...Function} fns the event handler functions
- * @return {Function} the event handler to add to an element
- */
-export function callAllEventHandlers(...fns: Function[]): Function;
-export function handleRefs(...refs: any[]): (node: any) => void;
-/**
- * Simple debounce implementation. Will call the given
- * function once after the time given has passed since
- * it was last called.
- * @param {Function} fn the function to call after the time
- * @param {Number} time the time to wait
- * @return {Function} the debounced function
- */
-export function debounce(fn: Function, time: number): Function;
-/**
- * Default implementation for status message. Only added when menu is open.
- * Will specify if there are results in the list, and if so, how many,
- * and what keys are relevant.
- *
- * @param {Object} param the downshift state and other relevant properties
- * @return {String} the a11y status message
- */
-export function getA11yStatusMessage({ isOpen, resultCount, previousResultCount }: Object): string;
-/**
- * Takes an argument and if it's an array, returns the first item in the array
- * otherwise returns the argument
- * @param {*} arg the maybe-array
- * @param {*} defaultValue the value if arg is falsey not defined
- * @return {*} the arg or it's first item
- */
-export function unwrapArray(arg: any, defaultValue: any): any;
-/**
- * @param {Object} element (P)react element
- * @return {Boolean} whether it's a DOM element
- */
-export function isDOMElement(element: Object): boolean;
-/**
- * @param {Object} element (P)react element
- * @return {Object} the props
- */
-export function getElementProps(element: Object): Object;
-/**
- * Throws a helpful error message for required properties. Useful
- * to be used as a default in destructuring or object params.
- * @param {String} fnName the function name
- * @param {String} propName the prop name
- */
-export function requiredProp(fnName: string, propName: string): void;
-/**
- * @param {Object} state the state object
- * @return {Object} state that is relevant to downshift
- */
-export function pickState(state?: Object): Object;
-/**
- * Simple check if the value passed is object literal
- * @param {*} obj any things
- * @return {Boolean} whether it's object literal
- */
-export function isPlainObject(obj: any): boolean;
-/**
- * Normalizes the 'key' property of a KeyboardEvent in IE/Edge
- * @param {Object} event a keyboardEvent object
- * @return {String} keyboard key
- */
-export function normalizeArrowKey(event: Object): string;
-/**
- * Checks if event target is within the downshift elements.
- *
- * @param {EventTarget} target Target to check.
- * @param {HTMLElement[]} downshiftElements The elements that form downshift (list, toggle button etc).
- * @param {Window} environment The window context where downshift renders.
- * @param {boolean} checkActiveElement Whether to also check activeElement.
- *
- * @returns {boolean} Whether or not the target is within downshift elements.
- */
-export function targetWithinDownshift(target: EventTarget, downshiftElements: HTMLElement[], environment: Window, checkActiveElement?: boolean): boolean;
-/**
- * This determines whether a prop is a "controlled prop" meaning it is
- * state which is controlled by the outside of this component rather
- * than within this component.
- *
- * @param {Object} props The props that may contain controlled values.
- * @param {String} key the key to check
- * @return {Boolean} whether it is a controlled controlled prop
- */
-export function isControlledProp(props: Object, key: string): boolean;
-export let validateControlledUnchanged: typeof noop;
-/**
- * Returns the next non-disabled highlightedIndex value.
- *
- * @param {number} start The current highlightedIndex.
- * @param {number} offset The offset from the current highlightedIndex to start searching.
- * @param {unknown[]} items The items array.
- * @param {(item: unknown, index: number) => boolean} isItemDisabled Function that tells if an item is disabled or not.
- * @param {boolean?} circular If the search reaches the end, if it can search again starting from the other end.
- * @returns {number} The next highlightedIndex.
- */
-export function getHighlightedIndex(start: number, offset: number, items: unknown[], isItemDisabled: (item: unknown, index: number) => boolean, circular?: boolean | null): number;
-/**
- * Returns the next non-disabled highlightedIndex value.
- *
- * @param {number} start The current highlightedIndex.
- * @param {boolean} backwards If true, it will search backwards from the start.
- * @param {unknown[]} items The items array.
- * @param {(item: unknown, index: number) => boolean} isItemDisabled Function that tells if an item is disabled or not.
- * @param {boolean} circular If the search reaches the end, if it can search again starting from the other end.
- * @returns {number} The next non-disabled index.
- */
-export function getNonDisabledIndex(start: number, backwards: boolean, items: unknown[], isItemDisabled: (item: unknown, index: number) => boolean, circular?: boolean): number;
-import { noop } from "./utils-ts";