@spscommerce/ds-react 5.26.1 → 6.0.0-rc1

package/lib/modal/SpsModal.d.ts

@@ -1,25 +1,18 @@
+import { ModalKind, ModalSize } from "@spscommerce/ds-shared";
 import * as React from "react";
 import * as PropTypes from "../prop-types";
-import { SpsModalHeader } from "./SpsModalHeader";
-import { SpsModalOverlay } from "./SpsModalOverlay";
-import { SpsModalBody } from "./SpsModalBody";
-import { SpsModalFooter } from "./SpsModalFooter";
-import { SpsModalAction } from "./SpsModalAction";
 declare const propTypes: {
-    kind: PropTypes.Requireable<string>;
-    id: PropTypes.Requireable<string>;
-    isOpen: PropTypes.Requireable<boolean>;
-    header: PropTypes.Requireable<string | (() => string)>;
-    onClose: PropTypes.Requireable<(...args: any[]) => any>;
-    onOpen: PropTypes.Requireable<(...args: any[]) => any>;
-    size: PropTypes.Requireable<string>;
-    backdrop: PropTypes.Requireable<string>;
-    actionRequired: PropTypes.Requireable<boolean>;
+    kind: PropTypes.Requireable<ModalKind>;
+    size: PropTypes.Requireable<ModalSize>;
+    title: PropTypes.Requireable<string>;
+    onClose: PropTypes.Requireable<() => void>;
+    focusElementOnOpen: PropTypes.Requireable<React.MutableRefObject<HTMLElement>>;
     children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
     className: PropTypes.Requireable<string>;
     "data-testid": PropTypes.Requireable<string>;
     unsafelyReplaceClassName: PropTypes.Requireable<string>;
 };
 export declare type SpsModalProps = PropTypes.InferTS<typeof propTypes, HTMLDivElement>;
-declare function SpsModal(modalProps: SpsModalProps): React.ReactPortal;
-export { SpsModal, SpsModalHeader, SpsModalOverlay, SpsModalBody, SpsModalFooter, SpsModalAction, };
+export declare function SpsModalFooter({ children }: SpsModalProps): JSX.Element;
+export declare function SpsModal({ children, className, id: idProp, kind, size, onClose, focusElementOnOpen, title, ...rest }: SpsModalProps): JSX.Element;
+export {};

package/lib/toggle/SpsToggle.d.ts

