@atlaskit/react-select 2.2.0 → 2.3.0

package/dist/es2019/emotion/components/live-region.js

@@ -0,0 +1,180 @@
+/* eslint-disable @atlaskit/platform/ensure-feature-flag-prefix */
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ * @jsxFrag React.Fragment
+ */
+import React, { Fragment, useMemo, useRef } from 'react';
+
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled
+import { jsx } from '@emotion/react';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { defaultAriaLiveMessages } from '../../accessibility';
+import A11yText from './internal/a11y-text';
+
+// ==============================
+// Root Container
+// ==============================
+
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+const LiveRegion = props => {
+  const {
+    ariaSelection,
+    focusedOption,
+    focusedValue,
+    focusableOptions,
+    isFocused,
+    selectValue,
+    selectProps,
+    id,
+    isAppleDevice
+  } = props;
+  const {
+    ariaLiveMessages,
+    getOptionLabel,
+    inputValue,
+    isMulti,
+    isOptionDisabled,
+    isSearchable,
+    label,
+    menuIsOpen,
+    options,
+    screenReaderStatus,
+    tabSelectsValue,
+    isLoading
+  } = selectProps;
+  const ariaLabel = selectProps['aria-label'] || label;
+  const ariaLive = selectProps['aria-live'];
+
+  // for safari, we will use minimum support from aria-live region
+  const isA11yImprovementEnabled = fg('design_system_select-a11y-improvement') && !isAppleDevice;
+
+  // Update aria live message configuration when prop changes
+  const messages = useMemo(() => ({
+    ...defaultAriaLiveMessages,
+    ...(ariaLiveMessages || {})
+  }), [ariaLiveMessages]);
+
+  // Update aria live selected option when prop changes
+  const ariaSelected = useMemo(() => {
+    let message = '';
+    if (isA11yImprovementEnabled && menuIsOpen) {
+      // we don't need to have selected message when the menu is open
+      return '';
+    }
+    if (ariaSelection && messages.onChange) {
+      const {
+        option,
+        options: selectedOptions,
+        removedValue,
+        removedValues,
+        value
+      } = ariaSelection;
+      // select-option when !isMulti does not return option so we assume selected option is value
+      const asOption = val => !Array.isArray(val) ? val : null;
+
+      // If there is just one item from the action then get its label
+      const selected = removedValue || option || asOption(value);
+      const label = selected ? getOptionLabel(selected) : '';
+
+      // If there are multiple items from the action then return an array of labels
+      const multiSelected = selectedOptions || removedValues || undefined;
+      const labels = multiSelected ? multiSelected.map(getOptionLabel) : [];
+      if (isA11yImprovementEnabled && !label && !labels.length) {
+        // return empty string if no labels provided
+        return '';
+      }
+      const onChangeProps = {
+        // multiSelected items are usually items that have already been selected
+        // or set by the user as a default value so we assume they are not disabled
+        isDisabled: selected && isOptionDisabled(selected, selectValue),
+        label,
+        labels,
+        ...ariaSelection
+      };
+      message = messages.onChange(onChangeProps);
+    }
+    return message;
+  }, [ariaSelection, messages, isOptionDisabled, selectValue, getOptionLabel, isA11yImprovementEnabled, menuIsOpen]);
+  const prevInputValue = useRef('');
+  const ariaFocused = useMemo(() => {
+    let focusMsg = '';
+    const focused = focusedOption || focusedValue;
+    const isSelected = !!(focusedOption && selectValue && selectValue.includes(focusedOption));
+    if (inputValue === prevInputValue.current && isA11yImprovementEnabled) {
+      // only announce focus option when searching when ff is on and the input value changed
+      // for safari, we will announce for all
+      return '';
+    }
+    if (focused && messages.onFocus) {
+      const onFocusProps = {
+        focused,
+        label: getOptionLabel(focused),
+        isDisabled: isOptionDisabled(focused, selectValue),
+        isSelected,
+        options: focusableOptions,
+        context: focused === focusedOption ? 'menu' : 'value',
+        selectValue,
+        isMulti
+      };
+      focusMsg = messages.onFocus(onFocusProps);
+    }
+    prevInputValue.current = inputValue;
+    return focusMsg;
+  }, [inputValue, focusedOption, focusedValue, getOptionLabel, isOptionDisabled, messages, focusableOptions, selectValue, isA11yImprovementEnabled, isMulti]);
+  const ariaResults = useMemo(() => {
+    let resultsMsg = '';
+    if (menuIsOpen && options.length && !isLoading && messages.onFilter) {
+      const resultsMessage = screenReaderStatus({
+        count: focusableOptions.length
+      });
+      resultsMsg = messages.onFilter({
+        inputValue,
+        resultsMessage
+      });
+    }
+    return resultsMsg;
+  }, [focusableOptions, inputValue, menuIsOpen, messages, options, screenReaderStatus, isLoading]);
+  const isInitialFocus = (ariaSelection === null || ariaSelection === void 0 ? void 0 : ariaSelection.action) === 'initial-input-focus';
+  const ariaGuidance = useMemo(() => {
+    if (fg('design_system_select-a11y-improvement')) {
+      // don't announce guidance at all when ff is on
+      return '';
+    }
+    let guidanceMsg = '';
+    if (messages.guidance) {
+      const context = focusedValue ? 'value' : menuIsOpen ? 'menu' : 'input';
+      guidanceMsg = messages.guidance({
+        'aria-label': ariaLabel,
+        context,
+        isDisabled: focusedOption && isOptionDisabled(focusedOption, selectValue),
+        isMulti,
+        isSearchable,
+        tabSelectsValue,
+        isInitialFocus
+      });
+    }
+    return guidanceMsg;
+  }, [ariaLabel, focusedOption, focusedValue, isMulti, isOptionDisabled, isSearchable, menuIsOpen, messages, selectValue, tabSelectsValue, isInitialFocus]);
+  const ScreenReaderText = jsx(Fragment, null, jsx("span", {
+    id: "aria-selection"
+  }, ariaSelected), jsx("span", {
+    id: "aria-results"
+  }, ariaResults), !fg('design_system_select-a11y-improvement') && jsx(React.Fragment, null, jsx("span", {
+    id: "aria-focused"
+  }, ariaFocused), jsx("span", {
+    id: "aria-guidance"
+  }, ariaGuidance)));
+  return jsx(Fragment, null, jsx(A11yText, {
+    id: id
+  }, isInitialFocus && ScreenReaderText), jsx(A11yText, {
+    "aria-live": ariaLive // Should be undefined by default unless a specific use case requires it
+    ,
+    "aria-atomic": fg('design_system_select-a11y-improvement') ? undefined : 'false',
+    "aria-relevant": fg('design_system_select-a11y-improvement') ? undefined : 'additions text',
+    role: fg('design_system_select-a11y-improvement') ? 'status' : 'log'
+  }, isFocused && !isInitialFocus && ScreenReaderText));
+};
+
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export default LiveRegion;

