@primer/components 0.0.0-2021118154017 → 0.0.0-2021118195952

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

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

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,65 @@
+import React, { ComponentProps } from 'react';
+import { FormValidationStatus } from '../utils/types/FormValidationStatus';
+export interface ChoiceFieldsetProps<T = Record<string, FormValidationStatus>> {
+    children?: React.ReactNode;
+    /**
+     * Whether the fieldset is NOT ready for user input
+     */
+    disabled?: boolean;
+    /**
+     * The unique identifier for this fieldset. Used to associate the validation text with the fieldset
+     * If an ID is not passed, one will be automatically generated
+     */
+    id?: string;
+    /**
+     * The unique identifier used to associate radio inputs with eachother
+     * If a name is not passed and the fieldset renders radio inputs, a name will be automatically generated
+     */
+    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;
+    /**
+     * The selected values
+     */
+    selected?: string[];
+    /**
+     * 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 {
+    validationMessageId: string;
+}
+declare const Slot: React.FC<{
+    name: "Description" | "ChoiceList" | "Legend" | "Validation";
+    children: React.ReactNode;
+}>;
+export { Slot };
+declare const ChoiceFieldset: <T extends Record<string, FormValidationStatus>>({ children, disabled, id, name, onSelect, required, selected, 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 './ChoiceFieldsetListItem';
+declare const _default: (<T extends Record<string, FormValidationStatus>>({ children, disabled, id, name, onSelect, required, selected, validationMap, validationResult }: ChoiceFieldsetProps<T>) => JSX.Element) & {
+    Description: React.FC<{}>;
+    Item: React.FC<import("./ChoiceFieldsetListItem").ChoiceFieldProps> & {
+        Caption: React.FC<{}>;
+        Label: React.FC<{}>;
+        LeadingVisual: 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,71 @@
+import React from 'react';
+import { Box, useSSRSafeId } from '..';
+import createSlots from '../utils/create-slots';
+import ValidationAnimationContainer from '../_InputField/ValidationAnimationContainer';
+import InputValidation from '../_InputValidation';
+import ChoiceFieldsetListItem from './ChoiceFieldsetListItem';
+import ChoiceFieldsetDescription from './ChoiceFieldsetDescription';
+import ChoiceFieldsetLegend from './ChoiceFieldsetLegend';
+import ChoiceFieldsetList from './ChoiceFieldsetList';
+import ChoiceFieldsetValidation from './ChoiceFieldsetValidation';
+const {
+  Slots,
+  Slot
+} = createSlots(['Description', 'ChoiceList', 'Legend', 'Validation']);
+export { Slot };
+
+const ChoiceFieldset = ({
+  children,
+  disabled,
+  id,
+  name,
+  onSelect,
+  required,
+  selected,
+  validationMap,
+  validationResult
+}) => {
+  var _React$Children$map;
+
+  const fieldsetId = useSSRSafeId(id);
+  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 validationMessageId = validationChildToRender ? `${fieldsetId}-validationMsg` : undefined;
+  return /*#__PURE__*/React.createElement(Slots, {
+    context: {
+      disabled,
+      name,
+      onSelect,
+      required,
+      selected,
+      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].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.Description), slots.ChoiceList), validationChildToRender && /*#__PURE__*/React.createElement(Box, {
+      mt: 3
+    }, validationMap && validationResult && validationMessageId && /*#__PURE__*/React.createElement(ValidationAnimationContainer, {
+      show: true
+    }, /*#__PURE__*/React.createElement(InputValidation, {
+      validationStatus: validationMap[validationResult],
+      id: validationMessageId
+    }, validationChildToRender))));
+  });
+};
+
+ChoiceFieldset.displayName = "ChoiceFieldset";
+export default Object.assign(ChoiceFieldset, {
+  Description: ChoiceFieldsetDescription,
+  Item: ChoiceFieldsetListItem,
+  Legend: ChoiceFieldsetLegend,
+  List: ChoiceFieldsetList,
+  Validation: ChoiceFieldsetValidation
+});

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

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

package/lib-esm/ChoiceFieldset/ChoiceFieldsetDescription.js

@@ -0,0 +1,17 @@
+import React from 'react';
+import { Text } from '..';
+import { Slot } from './ChoiceFieldset';
+
+const ChoiceFieldsetDescription = ({
+  children
+}) => /*#__PURE__*/React.createElement(Slot, {
+  name: "Description"
+}, ({
+  disabled
+}) => /*#__PURE__*/React.createElement(Text, {
+  color: disabled ? 'fg.muted' : 'fg.default',
+  fontSize: 1
+}, children));
+
+ChoiceFieldsetDescription.displayName = "ChoiceFieldsetDescription";
+export default ChoiceFieldsetDescription;

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

