@depict-ai/ui 1.3.2 → 1.3.4

package/dist/index.d.ts

@@ -1,13 +1,44 @@
-import { Display, ModernDisplay, Node_Array, Elem, ColsAtSize } from "@depict-ai/utilishared";
+import { Signal, JSX, Accessor, Setter } from "solid-js";
+import { ColsAtSize, Display, ModernDisplay, Node_Array, Elem } from "@depict-ai/utilishared";
 import { BaseCategoryDisplay, ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
 import { CategorySuggestion, SearchSuggestionsResponse } from "@depict-ai/types/api/SearchSuggestionsResponse";
-import { JSX, Accessor, Setter, Signal } from "solid-js";
 import { SearchResponse } from "@depict-ai/types/api/SearchResponse";
 import { SearchRequest, SearchFilter } from "@depict-ai/types/api/SearchRequest";
 import { BaseSearchRequest } from "@depict-ai/types/api/BaseSearchRequest";
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
-export const version = "1.3.2";
+export const version = "1.3.4";
+declare class SDKError extends Error {
+}
+export class ProductCardError extends SDKError {
+    constructor(templateError: Error);
+}
+export type SolidLayoutOptions = {
+    cols_at_size: ColsAtSize;
+    grid_spacing: string;
+    rows: {
+        start_rows?: number;
+        rows_per_click?: number;
+        currently_visible?: Signal<number>;
+        max_rows?: number;
+        button?: JSX.Element;
+    } | "all";
+    layout: "slider" | "grid";
+    disable_partial_rows?: boolean;
+    override_vertical_spacing?: string;
+    children: JSX.Element;
+    element_attributes: JSX.HTMLAttributes<HTMLDivElement>;
+};
+/**
+ * Grid: Calculates CSS for a grid with a certain spacing and certain number of columns at certain screen sizes, including a view more button. All properties are reactive.
+ * @property       rows                  if set to 'all': Just generate grid styling without any viewing/hiding functionality. If an object: start_rows is the number of rows at the beginning. rows_per_click is the amount of rows to view on each view more button click. button is the view more button to display. currently_visible is a signal that you can use to get and set the number of currently viewed rows
+ * @property       cols_at_size          An array with sub arrays looking like this: `[n_cols, min_width_media_query, max_width_media_query, grid_spacing_for_size]`, everything after `[n_cols, min_width]` is optional. falsey value for `min_width = no min_width`
+ * @property       grid_spacing  spacing to use if none is specified for the specific size in `cols_at_size`
+ * @property       disable_partial_rows  If set to `true`, will not let user press "show more" if next row is a partial row. Example of partial row: `cols_at_size` says we should have 4 recs in the next row, but we only have 2 left, so the row just gets 2 instead of 4, meaning it doesn't "fill out".
+ * @property override_vertical_spacing by default, the grid_spacing is used both horizontally and vertically, with this you can specify a separate spacing
+ * @return An accessor containing a CSS string
+ */
+export function SolidLayout(props: SolidLayoutOptions): JSX.Element;
 type PageURLCreatorAlwaysThereData = {
     merchant: string;
     market: string;
@@ -307,11 +338,6 @@ export function show_toast({ children, on_close_, close_after_, ...more_attribut
 } & JSX.HTMLAttributes<HTMLDivElement>): {
     close_toast_: VoidFunction;
 };
-declare class SDKError extends Error {
-}
-export class ProductCardError extends SDKError {
-    constructor(templateError: Error);
-}
 /**
  * Base placeholder component used by ImagePlaceholder and TextPlaceholder
  */
@@ -407,7 +433,7 @@ export class DepictCategory<InputDisplay extends Display, OutputDisplay extends
     set on_navigation(new_function: OnNavigation);
     constructor({ api, on_navigation, page_url_creator, ...props_on_class }: DepictCategoryConstructorOptions<InputDisplay, OutputDisplay>);
 }
-export function CategoryPage<OriginalDisplay extends Display, OutputDisplay extends ModernDisplay | never>({ depict_category, grid_spacing, cols_at_size, product_card_template, show_breadcrumbs, show_quicklinks, category_title, }: {
+export function CategoryPage<OriginalDisplay extends Display, OutputDisplay extends ModernDisplay | never>(props: {
     depict_category: DepictCategory<OriginalDisplay, OutputDisplay>;
     grid_spacing: SDKGridSpacing;
     cols_at_size: SDKColsAtSize;
@@ -545,7 +571,7 @@ interface SearchFieldParams {
     click_handler?: (this: HTMLDivElement, ev: MouseEvent) => any;
     aligner_ref?: HTMLElement | null;
 }
-export function SearchField({ depict_search, modal_dispose_handler, click_handler, aligner_ref, }: SearchFieldParams): import("@depict-ai/utilishared").Node_Array;
+export function SearchField(props: SearchFieldParams): import("@depict-ai/utilishared").Node_Array;
 export type BaseProviderConfig<InputDisplay extends Display, PossibleTransformedDisplay extends ModernDisplay | never> = {
     /**
      * The merchant to use for the search.