@dnb/eufemia 9.27.0 → 9.30.0

package/es/components/slider/SliderHelpers.d.ts

@@ -0,0 +1,23 @@
+import { formatOptionParams, formatValue, formatReturnType } from '../number-format/NumberUtils';
+import type { ValueTypes } from './types';
+export declare const percentToValue: (percent: number, min: number, max: number, isReverse: boolean) => number;
+export declare const roundToStep: (number: number, step: number) => number;
+export declare const getOffset: (node: HTMLElement) => {
+    top: number;
+    left: number;
+};
+export declare const getMousePosition: (event: MouseEvent & TouchEvent) => {
+    x: number;
+    y: number;
+};
+export declare const calculatePercent: (node: HTMLElement, event: MouseEvent | TouchEvent, isVertical: boolean) => number;
+export declare const clamp: (value: number, min?: number, max?: number) => number;
+export declare const roundValue: (value: number, step: number) => number;
+export declare const createMockDiv: ({ width, height }: {
+    width: any;
+    height: any;
+}) => HTMLDivElement;
+export declare const getUpdatedValues: (value: Array<number>, index: number, newValue: number) => ValueTypes;
+export declare const closestIndex: (goal: number, array: Array<number>) => number;
+export declare const formatNumber: (value: formatValue, opts?: formatOptionParams) => formatReturnType;
+export declare const getHumanNumber: (value: number, numberFormat: formatOptionParams) => string;

package/es/components/slider/SliderHelpers.js

@@ -0,0 +1,130 @@
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import _extends from "@babel/runtime/helpers/esm/extends";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+import { format } from '../number-format/NumberUtils';
+export const percentToValue = (percent, min, max, isReverse) => {
+  if (typeof min === 'string') {
+    min = parseFloat(min);
+  }
+
+  if (typeof max === 'string') {
+    max = parseFloat(max);
+  }
+
+  let num = (max - min) * percent / 100 + min;
+
+  if (isReverse) {
+    num = max + min - num;
+  }
+
+  return num;
+};
+export const roundToStep = (number, step) => Math.round(number / step) * step;
+export const getOffset = node => {
+  const {
+    pageYOffset,
+    pageXOffset
+  } = typeof window !== 'undefined' ? window : {
+    pageYOffset: 0,
+    pageXOffset: 0
+  };
+  const {
+    left,
+    top
+  } = node.getBoundingClientRect();
+  return {
+    top: top + pageYOffset,
+    left: left + pageXOffset
+  };
+};
+export const getMousePosition = event => {
+  if (event.changedTouches && event.changedTouches[0]) {
+    return {
+      x: event.changedTouches[0].pageX,
+      y: event.changedTouches[0].pageY
+    };
+  }
+
+  return {
+    x: event.pageX,
+    y: event.pageY
+  };
+};
+export const calculatePercent = (node, event, isVertical) => {
+  const {
+    width,
+    height
+  } = node.getBoundingClientRect();
+  const {
+    top,
+    left
+  } = getOffset(node);
+  const {
+    x,
+    y
+  } = getMousePosition(event);
+  const value = isVertical ? y - top : x - left;
+  const onePercent = (isVertical ? height : width) / 100;
+  return Math.abs(clamp(value / onePercent));
+};
+export const clamp = (value, min = 0, max = 100) => Math.min(Math.max(value, min), max);
+export const roundValue = (value, step) => {
+  return step > 0 ? roundToStep(value, step) : parseFloat(parseFloat(String(value)).toFixed(3));
+};
+export const createMockDiv = ({
+  width,
+  height
+}) => {
+  const div = document.createElement('div');
+
+  _extends(div.style, {
+    width: `${width}px`,
+    height: `${height}px`
+  });
+
+  div.getBoundingClientRect = () => ({
+    width,
+    height,
+    top: 0,
+    left: 0,
+    right: width,
+    bottom: height
+  });
+
+  return div;
+};
+export const getUpdatedValues = (value, index, newValue) => {
+  return value.map((val, i) => {
+    if (i === index) {
+      val = newValue;
+    }
+
+    return val;
+  });
+};
+export const closestIndex = (goal, array) => {
+  const res = [...array].sort((a, b) => Math.abs(goal - a) - Math.abs(goal - b))[0];
+  return array.findIndex(num => num === res);
+};
+export const formatNumber = (value, opts = null) => {
+  if (opts) {
+    return format(value, opts);
+  }
+
+  return value;
+};
+export const getHumanNumber = (value, numberFormat) => {
+  const num = value;
+  const {
+    aria: humanNumber
+  } = numberFormat ? formatNumber(num, _objectSpread(_objectSpread({}, numberFormat || {}), {}, {
+    returnAria: true
+  })) : {
+    aria: null
+  };
+  return String(humanNumber || value);
+};