package/dist/es2019/emotion/components/menu.js

@@ -0,0 +1,452 @@
+import _extends from "@babel/runtime/helpers/extends";
+/**
+ * @jsxRuntime classic
+ * @jsx jsx
+ */
+import { createContext, useCallback, useContext, useMemo, useRef, useState } from 'react';
+
+// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled
+import { jsx } from '@emotion/react';
+import { autoUpdate } from '@floating-ui/dom';
+import { createPortal } from 'react-dom';
+import useLayoutEffect from 'use-isomorphic-layout-effect';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { Text } from '@atlaskit/primitives';
+import { animatedScrollTo, getBoundingClientObj, getScrollParent, getScrollTop, getStyleProps, normalizedHeight, scrollTo } from '../../utils';
+
+// ==============================
+// Menu
+// ==============================
+
+// Get Menu Placement
+// ------------------------------
+
+function getMenuPlacement({
+  maxHeight: preferredMaxHeight,
+  menuEl,
+  minHeight,
+  placement: preferredPlacement,
+  shouldScroll,
+  isFixedPosition,
+  controlHeight
+}) {
+  const scrollParent = getScrollParent(menuEl);
+  const defaultState = {
+    placement: 'bottom',
+    maxHeight: preferredMaxHeight
+  };
+
+  // something went wrong, return default state
+  if (!menuEl || !menuEl.offsetParent) {
+    return defaultState;
+  }
+
+  // we can't trust `scrollParent.scrollHeight` --> it may increase when
+  // the menu is rendered
+  const {
+    height: scrollHeight,
+    top: scrollParentTop
+  } = scrollParent.getBoundingClientRect();
+  const {
+    bottom: menuBottom,
+    height: menuHeight,
+    top: menuTop
+  } = menuEl.getBoundingClientRect();
+  const {
+    top: containerTop
+  } = menuEl.offsetParent.getBoundingClientRect();
+  const viewHeight = isFixedPosition ? window.innerHeight : normalizedHeight(scrollParent);
+  const scrollTop = getScrollTop(scrollParent);
+  // use menuTop - scrollParentTop for the actual top space of menu in the scroll container
+  const menuTopFromParent = fg('design-system-select-fix-placement') ? menuTop - scrollParentTop : menuTop;
+  const marginBottom = parseInt(getComputedStyle(menuEl).marginBottom, 10);
+  const marginTop = parseInt(getComputedStyle(menuEl).marginTop, 10);
+  const viewSpaceAbove = containerTop - marginTop;
+  const viewSpaceBelow = viewHeight - menuTopFromParent;
+  const scrollSpaceAbove = viewSpaceAbove + scrollTop;
+  const scrollSpaceBelow = scrollHeight - scrollTop - menuTopFromParent;
+  const scrollDown = menuBottom - viewHeight + scrollTop + marginBottom;
+  const scrollUp = scrollTop + menuTop - marginTop;
+  const scrollDuration = 160;
+  switch (preferredPlacement) {
+    case 'auto':
+    case 'bottom':
+      // 1: the menu will fit, do nothing
+      if (viewSpaceBelow >= menuHeight) {
+        return {
+          placement: 'bottom',
+          maxHeight: preferredMaxHeight
+        };
+      }
+
+      // 2: the menu will fit, if scrolled
+      if (scrollSpaceBelow >= menuHeight && !isFixedPosition) {
+        if (shouldScroll) {
+          animatedScrollTo(scrollParent, scrollDown, scrollDuration);
+        }
+        return {
+          placement: 'bottom',
+          maxHeight: preferredMaxHeight
+        };
+      }
+
+      // 3: the menu will fit, if constrained
+      if (!isFixedPosition && scrollSpaceBelow >= minHeight || isFixedPosition && viewSpaceBelow >= minHeight) {
+        if (shouldScroll) {
+          animatedScrollTo(scrollParent, scrollDown, scrollDuration);
+        }
+
+        // we want to provide as much of the menu as possible to the user,
+        // so give them whatever is available below rather than the minHeight.
+        const constrainedHeight = isFixedPosition ? viewSpaceBelow - marginBottom : scrollSpaceBelow - marginBottom;
+        return {
+          placement: 'bottom',
+          maxHeight: constrainedHeight
+        };
+      }
+
+      // 4. Forked beviour when there isn't enough space below
+
+      // AUTO: flip the menu, render above
+      if (preferredPlacement === 'auto' || isFixedPosition) {
+        // may need to be constrained after flipping
+        let constrainedHeight = preferredMaxHeight;
+        const spaceAbove = isFixedPosition ? viewSpaceAbove : scrollSpaceAbove;
+        if (spaceAbove >= minHeight) {
+          constrainedHeight = Math.min(spaceAbove - marginBottom - controlHeight, preferredMaxHeight);
+        }
+        return {
+          placement: 'top',
+          maxHeight: constrainedHeight
+        };
+      }
+
+      // BOTTOM: allow browser to increase scrollable area and immediately set scroll
+      if (preferredPlacement === 'bottom') {
+        if (shouldScroll) {
+          scrollTo(scrollParent, scrollDown);
+        }
+        return {
+          placement: 'bottom',
+          maxHeight: preferredMaxHeight
+        };
+      }
+      break;
+    case 'top':
+      // 1: the menu will fit, do nothing
+      if (viewSpaceAbove >= menuHeight) {
+        return {
+          placement: 'top',
+          maxHeight: preferredMaxHeight
+        };
+      }
+
+      // 2: the menu will fit, if scrolled
+      if (scrollSpaceAbove >= menuHeight && !isFixedPosition) {
+        if (shouldScroll) {
+          animatedScrollTo(scrollParent, scrollUp, scrollDuration);
+        }
+        return {
+          placement: 'top',
+          maxHeight: preferredMaxHeight
+        };
+      }
+
+      // 3: the menu will fit, if constrained
+      if (!isFixedPosition && scrollSpaceAbove >= minHeight || isFixedPosition && viewSpaceAbove >= minHeight) {
+        let constrainedHeight = preferredMaxHeight;
+
+        // we want to provide as much of the menu as possible to the user,
+        // so give them whatever is available below rather than the minHeight.
+        if (!isFixedPosition && scrollSpaceAbove >= minHeight || isFixedPosition && viewSpaceAbove >= minHeight) {
+          constrainedHeight = isFixedPosition ? viewSpaceAbove - marginTop : scrollSpaceAbove - marginTop;
+        }
+        if (shouldScroll) {
+          animatedScrollTo(scrollParent, scrollUp, scrollDuration);
+        }
+        return {
+          placement: 'top',
+          maxHeight: constrainedHeight
+        };
+      }
+
+      // 4. not enough space, the browser WILL NOT increase scrollable area when
+      // absolutely positioned element rendered above the viewport (only below).
+      // Flip the menu, render below
+      return {
+        placement: 'bottom',
+        maxHeight: preferredMaxHeight
+      };
+    default:
+      throw new Error(`Invalid placement provided "${preferredPlacement}".`);
+  }
+  return defaultState;
+}
+
+// Menu Component
+// ------------------------------
+
+function alignToControl(placement) {
+  const placementToCSSProp = {
+    bottom: 'top',
+    top: 'bottom'
+  };
+  return placement ? placementToCSSProp[placement] : 'bottom';
+}
+const coercePlacement = p => p === 'auto' ? 'bottom' : p;
+export const menuCSS = ({
+  placement
+}) => ({
+  label: 'menu',
+  [alignToControl(placement)]: '100%',
+  position: 'absolute',
+  width: '100%',
+  zIndex: 1,
+  borderRadius: "var(--ds-border-radius, 4px)",
+  marginBottom: "var(--ds-space-100, 8px)",
+  marginTop: "var(--ds-space-100, 8px)",
+  backgroundColor: "var(--ds-surface-overlay, white)",
+  boxShadow: "var(--ds-shadow-overlay, 0 0 0 1px hsl(0deg 0% 0% / 10%), 0 4px 11px hsl(0deg 0% 0% / 10%))"
+});
+const PortalPlacementContext = /*#__PURE__*/createContext(null);
+
+// NOTE: internal only
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export const MenuPlacer = props => {
+  const {
+    children,
+    minMenuHeight,
+    maxMenuHeight,
+    menuPlacement,
+    menuPosition,
+    menuShouldScrollIntoView
+  } = props;
+  const {
+    setPortalPlacement
+  } = useContext(PortalPlacementContext) || {};
+  const ref = useRef(null);
+  const [maxHeight, setMaxHeight] = useState(maxMenuHeight);
+  const [placement, setPlacement] = useState(null);
+  // The minimum height of the control
+  const controlHeight = 38;
+  useLayoutEffect(() => {
+    const menuEl = ref.current;
+    if (!menuEl) {
+      return;
+    }
+
+    // DO NOT scroll if position is fixed
+    const isFixedPosition = menuPosition === 'fixed';
+    const shouldScroll = menuShouldScrollIntoView && !isFixedPosition;
+    const state = getMenuPlacement({
+      maxHeight: maxMenuHeight,
+      menuEl,
+      minHeight: minMenuHeight,
+      placement: menuPlacement,
+      shouldScroll,
+      isFixedPosition,
+      controlHeight
+    });
+    setMaxHeight(state.maxHeight);
+    setPlacement(state.placement);
+    setPortalPlacement === null || setPortalPlacement === void 0 ? void 0 : setPortalPlacement(state.placement);
+  }, [maxMenuHeight, menuPlacement, menuPosition, menuShouldScrollIntoView, minMenuHeight, setPortalPlacement, controlHeight]);
+  return children({
+    ref,
+    placerProps: {
+      ...props,
+      placement: placement || coercePlacement(menuPlacement),
+      maxHeight
+    }
+  });
+};
+const Menu = props => {
+  const {
+    children,
+    innerRef,
+    innerProps
+  } = props;
+  return jsx("div", _extends({}, getStyleProps(props, 'menu', {
+    menu: true
+  }), {
+    ref: innerRef
+  }, innerProps), children);
+};
+
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export default Menu;
+
+// ==============================
+// Menu List
+// ==============================
+
+export const menuListCSS = ({
+  maxHeight
+}) => ({
+  maxHeight,
+  overflowY: 'auto',
+  position: 'relative',
+  // required for offset[Height, Top] > keyboard scroll
+  WebkitOverflowScrolling: 'touch',
+  paddingTop: "var(--ds-space-100, 8px)",
+  paddingBottom: "var(--ds-space-100, 8px)"
+});
+
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export const MenuList = props => {
+  const {
+    children,
+    innerProps,
+    innerRef,
+    isMulti
+  } = props;
+  return jsx("div", _extends({}, getStyleProps(props, 'menuList', {
+    'menu-list': true,
+    'menu-list--is-multi': isMulti
+  }), {
+    ref: innerRef
+  }, innerProps, {
+    tabIndex: -1
+  }), children);
+};
+
+// ==============================
+// Menu Notices
+// ==============================
+
+const noticeCSS = ({}) => ({
+  textAlign: 'center',
+  padding: `${"var(--ds-space-100, 8px)"} ${"var(--ds-space-150, 12px)"}`
+});
+export const noOptionsMessageCSS = noticeCSS;
+export const loadingMessageCSS = noticeCSS;
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export const NoOptionsMessage = ({
+  children = 'No options',
+  innerProps,
+  ...restProps
+}) => {
+  return jsx("div", _extends({}, getStyleProps({
+    ...restProps,
+    children,
+    innerProps
+  }, 'noOptionsMessage', {
+    'menu-notice': true,
+    'menu-notice--no-options': true
+  }), {
+    // eslint-disable-next-line jsx-a11y/role-has-required-aria-props
+    role: "option"
+  }, innerProps), jsx(Text, {
+    color: "color.text.subtle"
+  }, children));
+};
+
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export const LoadingMessage = ({
+  children = 'Loading...',
+  innerProps,
+  ...restProps
+}) => {
+  return jsx("div", _extends({}, getStyleProps({
+    ...restProps,
+    children,
+    innerProps
+  }, 'loadingMessage', {
+    'menu-notice': true,
+    'menu-notice--loading': true
+  }), innerProps, {
+    // eslint-disable-next-line jsx-a11y/role-has-required-aria-props
+    role: "option"
+  }), jsx(Text, {
+    color: "color.text.subtle"
+  }, children));
+};
+
+// ==============================
+// Menu Portal
+// ==============================
+
+export const menuPortalCSS = ({
+  rect,
+  offset,
+  position
+}) => ({
+  left: rect.left,
+  position: position,
+  top: offset,
+  width: rect.width,
+  zIndex: 1
+});
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export const MenuPortal = props => {
+  const {
+    appendTo,
+    children,
+    controlElement,
+    innerProps,
+    menuPlacement,
+    menuPosition
+  } = props;
+  const menuPortalRef = useRef(null);
+  const cleanupRef = useRef(null);
+  const [placement, setPortalPlacement] = useState(coercePlacement(menuPlacement));
+  const portalPlacementContext = useMemo(() => ({
+    setPortalPlacement
+  }), []);
+  const [computedPosition, setComputedPosition] = useState(null);
+  const updateComputedPosition = useCallback(() => {
+    if (!controlElement) {
+      return;
+    }
+    const rect = getBoundingClientObj(controlElement);
+    const scrollDistance = menuPosition === 'fixed' ? 0 : window.pageYOffset;
+    const offset = rect[placement] + scrollDistance;
+    if (offset !== (computedPosition === null || computedPosition === void 0 ? void 0 : computedPosition.offset) || rect.left !== (computedPosition === null || computedPosition === void 0 ? void 0 : computedPosition.rect.left) || rect.width !== (computedPosition === null || computedPosition === void 0 ? void 0 : computedPosition.rect.width)) {
+      setComputedPosition({
+        offset,
+        rect
+      });
+    }
+  }, [controlElement, menuPosition, placement, computedPosition === null || computedPosition === void 0 ? void 0 : computedPosition.offset, computedPosition === null || computedPosition === void 0 ? void 0 : computedPosition.rect.left, computedPosition === null || computedPosition === void 0 ? void 0 : computedPosition.rect.width]);
+  useLayoutEffect(() => {
+    updateComputedPosition();
+  }, [updateComputedPosition]);
+  const runAutoUpdate = useCallback(() => {
+    if (typeof cleanupRef.current === 'function') {
+      cleanupRef.current();
+      cleanupRef.current = null;
+    }
+    if (controlElement && menuPortalRef.current) {
+      cleanupRef.current = autoUpdate(controlElement, menuPortalRef.current, updateComputedPosition, {
+        elementResize: 'ResizeObserver' in window
+      });
+    }
+  }, [controlElement, updateComputedPosition]);
+  useLayoutEffect(() => {
+    runAutoUpdate();
+  }, [runAutoUpdate]);
+  const setMenuPortalElement = useCallback(menuPortalElement => {
+    menuPortalRef.current = menuPortalElement;
+    runAutoUpdate();
+  }, [runAutoUpdate]);
+
+  // bail early if required elements aren't present
+  if (!appendTo && menuPosition !== 'fixed' || !computedPosition) {
+    return null;
+  }
+
+  // same wrapper element whether fixed or portalled
+  const menuWrapper = jsx("div", _extends({
+    ref: setMenuPortalElement
+  }, getStyleProps({
+    ...props,
+    offset: computedPosition.offset,
+    position: menuPosition,
+    rect: computedPosition.rect
+  }, 'menuPortal', {
+    'menu-portal': true
+  }), innerProps), children);
+  return jsx(PortalPlacementContext.Provider, {
+    value: portalPlacementContext
+  }, appendTo ? /*#__PURE__*/createPortal(menuWrapper, appendTo) : menuWrapper);
+};