@primer/components 0.0.0-20211030172251 → 0.0.0-20211030173748

package/lib-esm/ChoiceFieldset/ChoiceFieldLabel.js

@@ -0,0 +1,20 @@
+import React, { useContext } from 'react';
+import ChoiceFieldsetListContext from './ChoiceFieldsetListContext';
+
+const ChoiceFieldLabel = ({
+  children
+}) => {
+  const choiceFieldsetListContext = useContext(ChoiceFieldsetListContext);
+
+  if (choiceFieldsetListContext === null) {
+    throw new Error('ChoiceFieldsetListContext returned null');
+  }
+
+  const {
+    fieldComponent: FieldComponent
+  } = choiceFieldsetListContext;
+  return /*#__PURE__*/React.createElement(FieldComponent.Label, null, children);
+};
+
+ChoiceFieldLabel.displayName = "ChoiceFieldLabel";
+export default ChoiceFieldLabel;

package/lib-esm/ChoiceFieldset/ChoiceFieldset.d.ts

@@ -0,0 +1,57 @@
+import React, { ComponentProps } from 'react';
+import { FormValidationStatus } from '../utils/types/FormValidationStatus';
+export interface ChoiceFieldsetProps<T = Record<string, FormValidationStatus>> {
+    children?: React.ReactNode;
+    /**
+     * The unique identifier for this fieldset. Used to associate the validation text and caption text with the fieldset
+     */
+    id?: string;
+    /**
+     * The unique identifier used to associate the inputs with eachother
+     */
+    name?: string;
+    /**
+     * The callback that is called when a user toggles a choice on or off
+     */
+    onSelect?: (selectedValues?: string[]) => void;
+    /**
+     * Whether this field must have a value for the user to complete their task
+     */
+    required?: boolean;
+    /**
+     * A map of validation statuses and their associated validation keys. When one of the validation keys is passed to the `validationResult` prop,
+     * the associated validation message will be rendered in the correct style
+     */
+    validationMap?: T;
+    /**
+     * The key of the validation message to show
+     */
+    validationResult?: keyof T;
+}
+export interface ChoiceFieldsetContext extends ChoiceFieldsetProps {
+    captionId: string;
+    validationMessageId: string;
+}
+declare const Slot: React.FC<{
+    name: "Caption" | "ChoiceList" | "Legend" | "Validation";
+    children: React.ReactNode;
+}>;
+export { Slot };
+declare const ChoiceFieldset: <T extends Record<string, FormValidationStatus>>({ children, id, name, onSelect, required, validationMap, validationResult }: ChoiceFieldsetProps<T>) => JSX.Element;
+export declare type InputFieldComponentProps = ComponentProps<typeof ChoiceFieldset>;
+export type { ChoiceFieldsetListProps } from './ChoiceFieldsetList';
+export type { ChoiceFieldsetLegendProps } from './ChoiceFieldsetLegend';
+export type { ChoiceFieldProps } from './ChoiceField';
+declare const _default: (<T extends Record<string, FormValidationStatus>>({ children, id, name, onSelect, required, validationMap, validationResult }: ChoiceFieldsetProps<T>) => JSX.Element) & {
+    ChoiceField: React.FC<import("./ChoiceField").ChoiceFieldProps> & {
+        Caption: React.FC<{}>;
+        Input: React.FC<import("./ChoiceFieldInput").ChoiceFieldInputProps>;
+        Label: React.FC<{}>;
+        LeadingVisual: React.FC<{}>;
+    };
+    Caption: React.FC<{}>;
+    Legend: React.FC<import("./ChoiceFieldsetLegend").ChoiceFieldsetLegendProps>;
+    List: React.FC<import("./ChoiceFieldsetList").ChoiceFieldsetListProps>;
+    Validation: React.FC<import("./ChoiceFieldsetValidation").ChoiceFieldsetValidationProps>;
+};
+export default _default;

package/lib-esm/ChoiceFieldset/ChoiceFieldset.js

