Home > @poq/sdk-sfcc > Category
Document representing a category.
Signature:
export declare class Category extends BaseModel<Category>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Category class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| cAlternativeUrl? | string | (Optional) Renders an alternative URL in main navigation. Uses Commerce Cloud content url notation. For example: $url(’Account-Show’)$ or normal URL http://xchange.demandware.com | |
| categories? | Array<Category> | (Optional) Array of subcategories. Can be empty. | |
| cCatBannerID? | string | (Optional) Used to define the content asset used to populate a grid page banner for a category. This value is applied to all sub-category navigation (cascading) if no specific catBannerID has been defined for a sub-category. | |
| cCustomCSSFile? | string | (Optional) Use this attribute to apply custom styles for this category. | |
| cEnableCompare? | boolean | (Optional) Used to define if/when the Compare feature is to be visualized in the storefront based on navigation. If enableCompare = FALSE, no Compare checkboxes will be displayed in the grid view. If enableCompare = TRUE, the category (and its children) will support the Compare feature. | |
| cHeaderMenuBanner? | string | (Optional) | |
| cHeaderMenuOrientation? | CategoryCHeaderMenuOrientationEnum | (Optional) Which way to orient the menu and optional header menu HTML. Vertical will list all in one line. Horizontal will list in columns. | |
| cShowInMenu? | boolean | (Optional) Used to indicate that a category (such as Mens -> Footwear -> Boots) will display in the roll-over navigation. A sub-category only shows if also the parent category is marked as showInMenu. Up to three category levels are shown in roll-over navigation. | |
| cSizeChartID? | string | (Optional) Used to define the content asset ID of the Size Chart that is appropriate for products whose PRIMARY category is the associated category (and its children). Whenever a product detail page (or quick view) is rendered, the Size Chart link is populated based on the value of this attribute for the products primary categorization. If not defined, NO size chart link is displayed. | |
| cSlotBannerHtml? | string | (Optional) | |
| cSlotBannerImage? | string | (Optional) Image used on either the top or bottom slot on the category landing pages. | |
| description? | string | (Optional) The localized description of the category. | |
| id? | string | (Optional) The id of the category. | |
| image? | string | (Optional) The URL to the category image. | |
| name? | string | (Optional) The localized name of the category. | |
| pageDescription? | string | (Optional) The localized page description of the category. | |
| pageKeywords? | string | (Optional) The localized page keywords of the category. | |
| pageTitle? | string | (Optional) The localized page title of the category. | |
| parentCategoryId? | string | (Optional) The id of the parent category. | |
| parentCategoryTree? | Array<PathRecord> | (Optional) List of parent categories | |
| thumbnail? | string | (Optional) The URL to the category thumbnail. |