@openedx/paragon 22.1.0 → 22.2.0

package/icons/index.d.ts

@@ -0,0 +1,5 @@
+export * from './es5';
+
+import * as allIcons from './es5';
+
+export type IconName = keyof typeof allIcons;

package/icons/index.mjs

@@ -0,0 +1 @@
+export * from './es5';

package/icons/package.json

@@ -5,7 +5,7 @@
   "main": "index.js",
   "sideEffects": false,
   "scripts": {
-    "build": "node copy-mui-icons.js && node copy-brand-icons.js && svgr svg --out-dir jsx && babel jsx -d es5",
+    "build": "node copy-mui-icons.js && node copy-brand-icons.js && svgr svg --out-dir jsx && babel jsx -d es5 && echo '// @ts-nocheck'  > es5/index.ts && cat es5/index.js >> es5/index.ts",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
@@ -22,5 +22,11 @@
   },
   "peerDependencies": {
     "react": "^16.8.6 || ^17.0.2"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "types": "./index.d.ts"
+    }
   }
 }

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@openedx/paragon",
-  "version": "22.1.0",
+  "version": "22.2.0",
   "description": "Accessible, responsive UI component library based on Bootstrap.",
   "main": "dist/index.js",
   "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
@@ -47,7 +48,7 @@
     "build-types": "tsc --emitDeclarationOnly",
     "playroom:start": "npm run playroom:start --workspace=www",
     "playroom:build": "npm run playroom:build --workspace=www",