@@ -0,0 +1,72 @@
+import React from 'react';
+import { Box } from '..';
+import createSlots from '../utils/create-slots';
+import { uniqueId } from '../utils/uniqueId';
+import ValidationAnimationContainer from '../_InputField/ValidationAnimationContainer';
+import InputValidation from '../_InputValidation';
+import ChoiceField from './ChoiceField';
+import ChoiceFieldsetCaption from './ChoiceFieldsetCaption';
+import ChoiceFieldsetLegend from './ChoiceFieldsetLegend';
+import ChoiceFieldsetList from './ChoiceFieldsetList';
+import ChoiceFieldsetValidation from './ChoiceFieldsetValidation';
+const {
+  Slots,
+  Slot
+} = createSlots(['Caption', 'ChoiceList', 'Legend', 'Validation']);
+export { Slot };
+
+const ChoiceFieldset = ({
+  children,
+  id,
+  name,
+  onSelect,
+  required,
+  validationMap,
+  validationResult
+}) => {
+  var _React$Children$map;
+
+  const fieldsetId = id || uniqueId();
+  const validationChildren = (_React$Children$map = React.Children.map(children, child => /*#__PURE__*/React.isValidElement(child) && child.type === ChoiceFieldsetValidation ? child : null)) === null || _React$Children$map === void 0 ? void 0 : _React$Children$map.filter(Boolean);
+  const validationChildToRender = validationChildren === null || validationChildren === void 0 ? void 0 : validationChildren.find(child => child.props.validationKey === validationResult);
+  const captionId = `${fieldsetId}-caption`;
+  const validationMessageId = validationChildToRender ? `${fieldsetId}-validationMsg` : undefined;
+  return /*#__PURE__*/React.createElement(Slots, {
+    context: {
+      captionId,
+      name,
+      onSelect,
+      required,
+      validationMessageId
+    }
+  }, slots => {
+    const isLegendVisible = /*#__PURE__*/React.isValidElement(slots.Legend) && slots.Legend.props.isVisible;
+    return /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement(Box, {
+      as: "fieldset",
+      border: "none",
+      margin: 0,
+      padding: 0,
+      "aria-describedby": [validationMessageId, captionId].filter(Boolean).join(' ')
+    }, React.Children.toArray(children).filter(child => /*#__PURE__*/React.isValidElement(child) && child.type !== ChoiceFieldsetValidation), /*#__PURE__*/React.createElement(Box, {
+      mb: isLegendVisible ? 3 : undefined
+    }, slots.Legend), slots.ChoiceList), (validationChildToRender || slots.Caption) && /*#__PURE__*/React.createElement(Box, {
+      mt: 3
+    }, validationChildToRender && validationMap && validationResult && validationMessageId && /*#__PURE__*/React.createElement(ValidationAnimationContainer, {
+      show: true
+    }, /*#__PURE__*/React.createElement(InputValidation, {
+      validationStatus: validationMap[validationResult],
+      id: validationMessageId
+    }, validationChildToRender)), /*#__PURE__*/React.createElement(Box, {
+      mt: validationChildToRender ? 1 : undefined
+    }, slots.Caption)));
+  });
+};
+
+ChoiceFieldset.displayName = "ChoiceFieldset";
+export default Object.assign(ChoiceFieldset, {
+  ChoiceField,
+  Caption: ChoiceFieldsetCaption,
+  Legend: ChoiceFieldsetLegend,
+  List: ChoiceFieldsetList,
+  Validation: ChoiceFieldsetValidation
+});

package/lib-esm/ChoiceFieldset/ChoiceFieldsetCaption.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const ChoiceFieldsetCaption: React.FC;
+export default ChoiceFieldsetCaption;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetCaption.js

@@ -0,0 +1,16 @@
+import React from 'react';
+import InputCaption from '../_InputCaption';
+import { Slot } from './ChoiceFieldset';
+
+const ChoiceFieldsetCaption = ({
+  children
+}) => /*#__PURE__*/React.createElement(Slot, {
+  name: "Caption"
+}, ({
+  captionId
+}) => /*#__PURE__*/React.createElement(InputCaption, {
+  id: captionId
+}, children));
+
+ChoiceFieldsetCaption.displayName = "ChoiceFieldsetCaption";
+export default ChoiceFieldsetCaption;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetLegend.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface ChoiceFieldsetLegendProps {
+    visuallyHidden?: boolean;
+}
+declare const ChoiceFieldsetLegend: React.FC<ChoiceFieldsetLegendProps>;
+export default ChoiceFieldsetLegend;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetLegend.js

