@spscommerce/ds-react 5.25.0 → 5.26.0

package/lib/utils/Provide.d.ts

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,33 @@
+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>>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spscommerce/ds-react",
   "description": "SPS Design System React components",
-  "version": "5.25.0",
+  "version": "5.26.0",
   "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.25.0",
-    "@spscommerce/ds-illustrations": "5.25.0",
-    "@spscommerce/ds-shared": "5.25.0",
-    "@spscommerce/positioning": "5.25.0",
-    "@spscommerce/utils": "5.25.0",
+    "@spscommerce/ds-colors": "5.26.0",
+    "@spscommerce/ds-illustrations": "5.26.0",
+    "@spscommerce/ds-shared": "5.26.0",
+    "@spscommerce/positioning": "5.26.0",
+    "@spscommerce/utils": "5.26.0",
     "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.25.0",
-    "@spscommerce/ds-illustrations": "5.25.0",
-    "@spscommerce/ds-shared": "5.25.0",
-    "@spscommerce/positioning": "5.25.0",
-    "@spscommerce/utils": "5.25.0",
+    "@spscommerce/ds-colors": "5.26.0",
+    "@spscommerce/ds-illustrations": "5.26.0",
+    "@spscommerce/ds-shared": "5.26.0",
+    "@spscommerce/positioning": "5.26.0",
+    "@spscommerce/utils": "5.26.0",
     "@testing-library/react": "^9.3.2",
     "@types/prop-types": "^15.7.1",
     "@types/react": "^16.9.0",