package/es/components/slider/SliderInstance.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Web Slider Component
+ *
+ */
+/// <reference types="react" />
+export declare function SliderInstance(): JSX.Element;

package/es/components/slider/SliderInstance.js

@@ -0,0 +1,167 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+
+var _SubtractButton, _AddButton, _AlignmentHelper, _SliderMainTrack, _SliderSuffix;
+
+import React from 'react';
+import classnames from 'classnames';
+import { isTrue } from '../../shared/component-helper';
+import AlignmentHelper from '../../shared/AlignmentHelper';
+import { createSpacingClasses } from '../space/SpacingHelper';
+import { createSkeletonClass, skeletonDOMAttributes } from '../skeleton/SkeletonHelper';
+import Context from '../../shared/Context';
+import Suffix from '../../shared/helpers/Suffix';
+import Button from '../button/Button';
+import FormLabel from '../form-label/FormLabel';
+import FormStatus from '../form-status/FormStatus';
+import { SliderMainTrack, SliderTrackAfter, SliderTrackBefore } from './SliderTrack';
+import { SliderThumb } from './SliderThumb';
+import { useSliderProps } from './hooks/useSliderProps';
+import { clamp, getHumanNumber } from './SliderHelpers';
+export function SliderInstance() {
+  const context = React.useContext(Context);
+  const {
+    isReverse,
+    isVertical,
+    showButtons,
+    showStatus,
+    allProps
+  } = useSliderProps();
+  const {
+    id,
+    label,
+    labelSrOnly,
+    labelDirection,
+    status,
+    statusProps,
+    statusState,
+    statusNoAnimation,
+    globalStatusId,
+    stretch,
+    skeleton,
+    disabled,
+    className
+  } = allProps;
+  const mainParams = {
+    className: classnames("dnb-slider dnb-form-component", createSkeletonClass(null, skeleton), createSpacingClasses(allProps), className, isVertical && 'dnb-slider--vertical', disabled && 'dnb-slider__state--disabled', !showButtons && 'dnb-slider--no-buttons', isTrue(stretch) && 'dnb-slider--stretch', label && labelDirection && `dnb-slider__label--${labelDirection}`, showStatus && 'dnb-slider__form-status', status && `dnb-slider__status--${statusState}`)
+  };
+  const subtractButton = showButtons ? _SubtractButton || (_SubtractButton = React.createElement(SubtractButton, null)) : null;
+  const addButton = showButtons ? _AddButton || (_AddButton = React.createElement(AddButton, null)) : null;
+  skeletonDOMAttributes(mainParams, skeleton, context);
+  return React.createElement("span", mainParams, label && React.createElement(FormLabel, {
+    id: id + '-label',
+    text: label,
+    disabled: disabled,
+    skeleton: skeleton,
+    label_direction: labelDirection,
+    sr_only: labelSrOnly
+  }), React.createElement("span", {
+    className: "dnb-slider__wrapper"
+  }, _AlignmentHelper || (_AlignmentHelper = React.createElement(AlignmentHelper, null)), React.createElement(FormStatus, _extends({
+    show: showStatus,
+    id: id + '-form-status',
+    global_status_id: globalStatusId,
+    label: label,
+    text_id: id + '-status',
+    text: status,
+    status: statusState,
+    no_animation: statusNoAnimation,
+    skeleton: skeleton
+  }, statusProps)), React.createElement("span", {
+    className: "dnb-slider__inner"
+  }, showButtons && (isReverse ? addButton : subtractButton), _SliderMainTrack || (_SliderMainTrack = React.createElement(SliderMainTrack, null, React.createElement(SliderThumb, null), React.createElement(SliderTrackBefore, null), React.createElement(SliderTrackAfter, null))), showButtons && (isReverse ? subtractButton : addButton), _SliderSuffix || (_SliderSuffix = React.createElement(SliderSuffix, null)))));
+}
+
+function SliderSuffix() {
+  const {
+    allProps
+  } = useSliderProps();
+  const {
+    id,
+    suffix
+  } = allProps;
+  return suffix ? React.createElement(Suffix, {
+    className: "dnb-slider__suffix",
+    id: id + '-suffix',
+    context: allProps
+  }, suffix) : null;
+}
+
+function SubtractButton() {
+  const {
+    emitChange,
+    value,
+    attributes,
+    allProps
+  } = useSliderProps();
+  const {
+    step,
+    min,
+    max,
+    disabled,
+    skeleton,
+    subtractTitle,
+    numberFormat
+  } = allProps;
+
+  const onSubtractClickHandler = event => {
+    emitChange(event, clamp(value - (step || 1), min, max));
+  };
+
+  const subtractParams = {};
+
+  if (typeof attributes['aria-hidden'] !== 'undefined') {
+    subtractParams['aria-hidden'] = attributes['aria-hidden'];
+  }
+
+  const humanNumber = getHumanNumber(value, numberFormat);
+  return React.createElement(Button, _extends({
+    className: "dnb-slider__button dnb-slider__button--subtract",
+    variant: "secondary",
+    icon: "subtract",
+    size: "small",
+    "aria-label": subtractTitle === null || subtractTitle === void 0 ? void 0 : subtractTitle.replace('%s', humanNumber),
+    on_click: onSubtractClickHandler,
+    disabled: disabled,
+    skeleton: skeleton
+  }, subtractParams));
+}
+
+function AddButton() {
+  const {
+    emitChange,
+    value,
+    attributes,
+    allProps
+  } = useSliderProps();
+  const {
+    step,
+    min,
+    max,
+    disabled,
+    skeleton,
+    addTitle,
+    numberFormat
+  } = allProps;
+
+  const onAddClickHandler = event => {
+    emitChange(event, clamp(value + (step || 1), min, max));
+  };
+
+  const addParams = {};
+
+  if (typeof attributes['aria-hidden'] !== 'undefined') {
+    addParams['aria-hidden'] = attributes['aria-hidden'];
+  }
+
+  const humanNumber = getHumanNumber(value, numberFormat);
+  return React.createElement(Button, _extends({
+    className: "dnb-slider__button dnb-slider__button--add",
+    variant: "secondary",
+    icon: "add",
+    size: "small",
+    "aria-label": addTitle === null || addTitle === void 0 ? void 0 : addTitle.replace('%s', humanNumber),
+    on_click: onAddClickHandler,
+    disabled: disabled,
+    skeleton: skeleton
+  }, addParams));
+}

