Skip to main content

Interface: FavoriteListsProps

Defined in: components/FavoriteLists.tsx:23

Properties​

allowFavoriteListCreate?​

optional allowFavoriteListCreate?: boolean

Defined in: components/FavoriteLists.tsx:49

Displays create new favorite list button (default: true)

className?​

optional className?: string

Defined in: components/FavoriteLists.tsx:52

Custom class name

formatDate?​

optional formatDate?: (dateString) => string

Defined in: components/FavoriteLists.tsx:55

Format date function override. If not provided, dates are formatted as dd/mm/YYYY

Parameters​

dateString​

string

Returns​

string

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/FavoriteLists.tsx:28

The initialized GraphQL Client instance. Resolved from PropellerProvider when omitted.

labels?​

optional labels?: object

Defined in: components/FavoriteLists.tsx:58

Localization labels

cancelButton?​

optional cancelButton?: string

clusters?​

optional clusters?: string

createButton?​

optional createButton?: string

createFirstList?​

optional createFirstList?: string

createPlaceholder?​

optional createPlaceholder?: string

createTitle?​

optional createTitle?: string

defaultBadge?​

optional defaultBadge?: string

deleteButton?​

optional deleteButton?: string

deleteConfirm?​

optional deleteConfirm?: string

deleteTitle?​

optional deleteTitle?: string

deleteTooltip?​

optional deleteTooltip?: string

deleteWarning?​

optional deleteWarning?: string

editCancel?​

optional editCancel?: string

editSave?​

optional editSave?: string

editTooltip?​

optional editTooltip?: string

items?​

optional items?: string

lastModified?​

optional lastModified?: string

loading?​

optional loading?: string

makeDefault?​

optional makeDefault?: string

nameLabel?​

optional nameLabel?: string

noLists?​

optional noLists?: string

noListsDescription?​

optional noListsDescription?: string

products?​

optional products?: string

saveButton?​

optional saveButton?: string

setAsDefault?​

optional setAsDefault?: string

limit?​

optional limit?: number

Defined in: components/FavoriteLists.tsx:34

Limit the number of lists shown (e.g. 3 = last 3 modified). undefined = show all

onCreate?​

optional onCreate?: (favoriteListData) => void

Defined in: components/FavoriteLists.tsx:87

Action function triggered when creating a new favorite list. If not provided, the default action is executed

Parameters​

favoriteListData​
isDefault​

boolean

name​

string

Returns​

void

onDelete?​

optional onDelete?: (favoriteListId) => void

Defined in: components/FavoriteLists.tsx:93

Action function triggered when deleting a favorite list. If not provided, the default action is executed

Parameters​

favoriteListId​

string

Returns​

void

onEdit?​

optional onEdit?: (favoriteListId, favoriteListData) => void

Defined in: components/FavoriteLists.tsx:90

Action function triggered when editing a favorite list. If not provided, the default action is executed

Parameters​

favoriteListId​

string

favoriteListData​
isDefault​

boolean

name​

string

Returns​

void

onListChanged?​

optional onListChanged?: (change?) => void

Defined in: components/FavoriteLists.tsx:100

Called after any list mutation succeeds, with what it did.

The argument is optional so existing zero-argument callbacks keep working.

Parameters​

change?​

FavoriteListChange

Returns​

void

onListClick?​

optional onListClick?: (listId) => void

Defined in: components/FavoriteLists.tsx:31

Callback when a list is clicked (navigate to detail)

Parameters​

listId​

string | number

Returns​

void

showActions?​

optional showActions?: boolean

Defined in: components/FavoriteLists.tsx:46

Displays edit/delete action buttons on each list (default: true)

showDefaultIndicator?​

optional showDefaultIndicator?: boolean

Defined in: components/FavoriteLists.tsx:37

Displays the "Default" badge on the favorite list (default: true)

showItemsCount?​

optional showItemsCount?: boolean

Defined in: components/FavoriteLists.tsx:43

Displays number of products and clusters contained in the favorite list (default: true)

showLastModified?​

optional showLastModified?: boolean

Defined in: components/FavoriteLists.tsx:40

Displays the last modified date on the favorite list (default: true)

user?​

optional user?: Contact | Customer | null

Defined in: components/FavoriteLists.tsx:25

The authenticated user (Contact or Customer). Resolved from PropellerProvider when omitted.