@depict-ai/ui 1.0.16 → 1.0.17

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { JSX, Accessor, Setter, Signal } from "solid-js";
 import { Display, Elem, ColsAtSize, Node_Array } from "@depict-ai/utilishared";
+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";
@@ -7,13 +7,7 @@ import { SearchSuggestionsResponse, CategorySuggestion } from "@depict-ai/types/
 import { SearchSuggestionsRequest } from "@depict-ai/types/api/SearchSuggestionsRequest";
 import { ProductListingRequest } from "@depict-ai/types/api/ProductListingRequest";
 import { ProductListingResponse } from "@depict-ai/types/api/ProductListingResponse";
-export const version = "1.0.16";
-export function CrossIcon(props?: JSX.SvgSVGAttributes<SVGSVGElement>): SVGElement;
-/** @jsxImportSource solid-js */
-export function GenericSliderArrowButton(props?: {
-    width_?: number;
-    height_?: number;
-}): SVGElement;
+export const version = "1.0.17";
 export type OnNavigation = ((options: {
     is_replace: boolean;
     new_url: URL;
@@ -220,27 +214,6 @@ declare class SDKError extends Error {
 export class ProductCardError extends SDKError {
     constructor(templateError: Error);
 }
-/**
- * Base placeholder component used by ImagePlaceholder and TextPlaceholder
- */
-export function BasePlaceholder(props: {
-    style: JSX.CSSProperties;
-    class?: string;
-}): JSX.Element;
-/**
- * A Placeholder to use instead of some text, while it's loading. This is the inline version, meant to be embedded into sentences (or exist instead of them), etc.
- * If you want a block version, use `ImagePlaceholder` with `width`and `height` set instead.
- * @property height height of the placeholder. Set to `1em` by default.
- * @property width width of the placeholder. For specific number of characters use `ch`, ex: `width="7ch"`
- * @property class extra classes to add to the placeholder
- * @property style extra styles to add to the placeholder
- */
-export function TextPlaceholder(props: {
-    style?: JSX.CSSProperties;
-    height: string;
-    width: string;
-    class?: string;
-}): JSX.Element;
 /**
  * Disables scrolling until the solidjs reactive scoped is disposed (onCleanup)
  * @returns A cleanup function to manually re-enable scrolling.
@@ -249,7 +222,7 @@ export function disable_scrolling(): () => void;
 export const CategoryTitle: ({ category_title_, product_count_, }: {
     category_title_: Accessor<string | undefined>;
     product_count_: JSX.Element;
-}) => JSX.Element;
+}) => HTMLElement;
 /**
  * Embeds number of products between sort and filter buttons on mobile if possible, only supported for category pages right now. Pass it as category_title_ to Category.
  * Note: this will add an invisible element as first element in depict-search-page which will confuse the flex-gap SCSS mixin a bit so you'll get some extra spacing at the beginning of the search page
@@ -315,27 +288,6 @@ export function QuickLinks({ depict_category }: {
     depict_category: DepictCategory;
 }): HTMLElement;
 export function get_categories(tenant: string, market: string): Promise<string[]>;
-type ImagePlaceholderBaseOptions = {
-    style?: JSX.CSSProperties;
-    class?: string;
-};
-type ImagePlaceholderBlockOptions = {
-    width: string;
-    height: string;
-};
-type ImagePlaceholderImageOptions = {
-    aspectRatio: number;
-};
-/**
- * A placeholder that can be used instead of an image or other block of content while it's loading.
- * The placeholder has `display:block`, meaning it will create a new "row" in the layout for itself. Can be used either for images with a defined aspect ratio (ContainedImage) or blocks.
- * @property aspectRatio if aspectRatio is defined the placeholder will be in "image mode" and fill out the available width and then adjust the height according to the aspectRatio
- * @property width If width and height is set, the defined width and height will be used.
- * @property height If width and height is set, the defined width and height will be used.
- * @property class extra classes to add to the placeholder
- * @property style extra styles to add to the placeholder
- */
-export function ImagePlaceholder(props: ImagePlaceholderBaseOptions & (ImagePlaceholderBlockOptions | ImagePlaceholderImageOptions)): JSX.Element;
 export function DefaultInstantCardPlaceholder(): HTMLDivElement;
 /**
  * Useful for aligning the search modal to an element, like an existing input field
@@ -499,6 +451,28 @@ export interface BaseCategoryPageConfig extends BaseProductListingConfig {
      */
     showQuicklinks?: boolean;
 }
+/**
+ * Props for the TextPlaceholder component.
+ */
+export interface TextPlaceholderProps {
+    /**
+     * The height of the text, including a unit.
+     * @example "1em"
+     */
+    height: string;
+    /**
+     * The width of the text.
+     * @example "60px", "10em"
+     */
+    width: string;
+}
+/**
+ * Props for the ImagePlaceholder component.
+ */
+export interface ImagePlaceholderProps {
+    /** The aspect ratio of the image that will be displayed. */
+    aspectRatio: number;
+}
 type CenteredLocation = {
     location?: "centered";
 };
@@ -564,5 +538,5 @@ export const defaultGridSpacing = "2%";
 export const defaultCategoryTitlePlugin: ({ category_title_, product_count_, }: {
     category_title_: import("solid-js").Accessor<string | undefined>;
     product_count_: import("solid-js").JSX.Element;
-}) => import("solid-js").JSX.Element;
+}) => HTMLElement;
 export type { SearchFilter } from "@depict-ai/types/api/SearchRequest";