Widget catalog
→ Live demo — see every widget rendered in the browser.
Usage docs for every widget type WidgetCatalog.getScreen can render. Each page
covers the params a backend sends for that widget, an example JSON entry,
and any widget-specific behavior. Three contracts are shared across most
widgets and documented once:
- Action/tap contract — the
type/id/urlshape used to resolve navigation (IMAGE, SLIDER, MODAL, MIXEDCAROUSEL, STORY, ...). - Product query contract — the
paramsshapefetchProductsreceives (CAROUSEL, GRID, PRODUCTCARD, FLASHSALE, MIXEDCAROUSEL). - Product card data — the shape each product in a
fetchProductsresult should have.
Widgets
type |
Doc |
|---|---|
TEXT |
text.md |
DIVIDER |
divider.md |
IMAGE |
image.md |
IMAGELIST |
image-list.md |
SLIDER |
slider.md |
IMAGECAROUSEL |
image-carousel.md |
CAROUSEL |
carousel.md |
GRID |
grid.md |
PRODUCTCARD |
product-card.md |
FLASHSALE |
flash-sale.md |
MODAL |
modal.md |
MIXEDCAROUSEL |
mixed-carousel.md |
VIDEOLIST |
video-list.md |
STORY |
story.md |
VISITEDPRODUCTS |
visited-products.md |
TIMEIMAGE |
time-image.md |
YOUTUBE |
youtube.md |
SEARCH |
search.md |
FASTREGISTER |
fast-register.md |
RATING |
rating.md |
BUNDLE |
bundle.md |
COUPON |
coupon.md |
CATEGORYMENU |
category-menu.md |
LOYALTYPROGRESS |
loyalty-progress.md |
COMPARISON |
comparison.md |
| any other value | rendered as an empty 1px box (forward compatibility) |
For install and quick-start (WidgetCallbacks, WidgetCatalog.getScreen),
see the root README.