@@ -4,15 +4,11 @@ import type { SpsFormFieldMeta } from "../form/hooks/useSpsForm";
 import * as PropTypes from "../prop-types";
 declare const propTypes: {
     active: PropTypes.Requireable<boolean>;
-    activeDescription: PropTypes.Deprecated<string>;
-    activeLabel: PropTypes.Deprecated<string>;
     description: PropTypes.Requireable<string>;
     disabled: PropTypes.Requireable<boolean>;
     formControl: PropTypes.Requireable<SpsFormControl<boolean>>;
     formMeta: PropTypes.Requireable<SpsFormFieldMeta<boolean>>;
     id: PropTypes.Requireable<string>;
-    inactiveDescription: PropTypes.Deprecated<string>;
-    inactiveLabel: PropTypes.Deprecated<string>;
     label: PropTypes.Requireable<string>;
     large: PropTypes.Requireable<boolean>;
     onChange: PropTypes.Requireable<(isActive: boolean) => void>;

package/lib/utils/index.d.ts

@@ -1,8 +1,6 @@
-export * from "./bindProps";
 export * from "./contentOf";
 export * from "./FauxChangeEvent";
 export * from "./getPosition";
-export * from "./Provide";
 export * from "./selectChildren";
 export * from "./useCheckDeprecatedProps";
 export * from "./useDidUpdateEffect";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spscommerce/ds-react",
   "description": "SPS Design System React components",
-  "version": "5.26.1",
+  "version": "6.0.0-rc1",
   "author": "SPS Commerce",
   "license": "UNLICENSED",
   "repository": "https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-react",
@@ -28,11 +28,11 @@
   },
   "peerDependencies": {
     "@react-stately/collections": "^3.3.3",
-    "@spscommerce/ds-colors": "5.26.1",
-    "@spscommerce/ds-illustrations": "5.26.1",
-    "@spscommerce/ds-shared": "5.26.1",
-    "@spscommerce/positioning": "5.26.1",
-    "@spscommerce/utils": "5.26.1",
+    "@spscommerce/ds-colors": "6.0.0-rc1",
+    "@spscommerce/ds-illustrations": "6.0.0-rc1",
+    "@spscommerce/ds-shared": "6.0.0-rc1",
+    "@spscommerce/positioning": "6.0.0-rc1",
+    "@spscommerce/utils": "6.0.0-rc1",
     "moment": "^2.25.3",
     "moment-timezone": "^0.5.28",
     "react": "^16.9.0",
@@ -40,11 +40,11 @@
   },
   "devDependencies": {
     "@react-stately/collections": "^3.3.3",
-    "@spscommerce/ds-colors": "5.26.1",
-    "@spscommerce/ds-illustrations": "5.26.1",
-    "@spscommerce/ds-shared": "5.26.1",
-    "@spscommerce/positioning": "5.26.1",
-    "@spscommerce/utils": "5.26.1",
+    "@spscommerce/ds-colors": "6.0.0-rc1",
+    "@spscommerce/ds-illustrations": "6.0.0-rc1",
+    "@spscommerce/ds-shared": "6.0.0-rc1",
+    "@spscommerce/positioning": "6.0.0-rc1",
+    "@spscommerce/utils": "6.0.0-rc1",
     "@testing-library/react": "^9.3.2",
     "@types/prop-types": "^15.7.1",
     "@types/react": "^16.9.0",
@@ -64,6 +64,5 @@
     "watch": "vite build --watch",
     "clean": "git clean -fdX",
     "pub": "pnpm pack && node ../../scripts/publish-package.js"
-  },
-  "readme": "[//]: # \"START_AUTOGENERATED\"\n\n## [@spscommerce/ds-react](https://github.com/spscommerce/ui-angular/tree/master/packages/@spscommerce/ds-react#readme)\n\n![release: 1.1.0](https://img.shields.io/badge/release-1.1.0-blue.svg?style=flat-square)\n![build: passing](https://img.shields.io/badge/build-passing-green.svg?style=flat-square)\n![tests: failing](https://img.shields.io/badge/tests-failing-red.svg?style=flat-square)\n\nSPS Design System React components \n \n ### Installation \n \n ```shell\nnpm install --save @spscommerce/ds-react\n```\n\n#### Peer Dependencies\n\n<div class=\"row\">\n    <div class=\"col-5\"> \n    <table class=\"sps-table\">\n        <thead class=\"sps-table__head\">\n            <tr class=\"sps-table__row\">\n                <th class=\"sps-table__header\">\n                    <span class=\"sps-table__header-cell-body\">    \n                        Package\n                    </span>\n                </th>\n                <th class=\"sps-table__header text-right\">\n                    <span class=\"sps-table__header-cell-body\">    \n                        Version\n                    </span>\n                </th>\n            </tr>\n        </thead>\n        <tbody class=\"sps-table__body\">\n            <tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/ds-shared#readme\">@spscommerce/ds-shared</a></td><td class=\"sps-table__cell text-right\">^1.1.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/positioning#readme\">@spscommerce/positioning</a></td><td class=\"sps-table__cell text-right\">^1.1.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://github.com/spscommerce/design-system/tree/main/packages/@spscommerce/utils#readme\">@spscommerce/utils</a></td><td class=\"sps-table__cell text-right\">^1.1.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"lukeed/clsx\">clsx</a></td><td class=\"sps-table__cell text-right\">^1.0.3</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://momentjs.com\">moment</a></td><td class=\"sps-table__cell text-right\">^2.25.3</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"http://momentjs.com/timezone/\">moment-timezone</a></td><td class=\"sps-table__cell text-right\">^0.5.28</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"ai/nanoid\">nanoid</a></td><td class=\"sps-table__cell text-right\">^2.1.6</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://facebook.github.io/react/\">prop-types</a></td><td class=\"sps-table__cell text-right\">^15.7.2</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://reactjs.org/\">react</a></td><td class=\"sps-table__cell text-right\">^16.9.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://reactjs.org/\">react-dom</a></td><td class=\"sps-table__cell text-right\">^16.9.0</td></tr>\n<tr class=\"sps-table__row\"><td class=\"sps-table__cell\"><a href=\"https://scroll-into-view-if-needed.netlify.com\">scroll-into-view-if-needed</a></td><td class=\"sps-table__cell text-right\">^2.2.20</td></tr>\n        </tbody>\n    </table>\n    </div>\n    <div class=\"col-7\">\n        &nbsp;\n    </div>\n</div>\n\n[//]: # \"END_AUTOGENERATED\"\n"
+  }
 }

package/lib/utils/Provide.d.ts

@@ -1,24 +0,0 @@
-import * as React from "react";
-/**
- * This is the use case for Nested: wrapping JSX in a flat list of
- * multiple React context providers instead of creating a pyramid of doom.
- *
- * bindProps (see bindProps.tsx in this same directory) was
- * created to be used with this, so you can set props on the
- * providers, including and especially `value` on the built-in
- * context object's `.Provider` component.
- *
- * <Provide providers={[
- *   ProplessProviderFromALibrary,
- *   bindProps(MyReallyUsefulContext.Provider, { value: "foo" }),
- *   // ...etc
- * ]}>
- *   (component tree that will have access to context from these providers)
- * </Provide>
- */
-declare type ProvideProps = React.HTMLProps<HTMLDivElement> & {
-    providers?: React.ElementType[];
-};
-export declare const Provide: React.FC<ProvideProps>;
-export declare const SpsApp: React.FC<ProvideProps>;
-export {};

package/lib/utils/bindProps.d.ts

@@ -1,33 +0,0 @@
-import * as React from "react";
-/**
- * takes in an ElementType (e.g. a React component) and
- * returns a new version of that component where certain
- * props are ALWAYS set to predefined values regardless of
- * what is passed in.
- *
- * for example, consider the following component:
- * const Foo: React.FC<{
- *   a: string;
- *   b: string;
- * }> = function ({ a, b }) {
- *   return (
- *     <span>
- *       a is {a} and b is {b}
- *     </span>
- *   );
- * };
- *
- * <Foo a="dog" b="cat"/> would produce <span>a is dog and b is cat</span>
- *
- * But if you bind the prop a...
- * const FooWithBoundA = bindProps(Foo, { a: "parakeet" });
- *
- * then <FooWithBoundA a="dog" b="cat"/> will produce <span>a is parakeet and b is cat</span>
- *
- * The type of the props is the same, but prop a is always going to be overridden to its
- * bound value.
- *
- * This was created to be used with <Provide> (see Provide.tsx in this same directory),
- * but may have other use cases.
- */
-export declare function bindProps<T extends React.ElementType>(E: T, boundProps: Partial<React.ComponentProps<T>>, deps?: unknown[]): React.FC<React.ComponentProps<T>>;