@@ -0,0 +1,28 @@
+import React from 'react';
+import { Box } from '..';
+import VisuallyHidden from '../_VisuallyHidden';
+import { Slot } from './ChoiceFieldset';
+
+const ChoiceFieldsetLegend = ({
+  children,
+  visuallyHidden
+}) => /*#__PURE__*/React.createElement(Slot, {
+  name: "Legend"
+}, ({
+  required
+}) => /*#__PURE__*/React.createElement(VisuallyHidden, {
+  isVisible: !visuallyHidden,
+  title: required ? 'required field' : undefined,
+  sx: {
+    fontSize: 2,
+    padding: 0
+  }
+}, required ? /*#__PURE__*/React.createElement(Box, {
+  display: "flex",
+  as: "span"
+}, /*#__PURE__*/React.createElement(Box, {
+  mr: 1
+}, children), /*#__PURE__*/React.createElement("span", null, "*")) : children));
+
+ChoiceFieldsetLegend.displayName = "ChoiceFieldsetLegend";
+export default ChoiceFieldsetLegend;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetList.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface ChoiceFieldsetListProps {
+    selectionVariant?: 'single' | 'multiple';
+}
+declare const ChoiceFieldsetList: React.FC<ChoiceFieldsetListProps>;
+export default ChoiceFieldsetList;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetList.js

@@ -0,0 +1,68 @@
+import React from 'react';
+import styled from 'styled-components';
+import { CheckboxInputField, RadioInputField } from '..';
+import { get } from '../constants';
+import { uniqueId } from '../utils/uniqueId';
+import { Slot } from './ChoiceFieldset';
+import ChoiceFieldsetListContext from './ChoiceFieldsetListContext';
+const List = styled.ul.withConfig({
+  displayName: "ChoiceFieldsetList__List",
+  componentId: "sc-16da7ba-0"
+})(["display:flex;flex-direction:column;list-style:none;margin:0;padding:0;> li + li{margin-top:", ";}"], get('space.2'));
+
+const ChoiceFieldsetList = ({
+  selectionVariant,
+  children
+}) => {
+  var _React$Children$map;
+
+  const initialSelectedChoices = ((_React$Children$map = React.Children.map(children, child => {
+    if ( /*#__PURE__*/React.isValidElement(child) && child.props.checked) {
+      return child.props.value;
+    }
+
+    return '';
+  })) === null || _React$Children$map === void 0 ? void 0 : _React$Children$map.filter(Boolean)) || [];
+
+  const getSelectedCheckboxes = (value, checked) => {
+    if (checked) {
+      return selectionVariant === 'multiple' ? [...initialSelectedChoices, value] : [value];
+    }
+
+    return initialSelectedChoices.filter(selectedValue => selectedValue !== value);
+  }; // generates a name to pass to radio inputs if one was not passed in ChoiceFieldset props
+
+
+  const getRadioGroupName = nameFromContext => {
+    if (nameFromContext || selectionVariant !== 'multiple') {
+      return nameFromContext;
+    }
+
+    const generatedName = uniqueId();
+    return generatedName;
+  };
+
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "ChoiceList"
+  }, ({
+    name,
+    onSelect
+  }) => /*#__PURE__*/React.createElement(ChoiceFieldsetListContext.Provider, {
+    value: {
+      initialSelectedChoices,
+      name: getRadioGroupName(name),
+      fieldComponent: selectionVariant === 'multiple' ? CheckboxInputField : RadioInputField,
+      onChange: e => {
+        onSelect && onSelect(getSelectedCheckboxes(e.currentTarget.value, e.currentTarget.checked));
+      }
+    }
+  }, /*#__PURE__*/React.createElement(List, null, React.Children.map(children, (child, i) => /*#__PURE__*/React.createElement("li", {
+    key: i
+  }, child)))));
+};
+
+ChoiceFieldsetList.displayName = "ChoiceFieldsetList";
+ChoiceFieldsetList.defaultProps = {
+  selectionVariant: 'single'
+};
+export default ChoiceFieldsetList;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetListContext.d.ts