package/es/components/slider/SliderProvider.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { SliderProps, SliderContextTypes } from './types';
+export declare const SliderContext: React.Context<SliderContextTypes>;
+export declare function SliderProvider(localProps: SliderProps): JSX.Element;

package/es/components/slider/SliderProvider.js

@@ -0,0 +1,214 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["step", "label", "labelDirection", "labelSrOnly", "status", "statusState", "statusProps", "statusNoAnimation", "globalStatusId", "stretch", "suffix", "thumbTitle", "subtractTitle", "addTitle", "hideButtons", "multiThumbBehavior", "numberFormat", "skeleton", "max", "min", "disabled", "className", "id", "onInit", "onChange", "onDragStart", "onDragEnd", "vertical", "reverse", "value", "children"];
+import React from 'react';
+import { includeValidProps } from '../../components/form-row/FormRowHelpers';
+import { usePropsWithContext } from '../../shared/hooks';
+import { warn, isTrue, makeUniqueId, dispatchCustomElementEvent, getStatusState } from '../../shared/component-helper';
+import Context from '../../shared/Context';
+import { closestIndex, formatNumber, getUpdatedValues, roundValue } from './SliderHelpers';
+import { convertSnakeCaseProps } from '../../shared/helpers/withSnakeCaseProps';
+const defaultProps = {
+  statusState: 'error',
+  addTitle: '+',
+  subtractTitle: '−',
+  min: 0,
+  max: 100,
+  value: -1,
+  multiThumbBehavior: 'swap'
+};
+export const SliderContext = React.createContext(null);
+export function SliderProvider(localProps) {
+  const context = React.useContext(Context);
+  const allProps = convertSnakeCaseProps(usePropsWithContext(localProps, defaultProps, {
+    skeleton: context === null || context === void 0 ? void 0 : context.skeleton
+  }, context === null || context === void 0 ? void 0 : context.getTranslation(localProps).Slider, includeValidProps(context === null || context === void 0 ? void 0 : context.FormRow, {
+    vertical: null
+  }), context === null || context === void 0 ? void 0 : context.Slider));
+  const [_id] = React.useState(makeUniqueId);
+
+  if (!allProps.id) {
+    allProps.id = _id;
+  }
+
+  const {
+    step,
+    label,
+    labelDirection,
+    labelSrOnly,
+    status,
+    statusState,
+    statusProps,
+    statusNoAnimation,
+    globalStatusId,
+    stretch,
+    suffix,
+    thumbTitle: title,
+    subtractTitle,
+    addTitle,
+    hideButtons,
+    multiThumbBehavior,
+    numberFormat,
+    skeleton,
+    max,
+    min,
+    disabled,
+    className,
+    id,
+    onInit,
+    onChange,
+    onDragStart,
+    onDragEnd,
+    vertical: _vertical,
+    reverse: _reverse,
+    value: _value,
+    children: _children
+  } = allProps,
+        attributes = _objectWithoutProperties(allProps, _excluded);
+
+  const [value, setValue] = React.useState(_value);
+  const realtimeValue = React.useRef(_value);
+  const [thumbState, setThumbState] = React.useState('initial');
+  const thumbIndex = React.useRef(-1);
+  const [isVertical] = React.useState(isTrue(_vertical));
+  const [isReverse] = React.useState(isVertical ? !isTrue(_reverse) : isTrue(_reverse));
+  const isMulti = Array.isArray(value);
+
+  const setThumbIndex = index => {
+    if (!isNaN(index)) {
+      thumbIndex.current = index;
+    }
+  };
+
+  if (allProps.use_scrollwheel) {
+    warn('use_scrollwheel is not supported anymore!');
+  }
+
+  const getAndUpdateCurrentIndex = currentValue => {
+    let currentIndex = null;
+
+    if (thumbIndex.current > -1) {
+      currentIndex = thumbIndex.current;
+    } else {
+      currentIndex = closestIndex(currentValue, value);
+      setThumbIndex(currentIndex);
+    }
+
+    return currentIndex;
+  };
+
+  const updateValue = value => {
+    setValue(value);
+    realtimeValue.current = value;
+  };
+
+  const emitChange = (event, rawValue) => {
+    if (disabled || isTrue(skeleton)) {
+      return;
+    }
+
+    let numberValue = roundValue(rawValue, step);
+    let multiValues = numberValue;
+
+    if (numberValue > -1) {
+      if (isMulti) {
+        const currentIndex = getAndUpdateCurrentIndex(numberValue);
+        const lower = realtimeValue.current[currentIndex - 1];
+        const upper = realtimeValue.current[currentIndex + 1];
+
+        if (multiThumbBehavior === 'omit') {
+          if (numberValue < lower) {
+            numberValue = lower;
+          }
+
+          if (numberValue > upper) {
+            numberValue = upper;
+          }
+        }
+
+        multiValues = getUpdatedValues(multiThumbBehavior === 'push' ? realtimeValue.current : value, currentIndex, numberValue);
+
+        if (multiThumbBehavior === 'push') {
+          if (typeof lower !== 'undefined' && numberValue < lower) {
+            multiValues[currentIndex - 1] = numberValue;
+          }
+
+          if (typeof upper !== 'undefined' && numberValue >= upper) {
+            multiValues[currentIndex + 1] = numberValue;
+          }
+        }
+
+        if (numberValue === realtimeValue.current[currentIndex]) {
+          return;
+        }
+      } else if (numberValue === realtimeValue.current) {
+        return;
+      }
+
+      if (typeof onChange === 'function') {
+        const obj = {
+          value: multiValues,
+          rawValue,
+          raw_value: rawValue,
+          event,
+          number: null
+        };
+
+        if (numberFormat) {
+          obj.number = formatNumber(numberValue, numberFormat);
+        }
+
+        dispatchCustomElementEvent(allProps, 'onChange', obj);
+      }
+
+      updateValue(multiValues);
+    }
+  };
+
+  React.useEffect(() => {
+    if (isMulti) {
+      const hasChanged = _value.some((val, i) => {
+        return val !== value[i];
+      });
+
+      if (hasChanged) {
+        updateValue(_value);
+      }
+    } else {
+      updateValue(_value);
+    }
+  }, [_value, isMulti]);
+  const trackRef = React.useRef();
+  const jumpedTimeout = React.useRef();
+
+  const setJumpedState = () => {
+    setThumbState('jumped');
+    clearTimeout(jumpedTimeout.current);
+    jumpedTimeout.current = setTimeout(() => setThumbState('normal'), 100);
+  };
+
+  const showStatus = getStatusState(status);
+  const showButtons = !isMulti && !isTrue(hideButtons);
+  const values = isMulti ? value : [value];
+  return React.createElement(SliderContext.Provider, {
+    value: {
+      isMulti,
+      isReverse,
+      isVertical,
+      value,
+      values,
+      setValue,
+      attributes,
+      showStatus,
+      showButtons,
+      thumbState,
+      setThumbState,
+      thumbIndex,
+      setThumbIndex,
+      emitChange,
+      allProps,
+      trackRef,
+      setJumpedState,
+      jumpedTimeout
+    }
+  }, localProps.children);
+}

