@react-stately/slider 3.0.0-alpha.3 → 3.0.0-nightly-641446f65-240905

package/src/useSliderState.ts

@@ -10,77 +10,204 @@
  * governing permissions and limitations under the License.
  */
 
-import {clamp} from '@react-aria/utils';
+import {clamp, snapValueToStep, useControlledState} from '@react-stately/utils';
+import {Orientation} from '@react-types/shared';
 import {SliderProps} from '@react-types/slider';
-import {useControlledState} from '@react-stately/utils';
-import {useNumberFormatter} from '@react-aria/i18n';
-import {useRef, useState} from 'react';
+import {useCallback, useMemo, useRef, useState} from 'react';
 
 export interface SliderState {
-  // Values managed by the slider
+  /**
+   * Values managed by the slider by thumb index.
+   */
   readonly values: number[],
-  getThumbValue: (index: number) => number,
-
-  // Sets value for thumb.  The actually value set will be clamped and
-  // rounded according to min/max/step
-  setThumbValue: (index: number, value: number) => void,
-
-  // Sets value for thumb by percent offset (between 0 and 1)
-  setThumbPercent: (index: number, percent: number) => void,
-
-  // Whether a specific index is being dragged
-  isThumbDragging: (index: number) => boolean,
-  setThumbDragging: (index: number, dragging: boolean) => void,
-
-  // Currently-focused index
+  /**
+   * Get the value for the specified thumb.
+   * @param index
+   */
+  getThumbValue(index: number): number,
+
+  /**
+   * Sets the value for the specified thumb.
+   * The actual value set will be clamped and rounded according to min/max/step.
+   * @param index
+   * @param value
+   */
+  setThumbValue(index: number, value: number): void,
+
+  /**
+   * Sets value for the specified thumb by percent offset (between 0 and 1).
+   * @param index
+   * @param percent
+   */
+  setThumbPercent(index: number, percent: number): void,
+
+  /**
+   * Whether the specific thumb is being dragged.
+   * @param index
+   */
+  isThumbDragging(index: number): boolean,
+  /**
+   * Set is dragging on the specified thumb.
+   * @param index
+   * @param dragging
+   */
+  setThumbDragging(index: number, dragging: boolean): void,
+
+  /**
+   * Currently-focused thumb index.
+   */
   readonly focusedThumb: number | undefined,
-  setFocusedThumb: (index: number | undefined) => void,
-
-  // Returns the value offset as a percentage from 0 to 1.
-  getThumbPercent: (index: number) => number,
-  getValuePercent: (value: number) => number,
-
-  // Returns the string label for the value, per props.formatOptions
-  getThumbValueLabel: (index: number) => string,
-  getFormattedValue: (value: number) => string,
-
-  // Returns the min and max values for the index
-  getThumbMinValue: (index: number) => number,
-  getThumbMaxValue: (index: number) => number,
-
-  // Converts a percent along track (between 0 and 1) to the corresponding value
-  getPercentValue: (percent: number) => number,
-
-  // editable
-  isThumbEditable: (index: number) => boolean,
-  setThumbEditable: (index: number, editable: boolean) => void,
-
-  // The step amount for the slider
-  readonly step: number
+  /**
+   * Set focused true on specified thumb. This will remove focus from
+   * any thumb that had it before.
+   * @param index
+   */
+  setFocusedThumb(index: number | undefined): void,
+
+  /**
+   * Returns the specified thumb's value as a percentage from 0 to 1.
+   * @param index
+   */
+  getThumbPercent(index: number): number,
+
+  /**
+   * Returns the value as a percent between the min and max of the slider.
+   * @param index
+   */
+  getValuePercent(value: number): number,
+
+  /**
+   * Returns the string label for the specified thumb's value, per props.formatOptions.
+   * @param index
+   */
+  getThumbValueLabel(index: number): string,
+
+  /**
+   * Returns the string label for the value, per props.formatOptions.
+   * @param index
+   */
+  getFormattedValue(value: number): string,
+
+  /**
+   * Returns the min allowed value for the specified thumb.
+   * @param index
+   */
+  getThumbMinValue(index: number): number,
+
+  /**
+   * Returns the max allowed value for the specified thumb.
+   * @param index
+   */
+  getThumbMaxValue(index: number): number,
+
+  /**
+   * Converts a percent along track (between 0 and 1) to the corresponding value.
+   * @param percent
+   */
+  getPercentValue(percent: number): number,
+
+  /**
+   * Returns if the specified thumb is editable.
+   * @param index
+   */
+  isThumbEditable(index: number): boolean,
+
+  /**
+   * Set the specified thumb's editable state.
+   * @param index
+   * @param editable
+   */
+  setThumbEditable(index: number, editable: boolean): void,
+
+  /**
+   * Increments the value of the thumb by the step or page amount.
+   */
+  incrementThumb(index: number, stepSize?: number): void,
+  /**
+   * Decrements the value of the thumb by the step or page amount.
+   */
+  decrementThumb(index: number, stepSize?: number): void,
+
+  /**
+   * The step amount for the slider.
+   */
+  readonly step: number,
+
+  /**
+   * The page size for the slider, used to do a bigger step.
+   */
+  readonly pageSize: number,
+
+  /** The orientation of the slider. */
+  readonly orientation: Orientation,
+
+  /** Whether the slider is disabled. */
+  readonly isDisabled: boolean
 }
 