@@ -0,0 +1,17 @@
+import { ChangeEventHandler } from 'react';
+import { CheckboxInputField, RadioInputField } from '..';
+import { ComponentProps } from '../utils/types';
+import InputField from '../_InputField';
+import ToggleInputField, { ToggleInputFieldProps } from '../_InputField/ToggleInputField';
+declare const ChoiceFieldsetListContext: import("react").Context<{
+    initialSelectedChoices?: string[] | undefined;
+    name?: string | undefined;
+    onChange: ChangeEventHandler<HTMLInputElement>;
+    fieldComponent: React.FC<ToggleInputFieldProps> & {
+        Input: React.FC<ComponentProps<typeof RadioInputField.Input>> | React.FC<ComponentProps<typeof CheckboxInputField.Input>>;
+        Caption: React.FC<ComponentProps<typeof InputField.Caption>>;
+        Label: React.FC<ComponentProps<typeof InputField.Label>>;
+        LeadingVisual: React.FC<ComponentProps<typeof ToggleInputField.LeadingVisual>>;
+    };
+} | null>;
+export default ChoiceFieldsetListContext;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetListContext.js

@@ -0,0 +1,5 @@
+import { createContext } from 'react';
+import { CheckboxInputField } from '..';
+const ChoiceFieldsetListContext = /*#__PURE__*/createContext(null);
+CheckboxInputField.Input;
+export default ChoiceFieldsetListContext;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetValidation.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface ChoiceFieldsetValidationProps {
+    validationKey: string;
+}
+declare const ChoiceFieldsetValidation: React.FC<ChoiceFieldsetValidationProps>;
+export default ChoiceFieldsetValidation;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetValidation.js

@@ -0,0 +1,7 @@
+import React from 'react';
+
+const ChoiceFieldsetValidation = ({
+  children
+}) => /*#__PURE__*/React.createElement(React.Fragment, null, children);
+
+export default ChoiceFieldsetValidation;

package/lib-esm/ChoiceFieldset/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './ChoiceFieldset';
+export { default as ChoiceField } from './ChoiceField';
+export type { ChoiceFieldsetProps } from './ChoiceFieldset';

package/lib-esm/ChoiceFieldset/index.js

@@ -0,0 +1,2 @@
+export { default } from './ChoiceFieldset';
+export { default as ChoiceField } from './ChoiceField';

package/lib-esm/RadioInputField.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { ToggleInputFieldProps } from './_InputField/ToggleInputField';
+declare const _default: React.FC<ToggleInputFieldProps> & {
+    Input: React.FC<React.HTMLProps<HTMLInputElement>>;
+    Caption: React.FC<{}>;
+    Label: React.FC<import("./_InputField/InputFieldLabel").Props>;
+    LeadingVisual: React.FC<{}>;
+};
+export default _default;

package/lib-esm/RadioInputField.js

@@ -0,0 +1,65 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+import React from 'react';
+import InputField from './_InputField/InputField';
+import { Slot } from './_InputField/slots';
+import ToggleInputField from './_InputField/ToggleInputField';
+import ToggleInputLeadingVisual from './_InputField/ToggleInputLeadingVisual'; // TODO: use Primer's checkbox input once it's available
+// https://github.com/github/primer/issues/489
+
+const RadioInput = props => {
+  return /*#__PURE__*/React.createElement("input", _extends({
+    type: "radio"
+  }, props));
+};
+
+RadioInput.displayName = "RadioInput";
+
+// pulling out `id`, `disabled`, and `required` because those should come from the parent TextInputField component
+const Input = ({
+  id: idProp,
+  required: requiredProp,
+  disabled: disabledProp,
+  ...rest
+}) => {
+  if (idProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'id' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  if (disabledProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'disabled' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  if (requiredProp) {
+    // eslint-disable-next-line no-console
+    console.warn("instead of passing the 'required' prop directly to <TextInputField.Input>, it should be passed to the parent component, <TextInputField>");
+  }
+
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "Input"
+  }, ({
+    disabled,
+    id,
+    required,
+    captionId
+  }) => /*#__PURE__*/React.createElement(RadioInput, _extends({
+    "aria-describedby": captionId,
+    id: id,
+    required: required,
+    disabled: disabled
+  }, rest)));
+};
+
+Input.displayName = "Input";
+
+const RadioInputField = props => /*#__PURE__*/React.createElement(ToggleInputField, props);
+
+RadioInputField.displayName = "RadioInputField";
+export default Object.assign(RadioInputField, {
+  Input,
+  Caption: InputField.Caption,
+  Label: InputField.Label,
+  LeadingVisual: ToggleInputLeadingVisual
+});