--- title: Setup guide description: >- New merchants need guidance to get started with your app. The setup guide composition provides an interactive checklist with visual progress tracking to walk them through essential onboarding or api_name: app-home source_url: html: 'https://shopify.dev/docs/api/app-home/patterns/compositions/setup-guide' md: 'https://shopify.dev/docs/api/app-home/patterns/compositions/setup-guide.md' --- # Setup guide New merchants need guidance to get started with your app. The setup guide composition provides an interactive checklist with visual progress tracking to walk them through essential onboarding or configuration tasks. Use this composition on your homepage or a dedicated onboarding page. Mark tasks as complete when merchants finish them to reinforce progress. This composition follows proven design guidelines that help your app feel native to the Shopify admin. See [Built for Shopify requirements](https://shopify.dev/docs/apps/launch/built-for-shopify/requirements) for more details on these guidelines for apps. ### Related Components (10) APIs (2) Templates (1) ### Supported components * [Box](https://shopify.dev/docs/api/app-home/polaris-web-components/layout-and-structure/box) * [Button](https://shopify.dev/docs/api/app-home/polaris-web-components/actions/button) * [Checkbox](https://shopify.dev/docs/api/app-home/polaris-web-components/forms/checkbox) * [Divider](https://shopify.dev/docs/api/app-home/polaris-web-components/layout-and-structure/divider) * [Grid](https://shopify.dev/docs/api/app-home/polaris-web-components/layout-and-structure/grid) * [Heading](https://shopify.dev/docs/api/app-home/polaris-web-components/typography-and-content/heading) * [Image](https://shopify.dev/docs/api/app-home/polaris-web-components/media-and-visuals/image) * [Paragraph](https://shopify.dev/docs/api/app-home/polaris-web-components/typography-and-content/paragraph) * [Section](https://shopify.dev/docs/api/app-home/polaris-web-components/layout-and-structure/section) * [Stack](https://shopify.dev/docs/api/app-home/polaris-web-components/layout-and-structure/stack) ### Available APIs * [Navigation API](https://shopify.dev/docs/api/app-home/apis/user-interface-and-interactions/navigation-api) * [Toast API](https://shopify.dev/docs/api/app-home/apis/user-interface-and-interactions/toast-api) ### Recommended templates * [Homepage](https://shopify.dev/docs/api/app-home/patterns/templates/homepage) #### Use cases * Guiding merchants through initial app setup * Tracking completion of required configuration steps * Showing progress through multi-step onboarding *** ## Examples ### Guide merchants through setup with expandable steps New merchants need an interactive checklist to complete onboarding or setup tasks. This pattern guides merchants through setup with expandable steps and completion tracking. The [checkbox](https://shopify.dev/docs/api/app-home/web-components/forms/checkbox) tracks completion status. Each step includes a heading, description, illustration, and action button, with a progress indicator for overall completion. ##### jsx ```tsx // @framework-globals: useState const [expanded, setExpanded] = useState({ guide: true, step1: true, step2: false, step3: false, }); return ( Setup Guide setExpanded({ ...expanded, guide: !expanded.guide })} icon={expanded.guide ? "chevron-up" : "chevron-down"} /> Use this personalized guide to get your store ready for sales. 0 out of 3 steps completed setExpanded({ ...expanded, step1: !expanded.step1 })} icon={expanded.step1 ? "chevron-up" : "chevron-down"} /> Start by uploading a high-quality image that will be used to create your puzzle. For best results, use images that are at least 1200x1200 pixels. Upload image {" "} Image requirements{" "} setExpanded({ ...expanded, step2: !expanded.step2 })} icon={expanded.step2 ? "chevron-up" : "chevron-down"} /> Choose from our library of puzzle templates including classic jigsaw, hexagonal, and irregular shapes. Browse templates setExpanded({ ...expanded, step3: !expanded.step3 })} icon={expanded.step3 ? "chevron-up" : "chevron-down"} /> Fine-tune the shape and interlocking style of your puzzle pieces for a unique experience. Customize shapes ) ``` ##### html ```html Setup Guide Use this personalized guide to get your store ready for sales. 0 out of 3 steps completed Start by uploading a high-quality image that will be used to create your puzzle. For best results, use images that are at least 1200x1200 pixels. Upload image Image requirements ``` ### Navigate to step actions Use `href` attributes on step action buttons to navigate merchants to relevant pages for completing each step. ##### jsx ```tsx Setup Guide Use this personalized guide to get your store ready for sales. 0 out of 3 steps completed Start by uploading a high-quality image that will be used to create your puzzle. Upload image Image requirements ``` ##### html ```html Setup Guide Use this personalized guide to get your store ready for sales. 0 out of 3 steps completed Start by uploading a high-quality image that will be used to create your puzzle. Upload image Image requirements ``` ### Show step completion with Toast Use the [Toast API](https://shopify.dev/docs/api/app-home/apis/toast) to show feedback when merchants complete setup steps. ##### jsx ```tsx Setup Guide Use this personalized guide to get your store ready for sales. 1 out of 3 steps completed { shopify.toast.show('Step 1 completed!'); }} /> { shopify.toast.show('Step 2 completed!'); }} /> Choose from our library of puzzle templates or create your own custom layout. Browse templates { shopify.toast.show('Step 3 completed!'); }} /> ``` ##### html ```html Setup Guide Use this personalized guide to get your store ready for sales. 1 out of 3 steps completed Choose from our library of puzzle templates or create your own custom layout. Browse templates ``` ***