Reference
Deprecated APIs
What is deprecated, and what replaces it.
Everything the source marks @deprecated, with the replacement it names. Deprecated APIs still work; the 0.2.0 ones are removed in 1.0.0 (see Migration).
Deprecated
| API | Kind | Replacement and notes |
|---|---|---|
CONSOLE_STATUSES | Constant | Since 0.2.0: use TRNDR_STATUSES (the same table) or the BricksProvider's statuses. Removed in 1.0. |
ConsoleStatus | Type | Since 0.2.0: use keyof typeof TRNDR_STATUSES, or string with the provider's statuses. Removed in 1.0. |
CURRENCY | Constant | Since 0.2.0: use TRNDR_CURRENCY.label or the BricksProvider's currency. Removed in 1.0. |
DetailsDrawer | Component | Since 0.5.0: compose the v3 drawer body instead, Drawer + DrawerHead + KeyValue + RowItems (+ StepTimeline, RankList), as the blocks' panels do (MyCreatorPanel, PayoutBatchDetail): soft 14px tiles and 14/700 section headings, where this sheet draws bordered tiles and 800 headings. It keeps working until 1.0. |
fetchJson | Function | useDrawerResource now reads through the DataProvider's HttpClient (CSRF, base URL, onUnauthorized, the server's message); pass fetcher only for a special case. fetchJson is removed in 1.0.0. |
formatAmount | Function | Since 0.3.0: use formatMoney(value, { language, showCurrency: false, decimals: 'auto' }), the one formatter. Removed in 1.0. |
giftAnalyticsColumns | Function | Since 0.7.0: use giftBrandColumns with GiftBrandRow, the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftBrandStockRow | Type | Since 0.7.0: use GiftBrandRow (used = total − left; status defaults to giftStockStatus), the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftClaimCheck | Component | Since 0.7.0: use GiftShipmentCard (shipmentId, brand, state, lines, claimedBoxes), which keeps a half-finished count by product as this card does, the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftClaimCheckProps | Type | Since 0.7.0: use GiftShipmentCardProps, the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftClaimCheckResult | Type | Since 0.7.0: use GiftCount, the 0.4.0 gift family. Kept working; removed in 1.0. |
giftClaimColumns | Function | Since 0.7.0: use giftShipmentColumns with GiftShipmentRow (open a row with the table's onRowClick), the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftClaimLine | Type | Since 0.7.0: use GiftShipmentLine (productId is its id), the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftClaimRow | Type | Since 0.7.0: use GiftShipmentRow (sentOn is sent, status is state), the 0.4.0 gift family. Kept working; removed in 1.0. |
GiftClaimStatus | Type | Since 0.7.0: use GiftShipmentState (giftStatusKey(state) gives these keys), the 0.4.0 gift family. Kept working; removed in 1.0. |
isConsoleStatus | Function | Since 0.2.0: use key in TRNDR_STATUSES, or the provider's statuses. Removed in 1.0. |
LIST_STATE_EVENT | Constant | Since 0.2.0: use URL_STATE_EVENT (the same value). Removed in 1.0. |
PersonCell avatarSrc | Prop | Since 0.2.0: use CreatorCell, which draws identity.avatarUrl (initials if none or it fails). |
PersonCell photo | Prop | Since 0.2.0: use CreatorCell (it always draws identity.avatarUrl). |
prCreatorColumns | Function | Since 0.7.0. Use creatorColumns(language, money, { onOpen, reapply: true, nullableSales: true }) with PrCreatorRow rows: the same columns, the reapply tooltip and the nullable sales as opt-ins. Keeps working until 1.0. |
PrCreatorListRow | Type | Since 0.7.0. Use PrCreatorRow with creatorColumns (the one PR creators preset); keeps working until 1.0. |
PrGiftsCopy | Type | Since 0.7.0: use PrGiftShipmentCopy, PrGiftColumnsCopy and PrGiftAnalyticsCopy, the 0.4.0 gift family. Kept working; removed in 1.0. |
RowList sort | Prop | Since 0.2.0: a sortable list is a DataTable (sort / onSort), or a ListToolbar sort for "Sort by"; RowList stays the plain list. Still works; removed once the Brand Console has moved (MIGRATION.md). |
RowList onSort | Prop | Since 0.2.0: use DataTable onSort (see sort). |
ShipmentSummary | Component | Since 0.7.0: use GiftShipmentCounts (counts as a record) inside a Card, the 0.4.0 gift family. Kept working; removed in 1.0. |
ShipmentSummaryProps | Type | Since 0.7.0: use GiftShipmentCounts (counts as a record) inside a Card, the 0.4.0 gift family. Kept working; removed in 1.0. |
SortOption | Type | Since 0.2.0: ListToolbar sort.options takes [key, label, dir]. |
SortSelect | Component | Since 0.2.0: use ListToolbar sort (options [key, label, dir], onChange(key, dir), onFlip). Still works unchanged; removed once the Brand Console has moved (MIGRATION.md). |
SortState | Type | Since 0.2.0: RowList sorting is deprecated; DataTable takes a DataSort (the same shape). |
SortValue | Type | Since 0.2.0: ListToolbar sort has value and dir. |