useFollowedShopsActions

The useFollowedShopsActions hook provides mutation functions to follow and unfollow shops. Returns followShop() and unfollowShop() functions that accept a shop GID. Following a shop adds it to the user's followed shops collection in the Shop app, enabling personalized recommendations. useFollowedShops() hook can be used to display current follow status.

Caution

This hook requires adding the following scopes to the manifest file:

shops:follows:write

For more details, see manifest.json.

Anchor to useFollowedShopsActions
useFollowedShopsActions()

Anchor to useFollowedShopsActions-returnsReturns

UseFollowedShopsActionsReturns

followShop

Follows a shop.

(params: FollowShopParams) => Promise<boolean>

unfollowShop

Unfollows a shop.

(params: UnfollowShopParams) => Promise<boolean>

FollowShopParams

shopId
```
string
```

UnfollowShopParams

shopId
```
string
```

Examples

tsx

import {useFollowedShopsActions, Button} from '@shopify/shop-minis-react'

export default function MyComponent() {

const {followShop, unfollowShop} = useFollowedShopsActions()

return (

<Button onClick={() => followShop({shopId: 'gid://shopify/Shop/123'})}>

Follow shop

</Button>

<Button onClick={() => unfollowShop({shopId: 'gid://shopify/Shop/123'})}>

Unfollow shop