Address Utilities - Admin Components

The @medusajs/dashboard/lib subpath exports the utilities that the Medusa Admin uses to display and compare addresses. Use them in your admin extensions to show an order's or customer's address the same way the Medusa Admin does.

Code
1import {2  getFormattedAddress,3  getFormattedCountry,4  isSameAddress,5} from "@medusajs/dashboard/lib"

getFormattedAddress#

Returns an address as an array of lines, ordered the way the Medusa Admin displays them: the full name, the company, the two address lines, a combined city, province, and postal code line, and the country's display name. Render each item of the array on its own line.

Code
1import { getFormattedAddress } from "@medusajs/dashboard/lib"2
3const ShippingAddress = ({ order }) => {4  const lines = getFormattedAddress({5    address: order.shipping_address,6  })7
8  return (9    <div>10      {lines.map((line, index) => (11        <span key={index}>{line}</span>12      ))}13    </div>14  )15}

Parameters#

Returns#

Returns a string[] of the address's lines. The array is empty when you don't pass an address.

getFormattedCountry#

Returns a country's display name from its ISO 2 code.

Code
1import { getFormattedCountry } from "@medusajs/dashboard/lib"2
3getFormattedCountry("us") // "United States"

Parameters#

Returns#

Returns a string of the country's display name. It returns the passed code when the country isn't supported, and an empty string when you don't pass a code.

isSameAddress#

Returns whether two addresses hold the same values. It compares the first name, last name, both address lines, city, postal code, province, and country code. It ignores the company and phone.

Code
1import { isSameAddress } from "@medusajs/dashboard/lib"2
3const isSame = isSameAddress(4  order.shipping_address,5  order.billing_address6)

Parameters#

Returns#

Returns a boolean that is true when the compared fields match. It returns false when either address is missing.