@pingux/astro 1.27.0-alpha.24 → 1.27.0-alpha.26

package/lib/components/SwitchField/SwitchField.js

@@ -0,0 +1,203 @@
+import _Object$defineProperty from "@babel/runtime-corejs3/core-js-stable/object/define-property";
+import _Object$defineProperties from "@babel/runtime-corejs3/core-js-stable/object/define-properties";
+import _Object$getOwnPropertyDescriptors from "@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors";
+import _forEachInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/for-each";
+import _Object$getOwnPropertyDescriptor from "@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor";
+import _filterInstanceProperty from "@babel/runtime-corejs3/core-js-stable/instance/filter";
+import _Object$getOwnPropertySymbols from "@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols";
+import _Object$values from "@babel/runtime-corejs3/core-js-stable/object/values";
+import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
+import _Object$keys from "@babel/runtime-corejs3/core-js-stable/object/keys";
+import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
+import _objectWithoutProperties from "@babel/runtime-corejs3/helpers/esm/objectWithoutProperties";
+var _excluded = ["label", "helperText", "isDefaultSelected", "isSelected", "onChange", "value", "name", "id", "isDisabled", "isReadOnly", "isRequired", "hasAutoFocus", "onFocus", "onBlur", "onFocusChange", "onKeyDown", "onKeyUp", "status", "aria-label", "aria-labelledby", "aria-describedby", "aria-details", "controlProps"];
+
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, 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 _context, _context2; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context = ownKeys(Object(source), !0)).call(_context, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context2 = ownKeys(Object(source))).call(_context2, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import React, { forwardRef, useRef, useImperativeHandle } from 'react';
+import PropTypes from 'prop-types';
+import omit from 'lodash/omit';
+import { useToggleState } from '@react-stately/toggle';
+import { useSwitch } from '@react-aria/switch';
+import { usePress } from '@react-aria/interactions';
+import { useField, usePropWarning } from '../../hooks';
+import statuses from '../../utils/devUtils/constants/statuses';
+import Box from '../Box';
+import FieldHelperText from '../FieldHelperText';
+import Label from '../Label';
+import Switch from '../Switch';
+/**
+ * Combines a switch, label, and helper text for a complete, form-ready solution.
+ *
+ * Utilizes [useSwitch](https://react-spectrum.adobe.com/react-aria/useSwitch.html) from React Aria and
+ * [useToggleState](https://react-spectrum.adobe.com/react-stately/useToggleState.html) from React Stately.
+ */
+
+import { jsx as ___EmotionJSX } from "@emotion/react";
+var SwitchField = /*#__PURE__*/forwardRef(function (props, ref) {
+  var label = props.label,
+      helperText = props.helperText,
+      isDefaultSelected = props.isDefaultSelected,
+      isSelected = props.isSelected,
+      onChange = props.onChange,
+      value = props.value,
+      name = props.name,
+      id = props.id,
+      isDisabled = props.isDisabled,
+      isReadOnly = props.isReadOnly,
+      isRequired = props.isRequired,
+      hasAutoFocus = props.hasAutoFocus,
+      onFocus = props.onFocus,
+      onBlur = props.onBlur,
+      onFocusChange = props.onFocusChange,
+      onKeyDown = props.onKeyDown,
+      onKeyUp = props.onKeyUp,
+      status = props.status,
+      ariaLabel = props['aria-label'],
+      ariaLabelledby = props['aria-labelledby'],
+      ariaDescribedby = props['aria-describedby'],
+      ariaDetails = props['aria-details'],
+      controlProps = props.controlProps,
+      others = _objectWithoutProperties(props, _excluded);
+
+  var switchRef = useRef();
+  usePropWarning(props, 'disabled', 'isDisabled');
+  /* istanbul ignore next */
+
+  useImperativeHandle(ref, function () {
+    return switchRef.current;
+  });
+  var state = useToggleState(_objectSpread({
+    defaultSelected: isDefaultSelected
+  }, props));
+
+  var _usePress = usePress({
+    isDisabled: isDisabled
+  }),
+      containerPressProps = _usePress.pressProps;
+
+  var whitelistedProps = omit(props, _Object$keys(others));
+
+  var _useSwitch = useSwitch(_objectSpread({
+    children: label
+  }, whitelistedProps), state, switchRef),
+      inputProps = _useSwitch.inputProps;
+
+  var statusClasses = {
+    isSelected: inputProps.checked
+  };
+
+  var _useField = useField(_objectSpread(_objectSpread(_objectSpread({
+    statusClasses: statusClasses
+  }, containerPressProps), props), {}, {
+    controlProps: _objectSpread(_objectSpread({}, controlProps), inputProps)
+  })),
+      fieldContainerProps = _useField.fieldContainerProps,
+      fieldControlProps = _useField.fieldControlProps,
+      fieldLabelProps = _useField.fieldLabelProps;
+
+  return ___EmotionJSX(Box, fieldContainerProps, ___EmotionJSX(Label, _extends({
+    variant: "forms.switch.label"
+  }, fieldLabelProps), ___EmotionJSX(Switch, {
+    ref: switchRef,
+    inputProps: fieldControlProps
+  }), label), helperText && ___EmotionJSX(FieldHelperText, {
+    status: status
+  }, helperText));
+});
+SwitchField.propTypes = {
+  /** The rendered label for the field. */
+  label: PropTypes.node,
+
+  /** Text rendered below the input. */
+  helperText: PropTypes.node,
+
+  /** If present this prop will cause a help hint to render in the label of the field. */
+  hintText: PropTypes.string,
+
+  /** The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). */
+  id: PropTypes.string,
+
+  /** Whether the element should be selected (uncontrolled). */
+  isDefaultSelected: PropTypes.bool,
+
+  /** Whether the element should be selected (controlled). */
+  isSelected: PropTypes.bool,
+
+  /** The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). */
+  name: PropTypes.string,
+
+  /** Handler that is called when the element's selection state changes. */
+  onChange: PropTypes.func,
+
+  /** The value of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefvalue). */
+  value: PropTypes.string,
+
+  /** A list of class names to apply to the input element. */
+  className: PropTypes.oneOfType([PropTypes.string, PropTypes.arrayOf(PropTypes.string)]),
+
+  /** Whether the field is disabled. */
+  isDisabled: PropTypes.bool,
+
+  /** Whether the input can be selected, but not changed by the user. */
+  isReadOnly: PropTypes.bool,
+
+  /** Whether user input is required on the input before form submission. */
+  isRequired: PropTypes.bool,
+
+  /** Whether the element should receive focus on render. */
+  hasAutoFocus: PropTypes.bool,
+
+  /** Handler that is called when the element receives focus. */
+  onFocus: PropTypes.func,
+
+  /** Handler that is called when the element loses focus. */
+  onBlur: PropTypes.func,
+
+  /** Handler that is called when the element's focus status changes. */
+  onFocusChange: PropTypes.func,
+
+  /** Handler that is called when a key is pressed. */
+  onKeyDown: PropTypes.func,
+
+  /** Handler that is called when a key is released. */
+  onKeyUp: PropTypes.func,
+
+  /** Determines the textarea status indicator and helper text styling. */
+  status: PropTypes.oneOf(_Object$values(statuses)),
+
+  /** Defines a string value that labels the current element. */
+  'aria-label': PropTypes.string,
+
+  /** Identifies the element (or elements) that labels the current element. */
+  'aria-labelledby': PropTypes.string,
+
+  /** Identifies the element (or elements) that describes the object. */
+  'aria-describedby': PropTypes.string,
+
+  /**
+   * Identifies the element (or elements) that provide a detailed, extended description for the
+   * object.
+  */
+  'aria-details': PropTypes.string,
+
+  /** Props object that is spread directly into the root (top-level) element. */
+  containerProps: PropTypes.shape({}),
+
+  /** Props object that is spread directly into the input element. */
+  controlProps: PropTypes.shape({}),
+
+  /** Props object that is spread directly into the label element. */
+  labelProps: PropTypes.shape({})
+};
+SwitchField.defaultProps = {
+  isDisabled: false,
+  isReadOnly: false,
+  isRequired: false,
+  hasAutoFocus: false,
+  status: statuses.DEFAULT
+};
+SwitchField.displayName = 'SwitchField';
+export default SwitchField;

package/lib/components/SwitchField/SwitchField.stories.js

@@ -0,0 +1,127 @@
+import _slicedToArray from "@babel/runtime-corejs3/helpers/esm/slicedToArray";
+import React, { useState } from 'react';
+import { Pressable } from '@react-aria/interactions';
+import SwitchField from '.';
+import statuses from '../../utils/devUtils/constants/statuses';
+import { Tooltip, TooltipTrigger } from '../../index';
+import { jsx as ___EmotionJSX } from "@emotion/react";
+export default {
+  title: 'Form/SwitchField',
+  component: SwitchField,
+  argTypes: {
+    label: {
+      control: {
+        type: 'text'
+      },
+      defaultValue: 'Example Label'
+    },
+    helperText: {
+      control: {
+        type: 'text'
+      }
+    },
+    hintText: {
+      control: {
+        type: 'text'
+      }
+    },
+    value: {
+      defaultValue: 'my-switch'
+    },
+    name: {},
+    className: {},
+    status: {
+      control: {
+        type: 'select',
+        options: statuses
+      },
+      defaultValue: statuses.DEFAULT
+    },
+    isDisabled: {},
+    isRequired: {},
+    isReadOnly: {},
+    isDefaultSelected: {},
+    hasAutoFocus: {},
+    containerProps: {},
+    labelProps: {},
+    controlProps: {},
+    id: {},
+    'aria-label': {
+      control: {
+        type: 'text'
+      }
+    },
+    'aria-labelledby': {
+      control: {
+        type: 'text'
+      }
+    },
+    'aria-describedby': {
+      control: {
+        type: 'text'
+      }
+    },
+    'aria-details': {
+      control: {
+        type: 'text'
+      }
+    },
+    isSelected: {
+      control: {
+        type: 'none'
+      }
+    }
+  }
+};
+export var Default = function Default(args) {
+  return ___EmotionJSX(SwitchField, args);
+};
+export var Controlled = function Controlled() {
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      isSelected = _useState2[0],
+      setIsSelected = _useState2[1];
+
+  return ___EmotionJSX(SwitchField, {
+    isSelected: isSelected,
+    label: "Controlled",
+    onChange: setIsSelected,
+    value: "my-switch"
+  });
+};
+export var DefaultSelected = function DefaultSelected() {
+  return ___EmotionJSX(SwitchField, {
+    isDefaultSelected: true,
+    label: "Default selected",
+    value: "my-switch"
+  });
+};
+export var Disabled = function Disabled() {
+  return ___EmotionJSX(SwitchField, {
+    isDisabled: true,
+    label: "Disabled",
+    value: "my-switch"
+  });
+};
+export var NoVisibleLabel = function NoVisibleLabel() {
+  return ___EmotionJSX(SwitchField, {
+    "aria-label": "my-label",
+    value: "my-switch"
+  });
+};
+export var Required = function Required() {
+  return ___EmotionJSX(SwitchField, {
+    isRequired: true,
+    label: "Required",
+    value: "my-switch"
+  });
+};
+export var WithTooltip = function WithTooltip() {
+  return ___EmotionJSX(TooltipTrigger, {
+    crossOffset: 15,
+    offset: 20
+  }, ___EmotionJSX(Pressable, null, ___EmotionJSX(SwitchField, {
+    "aria-label": "my-label",
+    value: "my-switch"
+  })), ___EmotionJSX(Tooltip, null, "Tooltip Content"));
+};

package/lib/components/SwitchField/SwitchField.test.js

@@ -0,0 +1,101 @@
+import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
+import React from 'react';
+import userEvent from '@testing-library/user-event';
+import axeTest from '../../utils/testUtils/testAxe';
+import { render, screen } from '../../utils/testUtils/testWrapper';
+import SwitchField from './SwitchField';
+import { jsx as ___EmotionJSX } from "@emotion/react";
+var testId = 'test-switch';
+var defaultProps = {
+  label: 'Example label',
+  'data-testid': testId
+};
+
+var getComponent = function getComponent() {
+  var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return render(___EmotionJSX(SwitchField, _extends({}, defaultProps, props)));
+}; // Need to be added to each test file to test accessibility using axe.
+
+
+axeTest(getComponent);
+test('renders Switch component', function () {
+  getComponent({
+    'aria-label': 'test'
+  });
+  var switchComponent = screen.getByTestId(testId);
+  screen.getByRole('switch');
+  expect(switchComponent).toBeInstanceOf(HTMLDivElement);
+  expect(switchComponent).toBeInTheDocument();
+});
+test('renders label', function () {
+  getComponent();
+  var label = screen.getByText(defaultProps.label);
+  expect(label).toBeInTheDocument();
+});
+test('switch toggles on click', function () {
+  var onChange = jest.fn();
+  getComponent({
+    onChange: onChange
+  });
+  var input = screen.getByRole('switch');
+  expect(onChange).not.toHaveBeenCalled();
+  userEvent.click(input);
+  expect(input).toBeChecked();
+  expect(onChange).toHaveBeenNthCalledWith(1, true);
+  userEvent.click(input);
+  expect(input).not.toBeChecked();
+  expect(onChange).toHaveBeenNthCalledWith(2, false);
+});
+test('isDisabled disables switch functionality', function () {
+  var onChange = jest.fn();
+  getComponent({
+    isDisabled: true,
+    onChange: onChange
+  });
+  var input = screen.getByRole('switch');
+  userEvent.click(input);
+  expect(onChange).not.toHaveBeenCalled();
+});
+test('isDisabled adds disabled styles to label and switch', function () {
+  getComponent({
+    isDisabled: true
+  });
+  var label = screen.getByText(defaultProps.label);
+  expect(label).toHaveClass('is-disabled');
+  var switchComponent = screen.getByRole('switch');
+  expect(switchComponent).toHaveClass('is-disabled');
+});
+test('does not have isDisabled styling without isDisabled prop', function () {
+  getComponent();
+  var label = screen.getByText(defaultProps.label);
+  expect(label).not.toHaveClass('is-disabled');
+  var switchComponent = screen.getByRole('switch');
+  expect(switchComponent).not.toHaveClass('is-disabled');
+});
+test('Switch focuses when tabbed to', function () {
+  getComponent();
+  var input = screen.getByRole('switch');
+  userEvent.tab();
+  expect(input).toHaveFocus();
+});
+test('Switch toggles with keyboard', function () {
+  var onChange = jest.fn();
+  getComponent({
+    onChange: onChange
+  });
+  var input = screen.getByRole('switch');
+  expect(input).not.toHaveFocus();
+  expect(onChange).not.toHaveBeenCalled();
+  userEvent.tab();
+  expect(input).toHaveFocus();
+  userEvent.type(input, '{space}');
+  expect(onChange).toHaveBeenCalled();
+});
+test('switch field with helper text', function () {
+  var helperText = 'helper text';
+  getComponent({
+    helperText: helperText
+  });
+  var helper = screen.getByText(helperText);
+  expect(helper).toBeInTheDocument();
+});

package/lib/components/SwitchField/index.js

@@ -0,0 +1 @@
+export { default } from './SwitchField';

package/lib/components/Tab/Tab.js

@@ -0,0 +1,146 @@
+import _extends from "@babel/runtime-corejs3/helpers/esm/extends";
+import _objectWithoutProperties from "@babel/runtime-corejs3/helpers/esm/objectWithoutProperties";
+var _excluded = ["icon", "isDisabled", "separator", "tabLabelProps", "tabLineProps", "content", "titleAttr", "title"];
+import React, { forwardRef, useContext, useImperativeHandle, useRef } from 'react';
+import PropTypes from 'prop-types';
+import { useTab } from '@react-aria/tabs';
+import { useFocusRing } from '@react-aria/focus';
+import { Pressable, useHover } from '@react-aria/interactions';
+import { mergeProps } from '@react-aria/utils';
+import { Item as Tab } from '@react-stately/collections';
+import { TabsContext } from '../Tabs';
+import { useStatusClasses, usePropWarning } from '../../hooks';
+import ORIENTATION from '../../utils/devUtils/constants/orientation';
+import TabPicker from '../TabPicker';
+import { Box, Text, TooltipTrigger, Tooltip } from '../..';
+/**
+ * Tab control for dividing up closely-related content.
+ * Typically used as a child of the Tabs component.
+ */
+
+import { jsx as ___EmotionJSX } from "@emotion/react";
+export var CollectionTab = /*#__PURE__*/forwardRef(function (props, ref) {
+  var className = props.className,
+      item = props.item,
+      tabsDisabled = props.isDisabled,
+      orientation = props.orientation,
+      mode = props.mode,
+      slots = props.slots,
+      tooltipTriggerProps = props.tooltipTriggerProps;
+  var key = item.key,
+      rendered = item.rendered,
+      itemProps = item.props;
+
+  var icon = itemProps.icon,
+      tabDisabled = itemProps.isDisabled,
+      separator = itemProps.separator,
+      tabLabelProps = itemProps.tabLabelProps,
+      tabLineProps = itemProps.tabLineProps,
+      content = itemProps.content,
+      titleAttr = itemProps.titleAttr,
+      title = itemProps.title,
+      otherItemProps = _objectWithoutProperties(itemProps, _excluded);
+
+  var state = useContext(TabsContext);
+  var isDisabled = tabsDisabled || tabDisabled || state.disabledKeys.has(key);
+  var isSelected = state.selectedKey === key;
+
+  var _useFocusRing = useFocusRing(),
+      isFocusVisible = _useFocusRing.isFocusVisible,
+      focusProps = _useFocusRing.focusProps;
+
+  var _useHover = useHover({}),
+      hoverProps = _useHover.hoverProps,
+      isHovered = _useHover.isHovered;
+
+  var _useStatusClasses = useStatusClasses(className, {
+    'is-focused': isFocusVisible,
+    'is-vertical': orientation === ORIENTATION.VERTICAL,
+    'is-horizontal': orientation === ORIENTATION.HORIZONTAL,
+    isDisabled: isDisabled,
+    isHovered: isHovered,
+    isSelected: isSelected
+  }),
+      classNames = _useStatusClasses.classNames;
+
+  var tabRef = useRef();
+  usePropWarning(props, 'disabled', 'isDisabled');
+  /* istanbul ignore next */
+
+  useImperativeHandle(ref, function () {
+    return tabRef.current;
+  });
+
+  var _useTab = useTab({
+    key: key,
+    isDisabled: isDisabled
+  }, state, tabRef),
+      tabProps = _useTab.tabProps;
+
+  var tab = ___EmotionJSX(Box, {
+    isRow: true
+  }, slots === null || slots === void 0 ? void 0 : slots.beforeTab, ___EmotionJSX(Box, _extends({
+    className: classNames,
+    variant: "tab"
+  }, mergeProps(focusProps, hoverProps, tabProps), otherItemProps, {
+    ref: tabRef,
+    title: titleAttr || undefined
+  }), icon, ___EmotionJSX(Text, _extends({
+    variant: "tabLabel"
+  }, tabLabelProps), rendered), isSelected && !isDisabled && ___EmotionJSX(TabLine, tabLineProps)), slots === null || slots === void 0 ? void 0 : slots.afterTab);
+
+  if (mode === 'list' && itemProps.list) {
+    return ___EmotionJSX(TabPicker, _extends({
+      ref: tabRef,
+      className: classNames,
+      items: itemProps.list,
+      state: state,
+      item: item
+    }, mergeProps(focusProps, hoverProps, tabProps), otherItemProps));
+  }
+
+  if (mode === 'tooltip') {
+    return ___EmotionJSX(React.Fragment, null, separator, ___EmotionJSX(TooltipTrigger, _extends({}, tooltipTriggerProps, {
+      isOpen: isHovered || isFocusVisible
+    }), ___EmotionJSX(Pressable, null, ___EmotionJSX("span", {
+      variant: "quiet"
+    }, tab)), ___EmotionJSX(Tooltip, null, itemProps.textValue || itemProps.title)));
+  }
+
+  return tab;
+});
+CollectionTab.displayName = 'CollectionTab';
+CollectionTab.propTypes = {
+  isDisabled: PropTypes.bool,
+  item: PropTypes.shape({
+    key: PropTypes.string,
+    props: PropTypes.shape({
+      icon: PropTypes.shape({}),
+      isDisabled: PropTypes.bool,
+      textValue: PropTypes.string,
+      tabLineProps: PropTypes.shape({}),
+      tabLabelProps: PropTypes.shape({}),
+      content: PropTypes.shape({}),
+      titleAttr: PropTypes.string,
+      title: PropTypes.oneOfType([PropTypes.element, PropTypes.string, PropTypes.object]),
+      separator: PropTypes.oneOfType([PropTypes.element, PropTypes.bool]),
+      list: PropTypes.arrayOf(PropTypes.shape({}))
+    }),
+    rendered: PropTypes.node
+  }),
+  mode: PropTypes.oneOf(['default', 'tooltip', 'list']),
+  orientation: PropTypes.oneOf(['horizontal', 'vertical']),
+  tooltipTriggerProps: PropTypes.shape({}),
+  slots: PropTypes.shape({
+    beforeTab: PropTypes.node,
+    afterTab: PropTypes.node
+  })
+};
+export var TabLine = function TabLine(props) {
+  return ___EmotionJSX(Box, _extends({
+    role: "presentation",
+    variant: "tabLine"
+  }, props));
+}; // Export Item as default Tab for simplicity, convert to CollectionTab within Tabs component
+
+export default Tab;

package/lib/components/Tab/index.js

@@ -0,0 +1,2 @@
+export { default } from './Tab';
+export * from './Tab';