Interface: UseFavoritesOptions

Defined in: composables/react/useFavorites.ts:29

Options for useFavorites.

Properties

graphqlClient

graphqlClient: GraphQLClient

Defined in: composables/react/useFavorites.ts:31

GraphQL client the hook derives its Services bundle from.

---

language?

optional language?: string

Defined in: composables/react/useFavorites.ts:35

Language for list operations.

---

onCreate?

optional onCreate?: (data) => void

Defined in: composables/react/useFavorites.ts:37

Override: fires instead of the default createFavoriteList call.

Parameters

data

FavoriteListFormData

Returns

void

---

onDelete?

optional onDelete?: (id) => void

Defined in: composables/react/useFavorites.ts:41

Override: fires instead of the default deleteFavoriteList call.

Parameters

id

string

Returns

void

---

onEdit?

optional onEdit?: (id, data) => void

Defined in: composables/react/useFavorites.ts:39

Override: fires instead of the default updateFavoriteList call.

Parameters

id

string

data

FavoriteListFormData

Returns

void

---

onListChanged?

optional onListChanged?: () => void

Defined in: composables/react/useFavorites.ts:43

Fires after any list create / update / delete completes.

Returns

void

---

user

user: AnyUser

Defined in: composables/react/useFavorites.ts:33

The signed-in user; favorite lists are read off this object.