@@ -0,0 +1,9 @@
+import React from 'react';
+export interface ChoiceFieldsetLegendProps {
+    /**
+     * Whether to visually hide the fieldset legend
+     */
+    visuallyHidden?: boolean;
+}
+declare const ChoiceFieldsetLegend: React.FC<ChoiceFieldsetLegendProps>;
+export default ChoiceFieldsetLegend;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetLegend.js

@@ -0,0 +1,31 @@
+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,
+  disabled
+}) => /*#__PURE__*/React.createElement(VisuallyHidden, {
+  as: "legend",
+  isVisible: !visuallyHidden,
+  title: required ? 'required field' : undefined,
+  sx: {
+    color: disabled ? 'fg.muted' : undefined,
+    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,9 @@
+import React from 'react';
+export interface ChoiceFieldsetListProps {
+    /**
+     * Whether multiple items or a single item can be selected
+     */
+    selectionVariant?: 'single' | 'multiple';
+}
+declare const ChoiceFieldsetList: React.FC<ChoiceFieldsetListProps>;
+export default ChoiceFieldsetList;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetList.js

@@ -0,0 +1,55 @@
+import React from 'react';
+import styled from 'styled-components';
+import { CheckboxInputField, RadioInputField, useSSRSafeId } from '..';
+import { get } from '../constants';
+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 getSelectedCheckboxes = (value, checked, selectedValues, selectionVariant) => {
+  if (checked) {
+    return selectionVariant === 'multiple' ? [...selectedValues, value] : [value];
+  }
+
+  return selectedValues.filter(selectedValue => selectedValue !== value);
+};
+
+const ChoiceFieldsetList = ({
+  selectionVariant,
+  children
+}) => {
+  const ssrSafeUniqueName = useSSRSafeId();
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "ChoiceList"
+  }, ({
+    name,
+    onSelect,
+    disabled,
+    selected = []
+  }) => {
+    return /*#__PURE__*/React.createElement(ChoiceFieldsetListContext.Provider, {
+      value: {
+        disabled,
+        selected,
+        name: name || ssrSafeUniqueName,
+        fieldComponent: selectionVariant === 'multiple' ? CheckboxInputField : RadioInputField,
+        onChange: e => {
+          const updatedSelections = getSelectedCheckboxes(e.currentTarget.value, e.currentTarget.checked, selected, selectionVariant);
+          onSelect && onSelect(updatedSelections);
+        },
+        selectionVariant
+      }
+    }, /*#__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,19 @@
+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<{
+    disabled?: boolean | undefined;
+    name: string;
+    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>>;
+    };
+    selected?: string[] | undefined;
+    selectionVariant?: "single" | "multiple" | undefined;
+} | 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/ChoiceFieldsetListItem.d.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import { ComponentProps } from '../utils/types';
+export interface ChoiceFieldProps {
+    /**
+     * Whether the field is ready for user input
+     */
+    disabled?: boolean;
+    /**
+     * The unique identifier for this field. Used to associate the label, validation text, and caption text.
+     * If an ID is not provided, one will be automatically generated.
+     */
+    id?: string;
+    /**
+     * The value that is being selected
+     */
+    value: string;
+}
+declare const ChoiceFieldsetListItem: React.FC<ChoiceFieldProps>;
+export declare type ChoiceFieldComponentProps = ComponentProps<typeof ChoiceFieldsetListItem>;
+declare const _default: React.FC<ChoiceFieldProps> & {
+    Caption: React.FC<{}>;
+    Label: React.FC<{}>;
+    LeadingVisual: React.FC<{}>;
+};
+export default _default;

package/lib-esm/ChoiceFieldset/ChoiceFieldsetListItem.js

@@ -0,0 +1,51 @@
+import React, { useContext } from 'react';
+import { useSSRSafeId } from '..';
+import ToggleInputLeadingVisual from '../_InputField/ToggleInputLeadingVisual';
+import ChoiceFieldCaption from './ChoiceFieldCaption';
+import ChoiceFieldLabel from './ChoiceFieldLabel';
+import ChoiceFieldsetListContext from './ChoiceFieldsetListContext';
+
+const ChoiceFieldsetListItem = ({
+  children,
+  id,
+  disabled: disabledProp,
+  value
+}) => {
+  const choiceFieldsetListContext = useContext(ChoiceFieldsetListContext);
+
+  if (choiceFieldsetListContext === null) {
+    throw new Error('ChoiceFieldsetListContext returned null');
+  }
+
+  const {
+    name,
+    onChange,
+    fieldComponent: FieldComponent,
+    selected,
+    disabled,
+    selectionVariant
+  } = choiceFieldsetListContext;
+  const fieldId = useSSRSafeId(id);
+  const labelChild = React.Children.toArray(children).find(child => /*#__PURE__*/React.isValidElement(child) && child.type === ChoiceFieldLabel);
+  const otherValidChildren = React.Children.toArray(children).filter(child => /*#__PURE__*/React.isValidElement(child) && (child.type === ChoiceFieldCaption || child.type === ToggleInputLeadingVisual));
+  return /*#__PURE__*/React.createElement(FieldComponent, {
+    id: fieldId,
+    disabled: disabledProp || disabled
+  }, /*#__PURE__*/React.createElement(FieldComponent.Input, {
+    checked: selected === null || selected === void 0 ? void 0 : selected.includes(value),
+    value: value,
+    name: selectionVariant === 'multiple' ? value : name,
+    onChange: onChange
+  }), labelChild ? // if <Item.Label> was passed, we can just render the children as-is
+  children :
+  /*#__PURE__*/
+  // if <Item.Label> was NOT passed, treat all the children except <Item.Caption> and <Item.LeadingVisual> as the label
+  React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(FieldComponent.Label, null, children), otherValidChildren));
+};
+
+ChoiceFieldsetListItem.displayName = "ChoiceFieldsetListItem";
+export default Object.assign(ChoiceFieldsetListItem, {
+  Caption: ChoiceFieldCaption,
+  Label: ChoiceFieldLabel,
+  LeadingVisual: ToggleInputLeadingVisual
+});

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 Item } from './ChoiceFieldsetListItem';
+export type { ChoiceFieldsetProps } from './ChoiceFieldset';

package/lib-esm/ChoiceFieldset/index.js

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

package/lib-esm/CircleBadge.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="hoist-non-react-statics" />
+/// <reference types="react" />
+import { SxProp } from './sx';
+import { ComponentProps } from './utils/types';
+declare const CircleBadge: import("styled-components").StyledComponent<"div", any, {
+    inline?: boolean | undefined;
+    variant?: "small" | "medium" | "large" | undefined;
+    size?: number | undefined;
+} & SxProp, never>;
+declare const CircleBadgeIcon: import("styled-components").StyledComponent<({ icon: IconComponent, ...rest }: {
+    icon: import("react").ElementType<any>;
+} & import("@primer/octicons-react/dist/icons").IconProps) => JSX.Element, any, SxProp, never>;
+export declare type CircleBadgeProps = ComponentProps<typeof CircleBadge>;
+export declare type CircleBadgeIconProps = ComponentProps<typeof CircleBadgeIcon>;
+declare const _default: string & import("styled-components").StyledComponentBase<"div", any, {
+    inline?: boolean | undefined;
+    variant?: "small" | "medium" | "large" | undefined;
+    size?: number | undefined;
+} & SxProp, never> & import("hoist-non-react-statics").NonReactStatics<never, {}> & {
+    Icon: import("styled-components").StyledComponent<({ icon: IconComponent, ...rest }: {
+        icon: import("react").ElementType<any>;
+    } & import("@primer/octicons-react/dist/icons").IconProps) => JSX.Element, any, SxProp, never>;
+};
+export default _default;

package/lib-esm/CircleBadge.js

@@ -1,9 +1,7 @@
-import PropTypes from 'prop-types';
 import styled from 'styled-components';
-import { COMMON, get } from './constants';
+import { get } from './constants';
 import StyledOcticon from './StyledOcticon';
 import sx from './sx';
-import theme from './theme';
 import isNumeric from './utils/isNumeric';
 const variantSizes = {
   small: 56,
@@ -25,27 +23,13 @@ const sizeStyles = ({
 const CircleBadge = styled.div.withConfig({
   displayName: "CircleBadge",
   componentId: "sc-1lho816-0"
-})(["display:", ";align-items:center;justify-content:center;background-color:", ";border-radius:50%;box-shadow:", ";", ";", ";", ";"], props => props.inline ? 'inline-flex' : 'flex', get('colors.white'), get('shadows.medium'), COMMON, sizeStyles, sx);
+})(["display:", ";align-items:center;justify-content:center;background-color:", ";border-radius:50%;box-shadow:", ";", ";", ";"], props => props.inline ? 'inline-flex' : 'flex', get('colors.canvas.default'), get('shadows.shadow.medium'), sizeStyles, sx);
 const CircleBadgeIcon = styled(StyledOcticon).withConfig({
   displayName: "CircleBadge__CircleBadgeIcon",
   componentId: "sc-1lho816-1"
 })(["height:auto;max-width:60%;max-height:55%;"]);
 CircleBadge.defaultProps = {
-  inline: false,
-  theme
-};
-CircleBadge.propTypes = {
-  inline: PropTypes.bool,
-  size: PropTypes.number,
-  theme: PropTypes.object,
-  variant: PropTypes.oneOf(['small', 'medium', 'large']),
-  ...COMMON.propTypes,
-  ...sx.propTypes
-};
-CircleBadgeIcon.defaultProps = {
-  theme
-};
-CircleBadgeIcon.propTypes = { ...StyledOcticon.propTypes
+  inline: false
 };
 CircleBadgeIcon.displayName = 'CircleBadge.Icon';
 export default Object.assign(CircleBadge, {