pixelize-design-library 2.4.2-beta.67 → 2.4.2-beta.69

package/dist/Components/PincodeChecker/PincodeCheckerProps.d.ts

@@ -4,6 +4,7 @@ export type PincodeStatus = "idle" | "checking" | "serviceable" | "unserviceable
 export interface PincodeResult {
     /** False means the pincode is not serviceable. */
     ok: boolean;
+    /** Shown after the pincode in the saved line, e.g. "560001 · Bengaluru". */
     city?: string;
     /** Ready-to-print delivery date such as "Thu, 8 Oct"; never a range of days. */
     deliveryBy?: string;
@@ -16,19 +17,29 @@ export interface PincodeResult {
 }
 /** Every string the checker renders; override all of them for another language. */
 export interface PincodeCheckerLabels {
+    /** Heading (h2) above the field. */
     heading: string;
+    /** Visually hidden label of the pincode input. */
     inputLabel: string;
+    /** Placeholder of the empty pincode input. */
     placeholder: string;
+    /** Text of the submit button. */
     check: string;
+    /** Text of the link button that reopens the field after a serviceable result. */
     change: string;
     /** Visible helper under the idle field. */
     hint: string;
+    /** Error under the field for a malformed pincode; `PincodeResult.message` replaces it when status is invalid. */
     invalid: string;
+    /** Headline for an unserviceable pincode; `PincodeResult.message` replaces it. */
     unserviceable: string;
+    /** Visually hidden announcement while a check is in flight. */
     checking: string;
     /** Prefix before the date, e.g. "Delivery by". */
     deliveryBy: string;
+    /** Line shown when the result has `cod: true`. */
     codAvailable: string;
+    /** Line shown when the result has `cod: false`; omitted when `cod` is undefined. */
     codUnavailable: string;
     /** Prefix in the saved line, e.g. "Deliver to". */
     deliverTo: string;
@@ -41,6 +52,7 @@ export interface PincodeCheckerProps {
     value?: string;
     /** Starting pincode when uncontrolled, e.g. the shopper's last one. */
     defaultValue?: string;
+    /** Fires on every edit with the digits-only value, capped at six digits. */
     onValueChange?: (pincode: string) => void;
     /** Controlled status; omit it and the checker derives the status from what `onCheck` resolves. */
     status?: PincodeStatus;
@@ -52,6 +64,7 @@ export interface PincodeCheckerProps {
     autoCheck?: boolean;
     /** Runs `onCheck` once on mount when the initial pincode is valid, for a saved pincode. */
     checkOnMount?: boolean;
+    /** Overrides for any label; unspecified strings keep the English defaults. */
     labels?: Partial<PincodeCheckerLabels>;
     "data-testid"?: string;
 }

package/dist/Components/PlanPill/PlanPill.d.ts

@@ -1,4 +1,5 @@
 import React from "react";
 import { PlanPillProps } from "./PlanPillProps";
+/** Gradient pill button with plan label, optional time-left chip and a tone-based icon; always renders a `<button>`. */
 declare const PlanPill: React.FC<PlanPillProps>;
 export default PlanPill;

package/dist/Components/PlanPill/PlanPill.js

@@ -15,6 +15,7 @@ const TONE_ICON = {
     warning: lucide_react_1.Clock,
     danger: lucide_react_1.AlertCircle,
 };
+/** Gradient pill button with plan label, optional time-left chip and a tone-based icon; always renders a `<button>`. */
 const PlanPill = ({ label, mobileLabel, status, tone = "normal", icon, gradient, maxLabelWidth = "150px", ariaLabel, onClick, }) => {
     const theme = (0, useCustomTheme_1.useCustomTheme)();
     const c = theme.colors;

package/dist/Components/PlanPill/PlanPillProps.d.ts

@@ -12,6 +12,7 @@ export interface PlanPillProps {
     mobileLabel?: string;
     /** Remaining time, e.g. `3mo left`. Rendered as an inset chip; omitted when empty. */
     status?: string;
+    /** Plan urgency; picks the theme gradient and default icon. Defaults to `normal`. */
     tone?: PlanPillTone;
     /** Leading icon. Defaults to a tone-appropriate lucide icon. Pass null to hide. */
     icon?: ElementType | null;

package/dist/Components/PriceBlock/PriceBlockProps.d.ts

@@ -23,10 +23,14 @@ export interface PriceBlockProps extends PriceFormat {
     mrp?: number;
     /** Shows "min – max" instead of a single price, e.g. for a product whose variants differ; hides the MRP and discount. */
     priceRange?: {
+        /** Lowest price, formatted first; equal to `max` shows a single price. */
         min: number;
+        /** Highest price, formatted after the dash. */
         max: number;
     };
+    /** Typography scale; defaults to "md". */
     size?: PriceBlockSize;
+    /** Alignment of the lines; defaults to "start". */
     align?: PriceBlockAlign;
     /** Adds a "You save ₹1,500" line under the price; needs `mrp`. */
     showSavings?: boolean;
@@ -34,6 +38,8 @@ export interface PriceBlockProps extends PriceFormat {
     taxNote?: string;
     /** A `unitPrice()` result (null renders nothing), or a ready-made string; rendered as "₹169.80 / 100 g". */
     unitPrice?: UnitPrice | string | null;
+    /** Overrides the default English copy; unset keys keep their default. */
     labels?: Partial<PriceBlockLabels>;
+    /** Test id on the block's root. */
     "data-testid"?: string;
 }

package/dist/Components/ProductBadges/ProductBadgesProps.d.ts

@@ -11,8 +11,11 @@ export interface ProductBadgesProps {
     badges: ProductBadge[];
     /** How many badges to show; a card carries at most two. */
     max?: number;
+    /** Chip height; defaults to `sm`. */
     size?: ProductBadgeSize;
+    /** Chip style; defaults to `solid`. Use `glass` over photos. */
     variant?: ProductBadgeVariant;
+    /** Stack direction; defaults to `vertical`, `horizontal` wraps onto new rows. */
     orientation?: ProductBadgesOrientation;
     "data-testid"?: string;
 }

package/dist/Components/ProductCard/ProductCardProps.d.ts

@@ -39,6 +39,7 @@ export interface ProductCardLabels {
 }
 /** Product card for listings, rails and search: media, brand, title, rating, price, swatches and one action; owns no product vocabulary beyond `axes`. */
 export interface ProductCardProps extends PriceFormat {
+    /** Product name; the title link or button text, and the card's accessible name. */
     title: string;
     /** Muted line above the title; own-brand stores omit it. */
     brand?: string;
@@ -54,6 +55,7 @@ export interface ProductCardProps extends PriceFormat {
     unitPrice?: UnitPrice | string | null;
     /** 0 to 5; the row is hidden when missing or 0, never rendered as "0 reviews". */
     rating?: number;
+    /** Review count shown beside the stars in compact form; has no effect when `rating` is missing or 0. */
     ratingCount?: number;
     /** Badges in priority order; at most two are drawn, and none on a sold-out card. */
     badges?: ProductBadge[];
@@ -77,8 +79,11 @@ export interface ProductCardProps extends PriceFormat {
     linkProps?: Omit<ComponentPropsWithoutRef<"a">, "href" | "onClick">;
     /** Makes the title a stretched button when there is no `href`, or runs beside navigation when there is. */
     onPress?: ProductCardPressHandler;
+    /** Card arrangement; defaults to `grid`. */
     layout?: ProductCardLayout;
+    /** Type, inset and control scale; defaults to `comfortable`. */
     density?: ProductCardDensity;
+    /** Media well ratio; defaults to `4/5`. */
     aspectRatio?: ProductCardAspectRatio;
     /** Overrides the action derived from the data (notify when sold out, options when an axis has choices, else add). */
     action?: ProductCardAction;
@@ -98,6 +103,7 @@ export interface ProductCardProps extends PriceFormat {
     onNotify?: () => void;
     /** Controlled wishlist state. */
     wishlisted?: boolean;
+    /** Fires with the new wishlist state when the heart is toggled. */
     onWishlistChange?: (wishlisted: boolean) => void;
     /** Marks the card as chosen (compare, bulk select): a ring on the media and a check, never colour alone. */
     selected?: boolean;
@@ -109,13 +115,17 @@ export interface ProductCardProps extends PriceFormat {
     meta?: ReactNode;
     /** Replaces the derived add control, keeping its footprint. */
     actions?: ReactNode;
+    /** Overrides for the card's own control copy; unspecified strings keep the English defaults. */
     labels?: Partial<ProductCardLabels>;
     "data-testid"?: string;
 }
 /** Skeleton with the card's box model; pass the same layout, density and ratio as the loaded cards. */
 export interface ProductCardSkeletonProps {
+    /** Card arrangement to mirror; defaults to `grid`. */
     layout?: ProductCardLayout;
+    /** Density to mirror; defaults to `compact`, unlike ProductCard's `comfortable`. */
     density?: ProductCardDensity;
+    /** Media well ratio to mirror; defaults to `4/5`. */
     aspectRatio?: ProductCardAspectRatio;
     "data-testid"?: string;
 }

package/dist/Components/ProductCard/QuickAddSheetProps.d.ts

@@ -17,12 +17,17 @@ export interface QuickAddSheetLabels {
 export type QuickAddPresentation = "auto" | "drawer" | "modal";
 /** Option picker shown before an add: the product, a `VariantSelector`, a quantity stepper and a confirm button naming the total. */
 export interface QuickAddSheetProps extends PriceFormat {
+    /** Whether the sheet is shown; each time it opens, selection resets to `defaultSelection` and quantity to 1. */
     isOpen: boolean;
+    /** Fires on dismissal (close button, overlay or Escape); also required to close after `onConfirm`. */
     onClose: () => void;
+    /** Product name shown beside the thumbnail and used to label the quantity stepper. */
     title: string;
+    /** Muted line above the title; omitted when absent. */
     brand?: string;
     /** Thumbnail beside the title. */
     media?: ProductMedia;
+    /** Option axes the shopper picks from; each must be chosen before confirming. */
     axes: OptionAxis[];
     /** Availability and the confirm total are derived from these. */
     variants: ProductVariant[];
@@ -30,9 +35,12 @@ export interface QuickAddSheetProps extends PriceFormat {
     defaultSelection?: VariantSelection;
     /** Fires with the chosen variant and quantity; the sheet does not close itself. */
     onConfirm: (variant: ProductVariant, quantity: number) => void;
+    /** How the sheet opens; defaults to `auto`. */
     presentation?: QuickAddPresentation;
     /** Merged over the drawer panel defaults, e.g. `{ maxW: "390px !important", mx: "auto" }` inside a phone-width frame; the slide sets an inline max-width. */
     drawerContentProps?: DrawerContentProps;
+    /** Overrides for the sheet copy; unspecified strings keep the English defaults. */
     labels?: Partial<QuickAddSheetLabels>;
+    /** Set on the sheet body wrapper, not on the dialog root. */
     "data-testid"?: string;
 }

package/dist/Components/ProductDetails/ProductDetailsProps.d.ts

@@ -9,10 +9,15 @@ import type { SpecItem } from "../SpecTable/SpecTableProps";
 import type { TrustItem } from "../TrustBadges/TrustBadgesProps";
 /** The catalogue record the page renders; structurally compatible with a store's product so it can be passed straight through. */
 export interface ProductDetailsProduct {
+    /** Page h1 and the accessible name of the quantity stepper and sticky bar. */
     title: string;
+    /** Muted line above the title. */
     brand?: string;
+    /** Body of the Description section. */
     description?: string;
+    /** Bullet list for the Highlights section. */
     highlights?: string[];
+    /** Rows of the Specifications section. */
     specs?: SpecItem[];
     /** Every frame the product has; variants and `mediaIdsByOption` pick which ones show. */
     media: ProductMedia[];
@@ -22,9 +27,11 @@ export interface ProductDetailsProduct {
     variants: ProductVariant[];
     /** Price shown until a variant is picked, and the fallback when a variant carries none. */
     price: number;
+    /** List price struck through beside `price`; a picked variant's own `mrp` replaces it. */
     mrp?: number;
     /** Average rating, 0 to 5. */
     rating?: number;
+    /** Number of ratings beside the stars; also keeps the reviews section when `reviews` is omitted. */
     ratingCount?: number;
     /** Corner badges on the gallery, e.g. "Bestseller". */
     badges?: ProductBadge[];
@@ -37,18 +44,24 @@ export interface ProductDetailsProduct {
     mediaIdsByOption?: Record<string, string[]>;
     /** Shipping and returns copy for the details section. */
     returnsNote?: string;
+    /** Country of origin line in the legal block of the details section. */
     originCountry?: string;
+    /** Manufacturer line in the legal block of the details section. */
     manufacturer?: string;
     /** Legal-metrology net quantity such as "500 g". */
     netQuantity?: string;
 }
-/** `auto` follows the viewport: two columns from 1024px up, the single-column phone page with a sticky buy bar below it. */
+/** `auto` follows the component's own width (two columns from 960px, else the single-column phone page with a sticky buy bar); the window decides only until the first measure. */
 export type ProductDetailsLayout = "auto" | "desktop" | "mobile";
 /** Every string the page itself renders; sub-components take their own `labels` through their prop pass-throughs. */
 export interface ProductDetailsLabels {
+    /** Primary button text when the chosen variant can be bought. */
     addToBag: string;
+    /** Text of the secondary button shown when `onBuyNow` is set. */
     buyNow: string;
+    /** Primary button text when the chosen variant, or every variant, is sold out. */
     notifyMe: string;
+    /** Primary button text after the add confirmation, when `onGoToBag` is set. */
     goToBag: string;
     /** Short confirmation in the button right after an add. */
     added: string;
@@ -58,23 +71,30 @@ export interface ProductDetailsLabels {
     addFailed: string;
     /** Prompt for an unpicked axis, given its lower-cased label: "Select a size". */
     selectPrompt: (axisLabel: string) => string;
+    /** Line under the price, e.g. "Inclusive of all taxes". */
     taxNote: string;
     /** Accessible name of the rating link that scrolls to the reviews. */
     jumpToReviews: (ratingText: string) => string;
+    /** Accessible name of the share button; shown only when `onShare` is set. */
     share: string;
+    /** Label of the wishlist toggle. */
     wishlistSave: string;
 }
 /** The composed product page: gallery, buy panel, details and reviews, wired so the picked variant drives price, stock, frames and the primary action. */
 export interface ProductDetailsProps extends PriceFormat {
+    /** Catalogue record to render; changing it re-derives variants, frames and price. */
     product: ProductDetailsProduct;
     /** Controlled selection, axis id to option value id; nothing is preselected, because a size the shopper never chose is a wrong order. */
     selection?: VariantSelection;
+    /** Starting selection when uncontrolled, axis id to option value id. */
     defaultSelection?: VariantSelection;
     /** Receives the new selection and the matching variant, or undefined while it is incomplete. */
     onSelectionChange?: (selection: VariantSelection, variant: ProductVariant | undefined) => void;
     /** Controlled quantity, clamped to the variant's remaining stock and `maxQuantity`. */
     quantity?: number;
+    /** Starting quantity when uncontrolled; defaults to 1 and is clamped to the ceiling. */
     defaultQuantity?: number;
+    /** Fires with the new quantity after the stepper changes it. */
     onQuantityChange?: (quantity: number) => void;
     /** Per-order ceiling; the variant's remaining stock lowers it further. */
     maxQuantity?: number;
@@ -90,7 +110,9 @@ export interface ProductDetailsProps extends PriceFormat {
     addedDuration?: number;
     /** Controlled wishlist state; pair with `onWishlistChange`. */
     wishlisted?: boolean;
+    /** Starting wishlist state when uncontrolled. */
     defaultWishlisted?: boolean;
+    /** Fires with the new wishlist state when the toggle is pressed. */
     onWishlistChange?: (wishlisted: boolean) => void;
     /** Shows a share button beside the title. */
     onShare?: () => void;
@@ -140,6 +162,8 @@ export interface ProductDetailsProps extends PriceFormat {
     relatedSlot?: ReactNode;
     /** Skeleton in place of the gallery and buy panel. */
     isLoading?: boolean;
+    /** Overrides for the page copy; unspecified strings keep the English defaults. */
     labels?: Partial<ProductDetailsLabels>;
+    /** Set on the page root, which also carries `data-layout` of `desktop` or `mobile`. */
     "data-testid"?: string;
 }

package/dist/Components/ProfileCard/ProfileCardProps.d.ts

@@ -5,7 +5,7 @@ export type ProfileCardVariant = "elevated" | "outline" | "filled" | "unstyled";
 export type ProfileCardVariantLegacy = "outlein";
 /** borderTopColor/borderLeftColor are booleans toggling a fixed accent border color, not custom-color props; borderLeftColor wins if both are true. */
 export type ProfileCardProps = Pick<CardProps, "direction" | "maxW" | "align" | "justify" | "overflow"> & {
-    /** Only ProfileCardHeader/Body/Footer children render, matched by type one fragment deep; any other sibling is dropped. */
+    /** Only ProfileCardHeader/Body/Footer children render, matched by type through nested Fragments; any other sibling is dropped. */
     children: React.ReactNode;
     /** Chakra Card variant; "outlein" is mapped to "outline". */
     variant?: ProfileCardVariant | ProfileCardVariantLegacy;

package/dist/Components/QuantityStepper/QuantityStepperProps.d.ts

@@ -4,21 +4,30 @@ export type QuantityStepperSize = "sm" | "md" | "lg";
 export type QuantityStepperVariant = "soft" | "outline";
 /** Compact − qty + control. Display only: the number is never typed, which keeps it fast on mobile. */
 export interface QuantityStepperProps {
+    /** Controlled quantity; pair with `onValueChange`. */
     value?: number;
+    /** Starting quantity when uncontrolled; defaults to `min`. */
     defaultValue?: number;
+    /** Fires with the new clamped quantity after a plus or minus press; not fired when a limit blocks the change. */
     onValueChange?: (value: number) => void;
     /** Lowest value; defaults to 1. At the floor the minus button is aria-disabled. */
     min?: number;
     /** Highest value; omit for no ceiling. At the ceiling the plus button is aria-disabled. */
     max?: number;
+    /** Amount added or removed per press; defaults to 1. */
     step?: number;
+    /** Control height; defaults to `md`. */
     size?: QuantityStepperSize;
+    /** Surface style; defaults to `soft`. */
     variant?: QuantityStepperVariant;
     /** At `min` the minus becomes a trash button that calls onRemove, for cart lines. */
     removable?: boolean;
+    /** Fires when the trash button is pressed at `min`; only reachable with `removable`. */
     onRemove?: () => void;
+    /** Dims the stepper and disables both buttons. */
     disabled?: boolean;
     /** Product name, so the group reads "Quantity of Slim-Fit Denim Jacket". */
     itemLabel?: string;
+    /** Set on the group; the buttons get `<id>-dec` and `<id>-inc`. */
     "data-testid"?: string;
 }

package/dist/Components/QueryState/QueryStateProps.d.ts

@@ -18,6 +18,7 @@ export interface ErrorStateProps {
     action?: ReactNode;
     /** Passed to EmptyState; defaults to "md". */
     size?: EmptyStateProps["size"];
+    /** Minimum height of the panel, passed to EmptyState. */
     minH?: EmptyStateProps["minH"];
 }
 /** Copy for the no-access panel; each field falls back to a generic default. */
@@ -65,5 +66,6 @@ export interface QueryStateBoundaryProps {
     isRetrying?: boolean;
     /** Min height of the error and empty states, not loading; defaults to "24rem". */
     minH?: EmptyStateProps["minH"];
+    /** Content for the ready state; pass a function to read data only when it exists. */
     children: ReactNode | (() => ReactNode);
 }

package/dist/Components/RadioButton/RadioButtonProps.d.ts

@@ -47,7 +47,7 @@ export type ChakraRadioGroupProps = Pick<RadioGroupProps, "size" | "colorScheme"
     id?: string;
     /** Marks every radio invalid and shows `errorMessage` in place of `helperText`. */
     error?: boolean;
-    /** Shown under the group while `error` is true; falls back to "Error". */
+    /** Shown under the group while `error` is true. */
     errorMessage?: string;
     /** Shown under the group when there is no error; linked via aria-describedby. */
     helperText?: string;

package/dist/Components/Rating/RatingProps.d.ts

@@ -8,6 +8,7 @@ export interface RatingProps {
     defaultValue?: number;
     /** Number of stars. */
     max?: number;
+    /** Star glyph size; defaults to "sm". */
     size?: RatingSize;
     /** Shows the numeric value ("4.6") after the stars. */
     showValue?: boolean;
@@ -23,5 +24,6 @@ export interface RatingProps {
     isDisabled?: boolean;
     /** Overrides the accessible name; the group name in interactive mode, the "Rated 4.6 out of 5" text otherwise. */
     "aria-label"?: string;
+    /** Test id on the outermost element, in both read-only and interactive modes. */
     "data-testid"?: string;
 }

package/dist/Components/Reorder/ReorderProps.d.ts

@@ -1,16 +1,22 @@
 /** Minimal shape for a draggable tile — previewUrl renders as the thumbnail image; name is only used as its alt-text fallback (else "item-<1-based position>", matching the ordinal badge). */
 export interface ReorderItem {
+    /** Stable unique key; used as the drag identity and passed to `onRemove`. */
     id: string;
+    /** Image URL rendered as the tile thumbnail. */
     previewUrl: string;
+    /** Alt text of the thumbnail; falls back to "item-<position>". */
     name?: string;
 }
 /** Props for the horizontal drag-reorderable row of image tiles (ReorderList). */
 export interface ReorderListProps<T extends ReorderItem> {
+    /** Heading in uppercase beside the icon above the tiles; empty by default. */
     label?: string;
+    /** Tiles in display order; the list is controlled, so update it from `onReorder`. */
     items: T[];
     /** Fires on every completed drag, even a drop back at the start index — diff the array to detect a real change. */
     onReorder: (items: T[]) => void;
     /** Renders a per-tile "Remove" button; requires onRemove to do anything. */
     showRemoveIcon?: boolean;
+    /** Receives the id of the tile whose remove button was pressed; the list does not remove it itself. */
     onRemove?: (id: string) => void;
 }

package/dist/Components/ReviewList/ReviewListProps.d.ts

@@ -1,20 +1,28 @@
 import type { ReactNode } from "react";
 /** A photo attached to a review. */
 export interface ReviewMedia {
+    /** Stable React key for the photo. */
     id: string;
+    /** Image URL, shown as a lazy-loaded 72px thumbnail. */
     src: string;
+    /** Alt text; falls back to `labels.photoAlt` with the author's name. */
     alt?: string;
 }
 /** One customer review. */
 export interface ReviewItem {
+    /** Stable key for the review; passed to `onHelpful` and used for expand and helpful state. */
     id: string;
+    /** Reviewer name shown in the byline and in the fallback photo alt text. */
     author: string;
+    /** Reviewer's city, shown after the author name when given. */
     city?: string;
     /** Whole stars, 1 to 5. */
     rating: number;
     /** ISO date such as "2026-09-21"; formatted per `locale`, and shown as given when it is not a valid date. */
     date: string;
+    /** Heading beside the stars; omitted when empty. */
     title?: string;
+    /** Review text; clamped to four lines when longer than `clampChars`. */
     body: string;
     /** Adds the "Verified purchase" marker. */
     verified?: boolean;
@@ -22,18 +30,26 @@ export interface ReviewItem {
     helpful?: number;
     /** Variant the reviewer bought, e.g. "M". */
     purchasedSize?: string;
+    /** Photos shown as thumbnails under the body. */
     media?: ReviewMedia[];
 }
 /** Every string the list renders; override all of them for another language. */
 export interface ReviewListLabels {
+    /** Marker text shown when a review is `verified`. */
     verified: string;
     /** Button name, given the vote count. */
     helpful: (count: number) => string;
+    /** Toggle text on a clamped body. */
     readMore: string;
+    /** Toggle text on an expanded body. */
     readLess: string;
+    /** Load-more button text. */
     loadMore: string;
+    /** Load-more button text while `isLoadingMore`. */
     loadingMore: string;
+    /** Heading of the default empty state. */
     emptyTitle: string;
+    /** Supporting text of the default empty state. */
     emptyBody: string;
     /** Detail line, given the size the reviewer bought. */
     purchasedSize: (size: string) => string;
@@ -46,6 +62,7 @@ export interface ReviewListLabels {
 }
 /** Customer reviews with verified marker, helpful votes, clamped long bodies, a sort slot and load-more paging. */
 export interface ReviewListProps {
+    /** Reviews to render in order; an empty list shows the empty state. */
     reviews: ReviewItem[];
     /** Fires with the review id when "Helpful" is pressed; the button then shows as pressed and the count rises by one. */
     onHelpful?: (reviewId: string) => void;
@@ -55,6 +72,7 @@ export interface ReviewListProps {
     sortSlot?: ReactNode;
     /** Shows the "Load more" button. */
     hasMore?: boolean;
+    /** Fires when "Load more" is pressed; the parent appends the next page to `reviews`. */
     onLoadMore?: () => void;
     /** Shows skeleton rows in place of the reviews. */
     isLoading?: boolean;
@@ -62,7 +80,10 @@ export interface ReviewListProps {
     isLoadingMore?: boolean;
     /** Replaces the default empty state. */
     emptyState?: ReactNode;
+    /** Locale for review dates; defaults to en-IN, and an invalid locale falls back to it. */
     locale?: string;
+    /** Partial overrides of the default English strings. */
     labels?: Partial<ReviewListLabels>;
+    /** Test id on the root section; each review row also carries `review-<id>`. */
     "data-testid"?: string;
 }

package/dist/Components/ReviewSummary/ReviewSummaryProps.d.ts

@@ -2,11 +2,15 @@
 export type RatingBreakdown = Record<1 | 2 | 3 | 4 | 5, number>;
 /** Every string the summary renders; override all of them for another language. */
 export interface ReviewSummaryLabels {
+    /** Section heading text. */
     heading: string;
+    /** Text of the write-a-review button. */
     writeReview: string;
     /** Count line, given the total number of ratings. */
     ratings: (count: number) => string;
+    /** Heading of the no-ratings state. */
     emptyTitle: string;
+    /** Invitation text of the no-ratings state. */
     emptyBody: string;
     /** Accessible name of one bar, given the star level and the share as a whole percentage. */
     bar: (stars: number, percent: number) => string;
@@ -19,13 +23,16 @@ export interface ReviewSummaryProps {
     count: number;
     /** Counts per star; the bars show each row's share of their sum. */
     breakdown?: RatingBreakdown;
-    /** The distribution only appears at or above this many ratings, because bars on a handful of ratings mislead. */
+    /** The distribution only appears at or above this many ratings, because bars on a handful of ratings mislead; defaults to 10. */
     minRatingsForBars?: number;
     /** Shows a "Write a review" button when provided. */
     onWriteReview?: () => void;
     /** Heading element id, so a "4.6 (412)" link elsewhere can scroll here and a region can be labelled by it. */
     id?: string;
+    /** Locale for number formatting; defaults to en-IN. */
     locale?: string;
+    /** Partial overrides of the default English strings. */
     labels?: Partial<ReviewSummaryLabels>;
+    /** Test id on the root section. */
     "data-testid"?: string;
 }