@depict-ai/react-ui 0.0.37 → 0.0.38

package/dist/index.d.ts

@@ -4,47 +4,138 @@ import { useNavigate } from "react-router";
 import { Display } from "@depict-ai/utilishared";
 import { SDKColsAtSize, SDKGridSpacing } from "@depict-ai/ui";
 export function DepictSearchField(): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+/**
+ * The props for the DepictProvider.
+ */
 type BaseSearchConfig = {
+    /**
+     * The market to use for the search.
+     * @example "se"
+     * @example "no"
+     */
     merchant: string;
+    /**
+     * The merchant to use for the search.
+     * @example "se"
+     * @example "no"
+     * @example "dk"
+     */
     market: string;
+    /**
+     * The path to the search page.
+     * @example "/search"
+     * @example "/sok"
+     */
     searchPagePath: string;
+    /**
+     * The name of the url parameter that will be used for the search query.
+     * @example "q"
+     * @example "search_query"
+     * @default "search_query"
+     */
     urlParamName?: string;
+    /**
+     * Whether or not to enable category suggestions.
+     * @default false
+     */
     enableCategorySuggestions?: boolean;
 };
+/**
+ *
+  If react-router does not exist, useNavigate will fall back to "any".
+  In that case, the ReactRouterUseNavigate type becomes "never" and cannot be used.
+ */
 type ReactRouterUseNavigate = any extends typeof useNavigate ? never : typeof useNavigate;
-type SearchConfig = BaseSearchConfig | ({
-    onNavigation: (href: string, shallow?: boolean) => unknown;
-    reactRouterUseNavigate?: undefined;
-} & BaseSearchConfig) | ({
-    reactRouterUseNavigate: ReactRouterUseNavigate;
-    onNavigation?: undefined;
-} & BaseSearchConfig);
+/**
+ * The function that will be called when the user navigates to a new page.
+ * @param href - The href of the new page.
+ * @param shallow - Whether or not the navigation should be shallow.
+ * @returns {unknown}
+ */
+type OnNavigation = (href: string, shallow?: boolean) => unknown;
+type SearchConfig = BaseSearchConfig & {
+    onNavigation?: OnNavigation;
+    reactRouterUseNavigate?: ReactRouterUseNavigate;
+};
+/**
+ * The DepictProvider is a wrapper component that should be used to wrap your entire application.
+ * @param props - The props for the DepictProvider.
+ * @returns {JSX.Element}
+ */
 export function DepictProvider(props: PropsWithChildren<SearchConfig>): import("react").FunctionComponentElement<{
     children?: import("react").ReactNode;
 }>;
+/**
+ * A search header alignment component.
+ * @returns {JSX.Element}
+ */
 export function DepictSearchHeader(): import("react").DetailedReactHTMLElement<{
     className: string;
     ref: (e: HTMLElement | null) => HTMLElement | null;
 }, HTMLElement>;
+/**
+ * Opens the search modal.
+ * @returns {void}
+ */
 export function openModal(): void;
+/**
+ * The Depict product card props.
+ */
 export interface DepictProductCardProps<T extends Display> {
     display: T | null;
 }
+/**
+ * Depict product card
+ */
 export type DepictProductCard<T extends Display> = (props: DepictProductCardProps<T>) => ReactNode;
 interface SearchPageConfig<T extends Display> {
+    /**
+     * The product card to use for rendering products.
+     */
     productCard: DepictProductCard<T>;
+    /**
+     * How many columns to show at each media size.
+     * @default { [[4], [3, 1024], [2, 901]] }
+     */
     columnsAtSize?: SDKColsAtSize;
+    /**
+     * The spacing between products.
+     */
     gridSpacing?: SDKGridSpacing;
+    /**
+     * Whether or not to show the search input field.
+     * @default true
+     */
     includeInputField?: boolean;
 }
+/**
+ * DepictSearchPage is a component that renders a search page.
+ * @param opts
+ * @returns {JSX.Element}
+ */
 export function DepictSearchPage<T extends Display>(opts: SearchPageConfig<T>): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+/**
+ * Props for the ImagePlaceholder component
+ */
 interface ImagePlaceholderProps {
+    /** The aspect ratio of the image */
     aspectRatio: number;
 }
+/**
+ * A placeholder image that can be used in place of an image that is loading
+ * @param props
+ * @returns
+ */
 export const ImagePlaceholder: React.FC<ImagePlaceholderProps>;
+/**
+ * Props for the TextPlaceholder component
+ */
 interface TextPlaceholderProps {
+    /** The height of the text */
     height: string;
+    /** The width of the text */
     width: string;
 }
+/** A placeholder text that can be used in place of a text that is loading */
 export const TextPlaceholder: React.FC<TextPlaceholderProps>;
-export const version = "0.0.37";
+export const version = "0.0.38";

package/dist/main.js

@@ -351,7 +351,7 @@ const $afce04c26b0c4208$export$89c6019e4baa40b1 = ({ width: width , height: heig
 };
 
 
-const $db7b67857900028b$export$83d89fbfd8236492 = "0.0.37";
+const $db7b67857900028b$export$83d89fbfd8236492 = "0.0.38";
 
 
 

package/dist/module.js

@@ -339,7 +339,7 @@ const $8aa3ab31237c8dc9$export$89c6019e4baa40b1 = ({ width: width , height: heig
 };
 
 
-const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "0.0.37";
+const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "0.0.38";
 
 
 

package/dist-server/index.d.ts

@@ -1,4 +1,4 @@
-export const version = "0.0.37";
+export const version = "0.0.38";
 export function DepictProvider(props: any): any;
 export function DepictSearchField(): any;
 export function DepictSearchPage(): any;

package/dist-server/main.js

@@ -15,7 +15,7 @@ $parcel$export(module.exports, "openModal", () => $41e7e5d85b5e0d49$export$a7f6c
 $parcel$export(module.exports, "version", () => $db7b67857900028b$export$83d89fbfd8236492);
 
 
-const $db7b67857900028b$export$83d89fbfd8236492 = "0.0.37";
+const $db7b67857900028b$export$83d89fbfd8236492 = "0.0.38";
 
 
 function $41e7e5d85b5e0d49$export$9fac37a9c21c2f3b(props) {

package/dist-server/module.js

@@ -3,7 +3,7 @@ import {jsx as $1RlIW$jsx} from "react/jsx-runtime";
 
 
 
-const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "0.0.37";
+const $c9c4d066f9a5b51b$export$83d89fbfd8236492 = "0.0.38";
 
 
 function $2b1fdeb83610500f$export$9fac37a9c21c2f3b(props) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@depict-ai/react-ui",
-  "version": "0.0.37",
+  "version": "0.0.38",
   "packageManager": "yarn@3.2.2",
   "source": "src/index.ts",
   "main": "dist/main.js",
@@ -83,8 +83,8 @@
     "/dist-server"
   ],
   "dependencies": {
-    "@depict-ai/ui": "^0.0.15",
-    "@depict-ai/utilishared": "^0.0.13",
+    "@depict-ai/ui": "^0.0.16",
+    "@depict-ai/utilishared": "^0.0.14",
     "solid-js": "^1.6.2"
   },
   "peerDependencies": {