-export const DEFAULT_MIN_VALUE = 0;
-export const DEFAULT_MAX_VALUE = 100;
-export const DEFAULT_STEP_VALUE = 1;
+const DEFAULT_MIN_VALUE = 0;
+const DEFAULT_MAX_VALUE = 100;
+const DEFAULT_STEP_VALUE = 1;
 
-export function useSliderState(props: SliderProps): SliderState {
-  const {isDisabled, minValue = DEFAULT_MIN_VALUE, maxValue = DEFAULT_MAX_VALUE, formatOptions, step = DEFAULT_STEP_VALUE} = props;
+export interface SliderStateOptions<T> extends SliderProps<T> {
+  numberFormatter: Intl.NumberFormat
+}
 
-  const [values, setValues] = useControlledState<number[]>(
-    props.value as any,
-    props.defaultValue ?? [minValue] as any,
-    props.onChange as any
+/**
+ * Provides state management for a slider component. Stores values for all thumbs,
+ * formats values for localization, and provides methods to update the position
+ * of any thumbs.
+ * @param props
+ */
+export function useSliderState<T extends number | number[]>(props: SliderStateOptions<T>): SliderState {
+  const {
+    isDisabled = false,
+    minValue = DEFAULT_MIN_VALUE,
+    maxValue = DEFAULT_MAX_VALUE,
+    numberFormatter: formatter,
+    step = DEFAULT_STEP_VALUE,
+    orientation = 'horizontal'
+  } = props;
+
+  // Page step should be at least equal to step and always a multiple of the step.
+  let pageSize = useMemo(() => {
+    let calcPageSize = (maxValue - minValue) / 10;
+    calcPageSize = snapValueToStep(calcPageSize, 0, calcPageSize + step, step);
+    return Math.max(calcPageSize, step);
+  }, [step, maxValue, minValue]);
+
+  let restrictValues = useCallback((values: number[]) => values?.map((val, idx) => {
+    let min = idx === 0 ? minValue : val[idx - 1];
+    let max = idx === values.length - 1 ? maxValue : val[idx + 1];
+    return snapValueToStep(val, min, max, step);
+  }), [minValue, maxValue, step]);
+
+  let value = useMemo(() => restrictValues(convertValue(props.value)), [props.value]);
+  let defaultValue = useMemo(() => restrictValues(convertValue(props.defaultValue) ?? [minValue]), [props.defaultValue, minValue]);
+  let onChange = createOnChange(props.value, props.defaultValue, props.onChange);
+  let onChangeEnd = createOnChange(props.value, props.defaultValue, props.onChangeEnd);
+
+  const [values, setValuesState] = useControlledState<number[]>(
+    value,
+    defaultValue,
+    onChange
   );
-  const [isDraggings, setDraggings] = useState<boolean[]>(new Array(values.length).fill(false));
+  const [isDraggings, setDraggingsState] = useState<boolean[]>(new Array(values.length).fill(false));
   const isEditablesRef = useRef<boolean[]>(new Array(values.length).fill(true));
-  const [focusedIndex, setFocusedIndex] = useState<number|undefined>(undefined);
+  const [focusedIndex, setFocusedIndex] = useState<number | undefined>(undefined);
+
+  const valuesRef = useRef<number[]>(values);
+  const isDraggingsRef = useRef<boolean[]>(isDraggings);
 
-  const valuesRef = useRef<number[]>(null);
-  valuesRef.current = values;
-  const isDraggingsRef = useRef<boolean[]>(null);
-  isDraggingsRef.current = isDraggings;
+  let setValues = (values: number[]) => {
+    valuesRef.current = values;
+    setValuesState(values);
+  };
 
-  const formatter = useNumberFormatter(formatOptions);
+  let setDraggings = (draggings: boolean[]) => {
+    isDraggingsRef.current = draggings;
+    setDraggingsState(draggings);
+  };
 
   function getValuePercent(value: number) {
     return (value - minValue) / (maxValue - minValue);
@@ -109,23 +236,26 @@ export function useSliderState(props: SliderProps): SliderState {
     const thisMax = getThumbMaxValue(index);
 
     // Round value to multiple of step, clamp value between min and max
-    value = clamp(getRoundedValue(value), thisMin, thisMax);
-    valuesRef.current = replaceIndex(valuesRef.current, index, value);
-    setValues(valuesRef.current);
+    value = snapValueToStep(value, thisMin, thisMax, step);
+    let newValues = replaceIndex(valuesRef.current, index, value);
+    setValues(newValues);
   }
 
   function updateDragging(index: number, dragging: boolean) {
     if (isDisabled || !isThumbEditable(index)) {
       return;
     }
+    if (dragging) {
+      valuesRef.current = values;
+    }
 
     const wasDragging = isDraggingsRef.current[index];
     isDraggingsRef.current = replaceIndex(isDraggingsRef.current, index, dragging);
     setDraggings(isDraggingsRef.current);
 
     // Call onChangeEnd if no handles are dragging.
-    if (props.onChangeEnd && wasDragging && !isDraggingsRef.current.some(Boolean)) {
-      props.onChangeEnd(valuesRef.current);
+    if (onChangeEnd && wasDragging && !isDraggingsRef.current.some(Boolean)) {
+      onChangeEnd(valuesRef.current);
     }
   }
 
@@ -146,6 +276,16 @@ export function useSliderState(props: SliderProps): SliderState {
     return clamp(getRoundedValue(val), minValue, maxValue);
   }
 
+  function incrementThumb(index: number, stepSize: number = 1) {
+    let s = Math.max(stepSize, step);
+    updateValue(index, snapValueToStep(values[index] + s, minValue, maxValue, step));
+  }
+
+  function decrementThumb(index: number, stepSize: number = 1) {
+    let s = Math.max(stepSize, step);
+    updateValue(index, snapValueToStep(values[index] - s, minValue, maxValue, step));
+  }
+
   return {
     values: values,
     getThumbValue: (index: number) => values[index],
@@ -164,7 +304,12 @@ export function useSliderState(props: SliderProps): SliderState {
     getPercentValue,
     isThumbEditable,
     setThumbEditable,
-    step
+    incrementThumb,
+    decrementThumb,
+    step,
+    pageSize,
+    orientation,
+    isDisabled
   };
 }
 
@@ -175,3 +320,21 @@ function replaceIndex<T>(array: T[], index: number, value: T) {
 
   return [...array.slice(0, index), value, ...array.slice(index + 1)];
 }
+
+function convertValue(value: number | number[]) {
+  if (value == null) {
+    return undefined;
+  }
+
+  return Array.isArray(value) ? value : [value];
+}
+
+function createOnChange(value, defaultValue, onChange) {
+  return (newValue: number[]) => {
+    if (typeof value === 'number' || typeof defaultValue === 'number') {
+      onChange?.(newValue[0]);
+    } else {
+      onChange?.(newValue);
+    }
+  };
+}

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2019 Adobe
-
-   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.