package/es/components/slider/SliderThumb.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function SliderThumb(): JSX.Element;

package/es/components/slider/SliderThumb.js

@@ -0,0 +1,106 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+import React from 'react';
+import { combineDescribedBy, combineLabelledBy, validateDOMAttributes } from '../../shared/component-helper';
+import Button from '../button/Button';
+import { useSliderEvents } from './hooks/useSliderEvents';
+import { useSliderProps } from './hooks/useSliderProps';
+import { clamp, getHumanNumber } from './SliderHelpers';
+export function SliderThumb() {
+  const {
+    values,
+    thumbIndex,
+    isVertical,
+    isReverse,
+    showStatus,
+    attributes,
+    allProps
+  } = useSliderProps();
+  const {
+    id,
+    label,
+    min,
+    max,
+    step,
+    skeleton,
+    disabled,
+    suffix,
+    numberFormat
+  } = allProps;
+  const {
+    onThumbMouseDownHandler,
+    onThumbMouseUpHandler,
+    onThumbBlurHandler,
+    onThumbFocusHandler,
+    onHelperChangeHandler,
+    onHelperFocusHandler
+  } = useSliderEvents();
+
+  const thumbParams = _objectSpread({
+    onBlur: onThumbBlurHandler,
+    onFocus: onThumbFocusHandler
+  }, attributes);
+
+  const helperParams = {};
+
+  if (label) {
+    helperParams['aria-labelledby'] = combineLabelledBy(helperParams, label ? id + '-label' : null);
+  }
+
+  if (showStatus || suffix) {
+    helperParams['aria-describedby'] = combineDescribedBy(helperParams, showStatus ? id + '-status' : null, suffix ? id + '-suffix' : null);
+  }
+
+  validateDOMAttributes(null, helperParams);
+  validateDOMAttributes(allProps, thumbParams);
+  return React.createElement(React.Fragment, null, values.map((value, i) => {
+    const index = thumbIndex.current;
+    let percent = clamp((value - min) * 100 / (max - min));
+
+    if (isReverse) {
+      percent = 100 - percent;
+    }
+
+    const style = {
+      zIndex: index === i ? 4 : 3,
+      [`${isVertical ? 'top' : 'left'}`]: `${percent}%`
+    };
+    const humanNumber = getHumanNumber(value, numberFormat);
+    return React.createElement(React.Fragment, {
+      key: i
+    }, React.createElement("span", {
+      className: "dnb-slider__thumb",
+      style: style
+    }, React.createElement("input", _extends({
+      type: "range",
+      className: "dnb-slider__button-helper",
+      min: min,
+      max: max,
+      step: step,
+      value: value,
+      disabled: disabled,
+      onChange: onHelperChangeHandler,
+      onFocus: onHelperFocusHandler,
+      "aria-valuemin": min,
+      "aria-valuemax": max,
+      "aria-valuenow": value,
+      "aria-valuetext": humanNumber ? humanNumber : undefined,
+      "aria-orientation": isVertical ? 'vertical' : 'horizontal',
+      "data-index": i
+    }, helperParams)), React.createElement(Button, _extends({
+      element: "span",
+      type: "",
+      variant: "secondary",
+      disabled: disabled,
+      skeleton: skeleton,
+      "data-index": i,
+      onMouseDown: onThumbMouseDownHandler,
+      onMouseUp: onThumbMouseUpHandler
+    }, thumbParams))));
+  }));
+}

package/es/components/slider/SliderTrack.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export declare function SliderMainTrack({ children, }: {
+    children: React.ReactNode | React.ReactNode[];
+}): JSX.Element;
+export declare function SliderTrackBefore(): JSX.Element;
+export declare function SliderTrackAfter(): JSX.Element;