-    "prepare": "husky install"
+    "prepare": "husky || true"
   },
   "dependencies": {
     "@fortawesome/fontawesome-svg-core": "^6.1.1",
@@ -107,6 +108,8 @@
     "@types/jest": "^29.5.10",
     "@types/react": "17.0.0",
     "@types/react-dom": "17.0.11",
+    "@types/react-responsive": "^8.0.8",
+    "@types/react-table": "^7.7.19",
     "@types/react-test-renderer": "^18.0.0",
     "@types/uuid": "^9.0.0",
     "@typescript-eslint/eslint-plugin": "^5.22.0",
@@ -123,7 +126,7 @@
     "eslint-plugin-jsx-a11y": "6.7.1",
     "eslint-plugin-react": "7.32.2",
     "eslint-plugin-react-hooks": "4.6.0",
-    "husky": "^8.0.1",
+    "husky": "^9.0.11",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^28.1.3",
     "jest-cli": "^28.1.2",

package/src/Form/FormAutosuggest.jsx

@@ -92,7 +92,7 @@ const FormAutosuggest = forwardRef(
 
         return React.cloneElement(child, {
           ...rest,
-          childChildren,
+          children: childChildren,
           'data-value': childChildren,
           onClick: (e) => handleItemSelect(e, onClick),
           id: menuItemId,

package/src/Icon/{Icon.test.jsx → Icon.test.tsx}

@@ -1,5 +1,7 @@
 import React from 'react';
 import { render } from '@testing-library/react';
+import * as ParagonIcons from '../../icons';
+import { type IconName } from '../../icons';
 
 import Icon from './index';
 
@@ -14,7 +16,41 @@ function BlankSrc() {
   return <div />;
 }
 
+/** A compile time check. Whatever React elements this wraps won't run at runtime. */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function CompileCheck(_props: { children: React.ReactNode }) { return null; }
+
+describe('IconName type', () => {
+  it('has correct typing', () => {
+    /* eslint-disable @typescript-eslint/no-unused-vars */
+
+    const realName: IconName = 'ArrowCircleDown';
+    // @ts-expect-error This should be a compile-time error, as 'FooBarIcon' doesn't exist.
+    const wrongName: IconName = 'FooBarIcon';
+
+    /* eslint-enable @typescript-eslint/no-unused-vars */
+  });
+});
+
 describe('<Icon />', () => {
+  it('has correct typing', () => {
+    <CompileCheck>
+      {/* Correct usage */}
+      <Icon src={ParagonIcons.ArrowCircleDown} id="icon123" size="sm" />
+      {/* An empty <Icon /> is allowed; if not, the checks below would need to be modified. */}
+      <Icon />
+
+      {/* @ts-expect-error Using a non-existent icon from @openedx/paragon/icons is a type error */}
+      <Icon src={ParagonIcons.FooBarIcon} />
+      {/* @ts-expect-error The 'src' prop cannot be a string. */}
+      <Icon src="string" />
+      {/* @ts-expect-error Random props cannot be added */}
+      <Icon foo="bar" />
+      {/* @ts-expect-error This is not a valid size property */}
+      <Icon size="big" />
+    </CompileCheck>;
+  });
+
   describe('props received correctly', () => {
     it('receives required props', () => {
       const { container } = render(<Icon className={classNames} />);
@@ -66,5 +102,13 @@ describe('<Icon />', () => {
 
       expect(iconSpan.classList.contains('pgn__icon__xs')).toEqual(true);
     });
+
+    it('receives style or other arbitrary HTML properties correctly', () => {
+      const { container } = render(<Icon src={BlankSrc} style={{ color: 'red' }} size="xs" />);
+      const iconSpans = container.querySelectorAll('span');
+      const iconSpan = iconSpans[0];
+
+      expect(iconSpan.style.color).toEqual('red');
+    });
   });
 });

package/src/Icon/index.d.ts

@@ -1,14 +1,14 @@
 import React from 'react';
 
-export interface IconProps {
+export interface IconProps extends React.ComponentPropsWithoutRef<'span'> {
   src?: React.ReactElement | Function;
   svgAttrs?: {
     'aria-label'?: string;
     'aria-labelledby'?: string;
   };
-  id?: string;
+  id?: string | null;
   size?: 'xs' | 'sm' | 'md' | 'lg';
-  className?: string;
+  className?: string | string[];
   hidden?: boolean;
   screenReaderText?: React.ReactNode;
 }

package/src/index.d.ts

@@ -0,0 +1,216 @@
+/* eslint-disable max-len, one-var, one-var-declaration-per-line */
+// each line in this file corresponds with the line in index.js
+
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+// Things that have types
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+export { default as Bubble } from './Bubble';
+export { default as Chip, CHIP_PGN_CLASS } from './Chip';
+export { default as ChipCarousel } from './ChipCarousel';
+export { default as Icon } from './Icon';
+
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+// Things that don't have types
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+export const asInput: any; // from './asInput';
+export const ActionRow: any; // from './ActionRow';
+export const Alert: any, ALERT_CLOSE_LABEL_TEXT: string; // from './Alert';
+export const Annotation: any; // from './Annotation';
+export const Avatar: any; // from './Avatar';
+export const AvatarButton: any; // from './AvatarButton';
+export const Badge: any; // from './Badge';
+export const Breadcrumb: any; // from './Breadcrumb';
+export const Button: any, ButtonGroup: any, ButtonToolbar: any; // from './Button';
+export const
+  Card: any,
+  CardColumns: any,
+  CardDeck: any,
+  CardImg: any,
+  CardGroup: any,
+  CardGrid: any,
+  CardCarousel: any,
+  CARD_VARIANTS: any;
+// from './Card';
+export const
+  Carousel: any, CarouselItem: any, CAROUSEL_NEXT_LABEL_TEXT: any, CAROUSEL_PREV_LABEL_TEXT: any;
+// from './Carousel';
+export const CheckBox: any; // from './CheckBox';
+export const CheckBoxGroup: any; // from './CheckBoxGroup';
+export const CloseButton: any; // from './CloseButton';
+export const Container: any; // from './Container';
+export const Layout: any, Col: any, Row: any; // from './Layout';
+export const Collapse: any; // from './Collapse';
+export const Collapsible: any; // from './Collapsible';
+export const Scrollable: any; // from './Scrollable';
+export const
+  Dropdown: any,
+  DropdownToggle: any,
+  DropdownButton: any,
+  SplitButton: any;
+// from './Dropdown';
+export const Fade: any; // from './Fade';
+export const Fieldset: any; // from './Fieldset';
+export const
+  Form: any,
+  RadioControl: any,
+  CheckboxControl: any,
+  SwitchControl: any,
+  FormSwitchSet: any,
+  FormControl: any,
+  FormControlDecoratorGroup: any,
+  FormControlFeedback: any,
+  FormCheck: any,
+  FormFile: any,
+  FormRadio: any,
+  FormRadioSet: any,
+  FormRadioSetContext: any,
+  FormGroup: any,
+  FormLabel: any,
+  useCheckboxSetValues: any,
+  FormText: any,
+  FormAutosuggest: any,
+  FormAutosuggestOption: any,
+  InputGroup: any;
+// from './Form';
+export const Hyperlink: any, HYPER_LINK_EXTERNAL_LINK_ALT_TEXT: string, HYPER_LINK_EXTERNAL_LINK_TITLE: string; // from './Hyperlink';
+export const IconButton: any, IconButtonWithTooltip: any; // from './IconButton';
+export const IconButtonToggle: any; // from './IconButtonToggle';
+export const Input: any; // from './Input';
+export const InputSelect: any; // from './InputSelect';
+export const InputText: any; // from './InputText';
+export const Image: any, Figure; // from './Image';
+export const ListBox: any; // from './ListBox';
+export const ListBoxOption: any; // from './ListBoxOption';
+export const MailtoLink: any, MAIL_TO_LINK_EXTERNAL_LINK_ALTERNATIVE_TEXT: string, MAIL_TO_LINK_EXTERNAL_LINK_TITLE: string; // from './MailtoLink';
+export const Media: any; // from './Media';
+export const Menu: any; // from './Menu';
+export const MenuItem: any; // from './Menu/MenuItem';
+export const SelectMenu: any, SELECT_MENU_DEFAULT_MESSAGE: string; // from './Menu/SelectMenu';
+export const Modal: any; // from './Modal';
+export const ModalCloseButton: any; // from './Modal/ModalCloseButton';
+export const FullscreenModal: any, FULLSCREEN_MODAL_CLOSE_LABEL: string; // from './Modal/FullscreenModal';
+export const MarketingModal: any; // from './Modal/MarketingModal';
+export const StandardModal: any, STANDARD_MODAL_CLOSE_LABEL: string; // from './Modal/StandardModal';
+export const AlertModal: any; // from './Modal/AlertModal';
+export const ModalLayer: any; // from './Modal/ModalLayer';
+export const ModalDialog: any, MODAL_DIALOG_CLOSE_LABEL: string; // from './Modal/ModalDialog';
+export const ModalPopup: any; // from './Modal/ModalPopup';
+export const ModalContext: any; // from './Modal/ModalContext';
+export const Portal: any; // from './Modal/Portal';
+export const PopperElement: any; // from './Modal/PopperElement';
+
+export const
+  Nav: any,
+  NavDropdown: any,
+  NavItem: any,
+  NavLink: any;
+// from './Nav';
+export const Navbar: any, NavbarBrand: any, NAVBAR_LABEL: string; // from './Navbar';
+export const Overlay: any, OverlayTrigger: any; // from './Overlay';
+export const PageBanner: any, PAGE_BANNER_DISMISS_ALT_TEXT: string; // from './PageBanner';
+export const
+  Pagination: any,
+  PAGINATION_BUTTON_LABEL_PREV: string,
+  PAGINATION_BUTTON_ICON_BUTTON_NEXT_ALT: string,
+  PAGINATION_BUTTON_ICON_BUTTON_PREV_ALT: string,
+  PAGINATION_BUTTON_LABEL_PAGE_OF_COUNT: string,
+  PAGINATION_BUTTON_LABEL_CURRENT_PAGE: string,
+  PAGINATION_BUTTON_LABEL_NEXT: string,
+  PAGINATION_BUTTON_LABEL_PAGE: string;
+// from './Pagination';
+export const Popover: any, PopoverTitle: any, PopoverContent: any; // from './Popover';
+export const ProgressBar: any; // from './ProgressBar';
+export const ProductTour: any; // from './ProductTour';
+export const RadioButtonGroup: any, RadioButton: any; // from './RadioButtonGroup';
+export const ResponsiveEmbed: any; // from './ResponsiveEmbed';
+export const
+  SearchField: any,
+  SEARCH_FIELD_SCREEN_READER_TEXT_LABEL: string,
+  SEARCH_FIELD_SCREEN_READER_TEXT_CLEAR_BUTTON: string,
+  SEARCH_FIELD_SCREEN_READER_TEXT_SUBMIT_BUTTON: string,
+  SEARCH_FIELD_BUTTON_TEXT: string;
+// from './SearchField';
+export const Sheet: any; // from './Sheet';
+export const Spinner: any; // from './Spinner';
+export const Stepper: any; // from './Stepper';
+export const StatefulButton: any; // from './StatefulButton';
+export const StatusAlert: any; // from './StatusAlert';
+export const Table: any; // from './Table';
+export const
+  Tabs: any,
+  Tab: any,
+  TabContainer: any,
+  TabContent: any,
+  TabPane: any;
+// from './Tabs';
+export const TextArea: any; // from './TextArea';
+export const Toast: any, TOAST_CLOSE_LABEL_TEXT: string, TOAST_DELAY: number; // from './Toast';
+export const Tooltip: any; // from './Tooltip';
+export const ValidationFormGroup: any; // from './ValidationFormGroup';
+export const TransitionReplace: any; // from './TransitionReplace';
+export const ValidationMessage: any; // from './ValidationMessage';
+export const DataTable: any; // from './DataTable';
+export const TextFilter: any; // from './DataTable/filters/TextFilter';
+export const CheckboxFilter: any; // from './DataTable/filters/CheckboxFilter';
+export const DropdownFilter: any; // from './DataTable/filters/DropdownFilter';
+export const MultiSelectDropdownFilter: any; // from './DataTable/filters/MultiSelectDropdownFilter';
+export const TableHeaderCell: any; // from './DataTable/TableHeaderCell';
+export const TableCell: any; // from './DataTable/TableCell';
+export const TableFilters: any, TABLE_FILTERS_BUTTON_TEXT: string; // from './DataTable/TableFilters';
+export const TableHeader: any; // from './DataTable/TableHeaderRow';
+export const TableRow: any; // from './DataTable/TableRow';
+export const TablePagination: any; // from './DataTable/TablePagination';
+export const TablePaginationMinimal: any; // from './DataTable/TablePaginationMinimal';
+export const DataTableContext: any; // from './DataTable/DataTableContext';
+export const BulkActions: any; // from './DataTable/BulkActions';
+export const TableControlBar: any; // from './DataTable/TableControlBar';
+export const TableFooter: any; // from './DataTable/TableFooter';
+export const CardView: any; // from './DataTable/CardView';
+export const Skeleton: any, SkeletonTheme: any; // from './Skeleton/index';
+export const Stack: any; // from './Stack';
+export const ToggleButton: any, ToggleButtonGroup: any; // from './ToggleButton';
+export const Sticky: any; // from './Sticky';
+export const SelectableBox: any; // from './SelectableBox';
+export const breakpoints: any; // from './utils/breakpoints';
+export const Variant: any; // from './utils/constants';
+export const useWindowSize: any; // from './hooks/useWindowSize';
+export const useToggle: any; // from './hooks/useToggle';
+export const useArrowKeyNavigation: any; // from './hooks/useArrowKeyNavigation';
+export const useIndexOfLastVisibleChild: any; // from './hooks/useIndexOfLastVisibleChild';
+export const useIsVisible: any; // from './hooks/useIsVisible';
+export const
+  OverflowScrollContext: any,
+  OverflowScroll: any,
+  useOverflowScroll: any,
+  useOverflowScrollItems: any;
+// from './OverflowScroll';
+export const Dropzone: any; // from './Dropzone';
+export const messages: any; // from './i18n';
+export const Truncate: any; // from './Truncate';
+export const ColorPicker: any; // from './ColorPicker';
+
+// Pass through any needed whole third-party library functionality
+// useTable for example is needed to use the DataTable component seamlessly
+// rather than setting a peer dependency in this project, we opt to tightly
+// couple these dependencies by passing through needed functionality.
+export {
+  default as MediaQuery,
+  useMediaQuery,
+  Context as ResponsiveContext,
+} from 'react-responsive';
+export {
+  useTable,
+  useFilters,
+  useGlobalFilter,
+  useSortBy,
+  useGroupBy,
+  useExpanded,
+  usePagination,
+  useRowSelect,
+  useRowState,
+  useColumnOrder,
+  useResizeColumns,
+  useBlockLayout,
+  useAbsoluteLayout,
+  useFlexLayout,
+} from 'react-table';

package/src/index.js

@@ -1,3 +1,17 @@
+// To keep this file in sync with the .d.ts file, it's in the same order
+// and each line number is the same
+
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+// Things that have types
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+export { default as Bubble } from './Bubble';
+export { default as Chip, CHIP_PGN_CLASS } from './Chip';
+export { default as ChipCarousel } from './ChipCarousel';
+export { default as Icon } from './Icon';
+
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
+// Things that don't have types
+// // // // // // // // // // // // // // // // // // // // // // // // // // //
 export { default as asInput } from './asInput';
 export { default as ActionRow } from './ActionRow';
 export { default as Alert, ALERT_CLOSE_LABEL_TEXT } from './Alert';
@@ -22,8 +36,6 @@ export {
 } from './Carousel';
 export { default as CheckBox } from './CheckBox';
 export { default as CheckBoxGroup } from './CheckBoxGroup';
-export { default as Chip, CHIP_PGN_CLASS } from './Chip';
-export { default as ChipCarousel } from './ChipCarousel';
 export { default as CloseButton } from './CloseButton';
 export { default as Container } from './Container';
 export { default as Layout, Col, Row } from './Layout';
@@ -61,7 +73,6 @@ export {
   InputGroup,
 } from './Form';
 export { default as Hyperlink, HYPER_LINK_EXTERNAL_LINK_ALT_TEXT, HYPER_LINK_EXTERNAL_LINK_TITLE } from './Hyperlink';
-export { default as Icon } from './Icon';
 export { default as IconButton, IconButtonWithTooltip } from './IconButton';
 export { default as IconButtonToggle } from './IconButtonToggle';
 export { default as Input } from './Input';
@@ -155,6 +166,7 @@ export { default as BulkActions } from './DataTable/BulkActions';
 export { default as TableControlBar } from './DataTable/TableControlBar';
 export { default as TableFooter } from './DataTable/TableFooter';
 export { default as CardView } from './DataTable/CardView';
+export { default as Skeleton, SkeletonTheme } from './Skeleton/index';
 export { default as Stack } from './Stack';
 export { default as ToggleButton, ToggleButtonGroup } from './ToggleButton';
 export { default as Sticky } from './Sticky';
@@ -172,6 +184,10 @@ export {
   useOverflowScroll,
   useOverflowScrollItems,
 } from './OverflowScroll';
+export { default as Dropzone } from './Dropzone';
+export { default as messages } from './i18n';
+export { default as Truncate } from './Truncate';
+export { default as ColorPicker } from './ColorPicker';
 
 // Pass through any needed whole third-party library functionality
 // useTable for example is needed to use the DataTable component seamlessly
@@ -198,10 +214,3 @@ export {
   useAbsoluteLayout,
   useFlexLayout,
 } from 'react-table';
-export { default as Skeleton, SkeletonTheme } from './Skeleton/index';
-export { default as Bubble } from './Bubble';
-export { default as Dropzone } from './Dropzone';
-
-export { default as messages } from './i18n';
-export { default as Truncate } from './Truncate';
-export { default as ColorPicker } from './ColorPicker';