Components menu
  2. components
  3. actions
  4. account connection

Account connection

The account connection component is used so merchants can connect or disconnect their store to various accounts. For example, if merchants want to use the Facebook sales channel, they need to connect their Facebook account to their Shopify store.

Examples

Use to let merchants connect or disconnect their store to their third-party accounts, like Facebook.

Drag to resize example

Props

accountName
string
The name of the service
action
Action
Action for account connection
avatarUrl
string
URL for the user’s avatar image
connected
boolean
Set if the account is connected
details
React.ReactNode
Content to display as additional details
termsOfService
React.ReactNode
Content to display as terms of service
title
React.ReactNode
Content to display as title

Accessibility

See accessibility guidance for the setting toggle component to turn connections on and off.

Best practices

The account component should:

  • Be placed at the top of the Account page for the relevant sales channel
  • Identify the name of the platform or service merchants can connect to
  • Show whether the account is connected or disconnected so that merchants can easily connect or disconnect an account
  • Include a link to the relevant sales channel or platform terms and conditions, including information about any charges or fees that merchants may incur by using the channel or platform
  • Link to terms and conditions, which should open up on the sales channel developer’s website in a new browser window

Content guidelines

Title

The account connection title should be the name of the platform or service that merchants can connect to, followed by the word “account”. Write account connection titles in sentence case (capitalize the first word and proper nouns only).

For example:

  • Facebook account
  • Mailchimp account
  • Instagram account

  • Facebook account

  • Instagram account

  • Connect your Account

  • Instagram Account

    Terms and conditions

    Clearly link to your terms and conditions and let merchants know about any additional costs of your service.

  • By clicking Connect, you agree to accept Sample’s terms and conditions.

  • You’ll pay a commission rate of 15% on sales made through Sample.

  • Learn about terms, conditions, and payment details.

Connect button

Always use the verb Connect in the button of the account connection component. When merchants click or tap “Connect” it should open up your platform or service’s authorization page in a new browser window.

  • Connect

  • Connect to app

Edit source on GitHub