Region Hooks - Admin Components

The region hooks fetch regions from the Medusa backend. Use them to show or select regions in your admin customizations.

Code
1import {2  regionsQueryKeys,3  useRegion,4  useRegions,5} from "@medusajs/dashboard/hooks"

These hooks are built on TanStack Query. Use them in your widgets and UI routes.

useRegion#

Fetches a single region by ID.

Code
1const { region, isPending } = useRegion(regionId, {2  fields: "+countries.*",3})

Parameters#

Returns#

Along with the following, the hook returns the rest of TanStack Query's useQuery result.

useRegions#

Fetches a paginated list of regions.

Code
const { regions, count } = useRegions({ limit: 20 })

Parameters#

Returns#

Along with the following, the hook returns the rest of TanStack Query's useQuery result.

regionsQueryKeys#

A TanStack Query key factory for region queries. Use it to invalidate cached region data after you change a region.

It provides all, lists(), list(query), details(), and detail(id, query).

Code
1import { useQueryClient } from "@tanstack/react-query"2import { regionsQueryKeys } from "@medusajs/dashboard/hooks"3
4const Widget = () => {5  const queryClient = useQueryClient()6
7  const refreshRegions = () => {8    queryClient.invalidateQueries({9      queryKey: regionsQueryKeys.lists(),10    })11  }12
13  // ...14}