DocSpace-client/packages/components/catalog-item/README.md

2.8 KiB

CatalogItem

Is a item of catalog

Usage

import CatalogItem from "@docspace/components/catalog-item";
<CatalogItem />

Display catalog item. Can show only icon (showText property). If is it end of block - adding margin bottom.

Properties

Props Type Required Values Default Description
className string - - - Accepts class
id string - - - Accepts id
style obj, array - - - Accepts css style
icon string - - - Catalog item icon
text string - - - Catalog item text
showText bool - - false Tells when the catalog item should display text
onClick func - - - What the catalog item will trigger when clicked
showInitial bool - - false Tells when the catalog item should display initial text(first symbol of text)
isEndOfBlock bool - - false Tells when the catalog item should be end of block (adding margin-bottom)
isActive bool - - false Tells when the catalog item should be active (adding background color)
isDragging bool - - false Tells when the catalog item available for drag and drop
isDragActive bool - - false Tells when the catalog item active for drag and drop
showBadge bool - - false Tells when the catalog item should display badge
labelBadge string - - - Label for badge
iconBadge string - - - Icon for badge
onClickBadge func - - - What the catalog item badge will trigger when clicked