# Docs - Documentation: Guides and API reference - [Introduction](/docs): Build and customize Shopify mobile apps on the Appmaker platform. - Get started - [Getting Started](/docs/get-started): Here is an overview for using Appmaker partner dashboard and setting up the starter app, the relevant docs are linked together for easy reference. - [Create appmaker partner account](/docs/get-started/create-partner-account): Signing up for Appmaker dashboard can be done in 4 simple steps. - [Installation](/docs/get-started/install-appmaker-cli): To get started, you will need to install the appmaker-cli package. - [Create a package](/docs/get-started/create-package): Prior to creating a new theme or extension locally, you must first create it on https://partners.appmaker.xyz/. - [Configuring the app](/docs/get-started/configuration): Set the default project ID for the appmaker cli by changing the project ID in the .env file in the root of the project. - [Running the app](/docs/get-started/running-app): To build and run the app, you have two options. - [Appmaker Release](/docs/get-started/appmaker-release): Release your theme or extension with the Appmaker CLI, then submit it for approval. - [Use the docs with AI tools](/docs/get-started/ai-tools): Connect Claude, Cursor, VS Code and other AI tools to the Appmaker developer docs with the MCP server, or give them the docs as Markdown. - Concepts - [Concepts](/docs/concepts): How an Appmaker app is put together: themes, pages, blocks and actions. - [Appmaker Theme Overview](/docs/concepts/theme-overview): The visual appearance, user experience, and functionality of an app are largely determined by its theme, making it a crucial aspect for both developers and users. - [App Theme](/docs/concepts/app-theme): App theme is the visual appearance of the app. - [Page Types and Page Variants Guide](/docs/concepts/page-variants): Page types and page variants provide a flexible system for creating conditional pages based on specific requirements. - [Default page ids of the app](/docs/concepts/default-page-ids): In certain situations, you might encounter the need to substitute a current page, which necessitates the knowledge of its unique ID. - [Register a custom action](/docs/concepts/register-custom-action): This doc will help you to register a custom action in your appmaker extension and use it in your app. - [Hooks](/docs/concepts/filters-and-functions): Appmaker Hooks are functions that can be used to modify the behavior of the Appmaker platform. - Build your app - [Build your app](/docs/build): Customize each part of the app. Docs are grouped by the area of the app you are changing. - Pages - [Pages](/docs/build/pages): Add or replace pages, pass data between them and handle deep links. - [Adding New Page](/docs/build/pages/adding-new-page): All pages will be available in the default theme. - [Add a new page](/docs/build/pages/add-new-page): This article describes how to add a new page in the app. - [Replace an existing page](/docs/build/pages/replace-existing-page): This article describes how to replace an existing page in the app. - [How to pass params between pages](/docs/build/pages/pass-params-between-pages): This is a doc to show how to pass params between pages. - [How to forward Product data from product list to Product Detail page](/docs/build/pages/how-to-transfer-data-from-plp-to-pdp): Forward the product list, or your own data, from the product list page to the product detail page with onOpenProductDetail. - [Integrating Custom Components into the Appmaker App's Root](/docs/build/pages/add-custom-component-in-root): This can be useful in various scenarios. - [Custom Deep Link Actions](/docs/build/pages/deep-link-actions): Documentation on how to intercept and customize deep link resolution using the deeplink-url-custom-action filter in Appmaker. - [Default deeplinking URL that works on App](/docs/build/pages/default-deeplinking-url): Below we are disussing the cases where the user has app installed on the device and the user clicks on the link from the browser or any other app. - Navigation & header - [Navigation & header](/docs/build/navigation): Header, toolbar, bottom bar, drawer and sticky footer. - [Update the navigation header or toolbar title of any page](/docs/build/navigation/update-navigation-header-of-a-page): Change the toolbar title of any page with the usePageTitle hook. - [Adding Custom Toolbar Icons](/docs/build/navigation/adding-custom-toolbar-icons): You can add custom icons by importing them from the @appmaker-xyz/shopify/ToolBarIcons module and adding them to the toolBarItems array. - [How to add Toolbar Icons to a pagesData​](/docs/build/navigation/how-to-add-toolbar-icons-to-pagedata): This doc shows how to add toolbar icons to a pagesData object. - [Add Extra Component in Toolbar](/docs/build/navigation/add-extra-component-in-toolbar): This guide will show you how to add extra component in the right side of the toolbar. - [How to change menu and back icons in topbar](/docs/build/navigation/change-menu-and-back-icons-topbar): This tutorial shows you how to change the menu and back icons in the topbar. - [How to add a custom backbutton icon to whole app](/docs/build/navigation/how-to-add-custom-back-button): This is a simple example of how to add a custom backbutton icon to whole app. - [How to remove Header/ToolBar from a page](/docs/build/navigation/how-to-remove-toolbar-from-page): This is a simple example of how to remove the header and toolbar from a page. - [Hide header on scroll](/docs/build/navigation/hide-header-on-scroll): This guide will help you to understand how to hide the header on scrolling the page. - [How to hide logo on page](/docs/build/navigation/how-to-hide-logo-on-page): In this guide, we will learn how to hide the logo on a specific page. - [Customize Bottom Bar](/docs/build/navigation/customize-bottom-bar): The Bottom Bar is used to display the navigation options in the bottom of the app which can be enabled and edited from the dashboard. - [Steps to Enable Bottom Tab Bar in All Pages](/docs/build/navigation/enable-bottombar-in-all-pages): To begin, navigate to the Shopify Extension settings in the Appmaker dashboard and select Tab Home as the navigation type for the home page. - [How to change tab home page using filters](/docs/build/navigation/how-to-change-tab-home-page): Suppose you are adding a new home page bottom tab icon and it is having some native features that will be only available for the users with latest version. - [Replace drawer menu page and menu items with custom components](/docs/build/navigation/replace-drawer-menu): This document provides instructions on how to substitute the default drawer menu page and menu items with custom components. - [How to edit width of navigation drawer](/docs/build/navigation/adjust-width-of-drawer): Change the width of the navigation drawer with the custom-drawer-style filter. - [Loading a custom inapp-page inside Navigation drawer](/docs/build/navigation/how-to-load-custom-in-app-page): This example shows how to load a custom inapp-page inside Navigation drawer. - [How to inject a Sticky Footer block to all pages](/docs/build/navigation/how-to-inject-sticky-footer-block): This example shows how to inject a block to all pages. - [How to add floating block in sticky footer](/docs/build/navigation/how-to-add-floating-block-in-sticky-footer): This example shows how to add floating block in sticky footer. - Blocks - [Blocks](/docs/build/blocks): Create and customize blocks and make them available in the App Builder. - [Adding new blocks](/docs/build/blocks/create-a-custom-block): In this section, you will learn how to add new blocks to the app. - [Customizing existing blocks](/docs/build/blocks/customizing-existing-blocks): In this section, you will learn how to customize existing blocks. - [How to add and use block settings](/docs/build/blocks/how-to-use-block-settings): Let's say you have created a custom block and you want to add some settings to the block. - [Register block in dashboard](/docs/build/blocks/register-block-in-dashboard): Once you have created a custom block, For merchants to use the block in Appmaker Dashboard, you need to register the block in the appmaker-custom-blocks.json file. - [Enabling Custom Blocks in App Builder](/docs/build/blocks/partner-dashboard-block-registration): This guide explains how to register your existing custom blocks on the Appmaker Partner Dashboard so they appear in the App Builder for drag-and-drop customization on custom pages. - [Add block in partner dashboard](/docs/build/blocks/add-custom-block-partner-dashboard): You can add a custom block in the partner dashboard and access the block in the Appmaker Dashboard. - [How to create Dashboard Block that can be managed from the Appmaker Dashboard](/docs/build/blocks/how-to-create-dashboard-manageable-block): This document provides instructions on how to create a block that can be managed drag and drop from the Appmaker Dashboard to the in-app pages. - [Injecting Blocks in Pages using inapp-page-data-response](/docs/build/blocks/inject-blocks): The inapp-page-data-response filter is a core Appmaker capability that allows developers to intercept and modify the JSON data for any page before it is rendered. - [Slot Block](/docs/build/blocks/plp-pdp-slot): SlotBlock is a component that is used to render the components inserted into a slot. - [Using the Optimized ShopifyImage Component](/docs/build/blocks/creating-an-optimized-image-block): When creating custom blocks that are added through the Appmaker dashboard and registered in your theme, loading large images can impact performance. - [Video Block](/docs/build/blocks/how-to-add-video-block): You can use this block to display video in a page by placing below code - Collections & search - [Collections & search](/docs/build/collections-and-search): Product listing pages, collections, filters, sort and search. - [Collections Listing Page (PLP)](/docs/build/collections-and-search/collection-listing-page): Collections listing page is the page where user can see the list of products in a collection. - [Product List](/docs/build/collections-and-search/collection-list): Product list page is the page where user can see the list of products in a collection. - [Customize Product Grid Widget](/docs/build/collections-and-search/customize-collection-list-widget): The Product Grid Widget is used to display a list of items from a collection. - [Add custom blocks in product list Page](/docs/build/collections-and-search/add-custom-block-in-plp): This guide will help you add custom blocks in product list view. - [Add custom blocks in product list view](/docs/build/collections-and-search/add-custom-blocks-in-list-view): This guide will help you add custom blocks in product list view. - [How to create a separate template for specific collections on app](/docs/build/collections-and-search/custom-template-for-a-collection): To show different layouts for collections (like sub-collections, banners, or custom blocks), you can assign templates via metafields and conditionally render them on productList page using pageTypes. - [Shopify backend configuration to show sub-collections on app](/docs/build/collections-and-search/how-to-show-sub-collections-on-app): In this guide, we will learn how to configure the shopify backend to show sub-collections on the app. - [Show sub-collection on collection page](/docs/build/collections-and-search/show-subcollection-on-collection-page): You can show the sub collection on the collection page by using the metafields. - [How to create all collection on Shopify](/docs/build/collections-and-search/how-to-create-all-collection-on-shopify): This tutorial will show you how to create an all collection on Shopify. - [How to hide a Product from the product list and search page](/docs/build/collections-and-search/hide-product): In this doc, we will see how to hide a product from the product list and search page using the Shopify admin. - [Customising Filter and Sort Modal](/docs/build/collections-and-search/custom-sort-filter): This doc is for showing how to customize sort and filter modal - [How to add filter in app](/docs/build/collections-and-search/how-to-add-filter-on-app): You can add a filter in the app using Search and Discovery app on shopify backend. - [Filter customization](/docs/build/collections-and-search/how-to-customise-advanced-filter): The Advanced filter customization extension allows you to customize the filter in your app. - [How to return a custom response for Shopify Collection Filters](/docs/build/collections-and-search/shopify-custom-filters-response): This guide will help you return a custom response for Shopify Collection Filters. - [Search Page](/docs/build/collections-and-search/search-page): Search page is the page where user can search for the products. - [How to show search page results as grid?](/docs/build/collections-and-search/search-page-customisation): If you want to show search results as a grid, you can do this by replacing the search page with a custom implementation that uses the dataSource pattern. - [How to show Recent search](/docs/build/collections-and-search/how-to-show-recent-search): This is a simple example of how to show recent search in your app. - Product page - [Product page](/docs/build/product-page): Product detail page, variants, swatches and bundles. - [Product Detail Page (PDP)](/docs/build/product-page/product-detail-page): Product detail page is the page where user can see the product details and add the product to cart. - [Product Detail](/docs/build/product-page/product-detail): Product detail page is the page where user can see the details of a product. - [Customize Product Data Card](/docs/build/product-page/customize-product-data-card): The Product Data Card is used to display the product details. - [How to use variations in Product Detail page](/docs/build/product-page/how-to-use-variations-in-pdp): This guide will help you to understand how to use variations in product detail page. - [Add a custom variation block to the PDP](/docs/build/product-page/add-custom-variation-block-pdp): In this guide, we will show you how to add a custom variation block to the Product Detail Page (PDP). - [How to add a color variant to the PDP](/docs/build/product-page/how-to-add-default-color-variant-pdp): This example shows how to add a color variant to the PDP. - [How to show variant color swatches using metafields](/docs/build/product-page/how-to-show-variant-color-swatches): This guide will help you to show variant color swatches using metafields. - [How to create bundle products](/docs/build/product-page/how-to-create-bundle-products-metaobject): This guide will show you how to set metaobject for bundle products. - [How to disable purchase for a product?](/docs/build/product-page/how-to-disable-purchase-product): To disable purchase for a product, a product tag can be added to the product in the Shopify admin. - Cart & checkout - [Cart & checkout](/docs/build/cart-and-checkout): Cart page, cart logic, discounts and checkout. - [Cart](/docs/build/cart-and-checkout/cart): Cart page is the page where user can see the list of products in the cart. - [Customize Cart Card](/docs/build/cart-and-checkout/customize-cart-card): The Cart Card is used to display the product details in the cart. - [Implementing Recommendations in Cart via ProductList Component](/docs/build/cart-and-checkout/custom-cart-recommendations): A "You May Also Like" scroller in the cart can significantly increase the Average Order Value (AOV) by suggesting related items based on what the user has already added. - [How to create a custom product scroller in cart page](/docs/build/cart-and-checkout/how-to-create-custom-product-scroller-cart): This is a tutorial on how to create a custom product scroller in cart page. - [How to listen to cart changes and modify cart](/docs/build/cart-and-checkout/listen-to-cart): This guide will help you to listen to cart changes and modify cart. - [How to manage cart actions using filters](/docs/build/cart-and-checkout/how-to-manage-cart-action): This guide will help you to understand how to manage cart actions using filters. - [How to add free gift products to cart](/docs/build/cart-and-checkout/how-to-add-free-gift-to-cart): This guide will help you to add free gift products to cart. - [How to set automatic discount coupon shopify](/docs/build/cart-and-checkout/how-to-set-automatic-discount-coupon-shopify): In this guide, we will learn how to set an automatic discount coupon in the Shopify store. - [How to use setCheckoutId function](/docs/build/cart-and-checkout/how-to-use-set-checkout-id-function): This function is used to set the checkout id in the app storage state. - [OneClick checkout integration guide](/docs/build/cart-and-checkout/oneclick-checkout): Appmaker provides a way to integrate one-click checkout with your app. - Account & login - [Account & login](/docs/build/account-and-login): Login providers, account pages and wishlist. - [Login Page](/docs/build/account-and-login/login-page): Login page is the page where user can login to the store. - [Replace Register/Login Page](/docs/build/account-and-login/replace-register-login-page): This document provides instructions on how to substitute the default register/login page with a custom component. - [How to create custom OTP login](/docs/build/account-and-login/custom-otp-extension): This guide will help you to know the filters that has to be used to create custom OTP login. - [Google Login for Android/iOS](/docs/build/account-and-login/google-login-for-android-ios): This doc will help you to integrate google login in your android and iOS app. - [How to create a google login button](/docs/build/account-and-login/how-to-create-google-login-button): This is a simple example of how to create a google login button in your app. - [How to create a apple login button](/docs/build/account-and-login/how-to-create-apple-login-button): This is a simple example of how to create a apple login button in your app. - [Account Page](/docs/build/account-and-login/account-page): The account page displays the user's profile and provides navigation to key account sections such as orders, addresses, and logout. - [Overriding the My Account Page](/docs/build/account-and-login/override-my-account-page): The My Account page is the central hub for user profile management. - [Overriding the Address Page](/docs/build/account-and-login/override-address-page): You can completely customize the address management experience in your app by overriding the default Address Page. - [Overriding the Order List Page](/docs/build/account-and-login/override-order-list-page): The Order List page displays the customer's order history. - [How to add delete account tab](/docs/build/account-and-login/how-to-add-delete-account-tab): IOS apps need to provide a way for users to delete their account. - [Implement custom wishlist page](/docs/build/account-and-login/how-to-implement-custom-wishlist-page): Replace the default wishlist page with your own block-based page. - Look & feel - [Look & feel](/docs/build/look-and-feel): Theming, fonts, splash screen, layout helpers and UI components. - [Theming](/docs/build/look-and-feel/theming): The theming system in our application provides a flexible way to customize the look and feel of the UI components. - [Customize Font](/docs/build/look-and-feel/customize-font): The font used in the theme can be customized using the theme. - [How to customize your app's splashscreen](/docs/build/look-and-feel/how-to-customize-splashscreen): This tutorial shows you how to customize the SplashScreen component. - [Page Background Image](/docs/build/look-and-feel/background-image): This feature allows you to set a background image for a page. - [How to Customise the Appmaker Message View](/docs/build/look-and-feel/custom-message-view): In this doc we will see how to customise the Appmaker message view using react-native-toast-notifications. - [Right-to-Left (RTL) Styling Best Practices](/docs/build/look-and-feel/rtl-best-practices): RTL (Right-to-Left) is a text direction that is used in languages such as Arabic, Hebrew, and Persian. - [How to use SafeArea Context for iOS devices in Component level](/docs/build/look-and-feel/how-to-use-safeareacontext-for-ios): In iOS devices to use safe are padding you can use with safe area context library. - [How to remove scrollbar from page](/docs/build/look-and-feel/how-to-remove-scrollbar): You can remove the scrollbar from the page by adding the showsVerticalScrollIndicator attribute to the page. - UI components - [UI components](/docs/build/look-and-feel/ui-components): Components available in the Appmaker UI library. - [Layout Component](/docs/build/look-and-feel/ui-components/layout): The Layout component is a flexible container that can display its children or a loading indicator based on the loading prop. - [ThemeText Component](/docs/build/look-and-feel/ui-components/themetext): ThemeText is a versatile React Native component that renders text with various styling options and supports HTML content. - [Button Component](/docs/build/look-and-feel/ui-components/button): The Button component is a customizable, reusable React Native button that supports various styles, sizes, and states. - [Input Component](/docs/build/look-and-feel/ui-components/input): The Input component is a customizable text input field for React Native applications. - [CheckBox Component](/docs/build/look-and-feel/ui-components/checkbox): The CheckBox component is a versatile and customizable checkbox input designed for React Native applications. - [Radio Component](/docs/build/look-and-feel/ui-components/radio): The Radio component is a customizable radio button group for React Native applications. - [Select](/docs/build/look-and-feel/ui-components/select): The Select component is a customizable dropdown selector for React Native applications. - [AppModal](/docs/build/look-and-feel/ui-components/modals): AppModal is a wrapper component around the Modal from 'react-native-modal'. - Data & queries - [Data & queries](/docs/build/data): Query data with fieldsHelper, fragments, runDataSource and metafields. - [How to use runDataSource function to run a gqlQuery function](/docs/build/data/how-to-use-rundatasource): This document describes how to use runDataSource function to run gqlQuery method of dataSource object. - [How to use the usePageState hook in a React Native component](/docs/build/data/how-to-use-pagestate): This example demonstrates how to use the usePageState hook from the @appmaker-xyz/core library to manage the state of a modal in a React Native application. - [How to query metafields via GraphQL](/docs/build/data/metafields-in-page-data): This guide will help you fetch your collection or product metafield data using GraphQL instead of filters. - [How to add metafields to product](/docs/build/data/how-to-add-meta-fields-to-product): In this guide, we will show you how to add meta fields to the product, so that you can use them in the app. - [How to add metafield to storefront API using Admin API](/docs/build/data/how-to-add-metafield-to-storefront-api): This example shows how to add metafield to storefront. - [Add Metafields to collection](/docs/build/data/add-metafields-to-collection): Let's say you want to get the collection metafields data in the collection page. - [How to add metafields in cartLineItem](/docs/build/data/how-to-get-meta-fields-in-cart-line-item): This guide will show you how to get metafields in the cart. - [Add extra fields to product query using fieldsHelper](/docs/build/data/add-extra-fields-to-product-query): This function is used to add extra fields to the product query. - [Add extra fields to collection query using fieldsHelper](/docs/build/data/add-extra-fields-to-collection-query): This function is used to add extra fields to the collection query. - [Add extra fields to cart line item query using fieldsHelper](/docs/build/data/add-extra-fields-to-cart-line-item): This function is used to add extra fields to the cart line item query. - [Add extra fields to order item query using fieldsHelper](/docs/build/data/add-extra-fields-to-orderitem-query): This function is used to add extra fields to the order item query. - [Add extra fields to order product line item query using fieldsHelper](/docs/build/data/add-extra-fields-to-order-product-line-item): This function is used to add extra fields to the order product line item query. - [Adding Fragments to collection query](/docs/build/data/adding-fragments-to-collection-query): This example shows how to add fragments to a collection query, which will help you to get the current fragment and also add new fragments to the collection. - Webview & Web SDK - [Webview & Web SDK](/docs/build/webview-and-web-sdk): Control webview pages with the Appmaker Web SDK. - [Appmaker WebSDK](/docs/build/webview-and-web-sdk/installation): The Appmaker Web SDK is a JavaScript library that allows you to interact with the Appmaker webview. - [Installation of appmakerWebSdk](/docs/build/webview-and-web-sdk/installation-of-appmaker-web-sdk): The Appmaker Web SDK is a JavaScript library that allows you to interact with the Appmaker webview. - [Appmaker Web SDK Methods and Usage](/docs/build/webview-and-web-sdk/sdk-methods-and-usage): Returns true if the app is running inside the Appmaker webview. - [Add Appmaker Web SDK to an Existing Page](/docs/build/webview-and-web-sdk/add-sdk-existing-page): This guide will help you add the Appmaker Web SDK to an existing page in your website. - [Hide Header and Footer using Appmaker Web SDK](/docs/build/webview-and-web-sdk/hide-header-footer-using-sdk): This guide will help you hide the header and footer of your website when the user is inside the Appmaker WebView. - [How to send post message from webview](/docs/build/webview-and-web-sdk/how-to-send-post-message-from-webview): In this guide, we will learn how to send a post message from a webview. - [How to open a webview with current user details](/docs/build/webview-and-web-sdk/access-current-user): This guide will help you open a webview with current user details. - [Create a product bundle page in React and connect with appmaker web sdk](/docs/build/webview-and-web-sdk/create-a-product-bundle): In this guide, we will learn how to create a product bundle page in React and connect with appmaker web sdk. - Integrations - [Integrations](/docs/integrations): Analytics, push notifications and third-party apps. - Analytics - [Analytics](/docs/integrations/analytics): Appmaker analytics events and per-vendor setup. - [Analytic Events and Context](/docs/integrations/analytics/appmaker-analytics-events): These events are used to track user behavior and to send data to the analytics provider. - [How to add an analytics event](/docs/integrations/analytics/how-to-add-custom-events): Track your own analytics events with analytics.track from @appmaker-xyz/core. - [How to track page](/docs/integrations/analytics/how-to-track-page): In Appmaker, you can track the page viewed by the user. - [Add an analytics extension in Appmaker​](/docs/integrations/analytics/create-analytics-extension): This tutorial shows you how to create an analytics extension. - Firebase - [Firebase](/docs/integrations/analytics/firebase): Includes Firebase events and parameters, Firebase Analytics Automatically Tracked Events on App, How to edit custom events in the Firebase and How to see analytics events in Firebase Debug View. - [Firebase events and parameters](/docs/integrations/analytics/firebase/events): Firebase Analytics is a free app measurement solution that provides insight on app usage and user engagement. - [Firebase Analytics Automatically Tracked Events on App](/docs/integrations/analytics/firebase/automatically-tracked-events): Events Firebase Analytics collects automatically, and their parameters. - [How to edit custom events in the Firebase](/docs/integrations/analytics/firebase/custom-events): This document will help you understand how to edit custom events in the Firebase. - [How to see analytics events in Firebase Debug View](/docs/integrations/analytics/firebase/debug-view): Firebase Debug View is a tool that allows you to see the events that are being sent to Firebase Analytics. - CleverTap - [CleverTap](/docs/integrations/analytics/clevertap): Includes CleverTap Analytics Events, How to edit custom events in the CleverTap, How to add custom properties to CleverTap purchase recordPurchase function and  CleverTap Apple Developer Account Configuration Doc: App Groups. - [CleverTap Analytics Events](/docs/integrations/analytics/clevertap/events): CleverTap events sent by the app, with sample event data. - [How to edit custom events in the CleverTap](/docs/integrations/analytics/clevertap/custom-events): This document will help you understand how to edit custom events in the CleverTap. - [How to add custom properties to CleverTap purchase recordPurchase function](/docs/integrations/analytics/clevertap/purchase-custom-properties): Add custom properties to the CleverTap purchase event with the clevertap-record-purchase-event-params filter. - [ CleverTap Apple Developer Account Configuration Doc: App Groups](/docs/integrations/analytics/clevertap/ios-app-groups): This guide outlines the steps on the Apple Developer website (developer.apple.com) to configure App Group sharing for your main iOS application and its CleverTap-related extensions. - MoEngage - [MoEngage](/docs/integrations/analytics/moengage): Includes MoEngage Events, How to edit custom events in the MoEngage and  MoEngage Apple Developer Account Configuration Doc: App Groups. - [MoEngage Events](/docs/integrations/analytics/moengage/events): MoEngage events sent by the app, with the parameters of each event. - [How to edit custom events in the MoEngage](/docs/integrations/analytics/moengage/custom-events): This document will help you understand how to edit custom events in the MoEngage. - [ MoEngage Apple Developer Account Configuration Doc: App Groups](/docs/integrations/analytics/moengage/ios-app-groups): This guide walks you through the steps on the Apple Developer website (developer.apple.com) to configure App Groups for your main iOS application and its extensions, which is necessary for… - WebEngage - [WebEngage](/docs/integrations/analytics/webengage): Includes WebEngage Analytics Events, How to edit custom events in the webEngage and  WebEngage Apple Developer Account Configuration Doc: App Groups & Push Notifications. - [WebEngage Analytics Events](/docs/integrations/analytics/webengage/events): What it does: Marks that a product detail page (PDP) was viewed. - [How to edit custom events in the webEngage](/docs/integrations/analytics/webengage/custom-events): This document will help you understand how to edit custom events in the webEngage. - [ WebEngage Apple Developer Account Configuration Doc: App Groups & Push Notifications](/docs/integrations/analytics/webengage/ios-app-groups): This guide walks you through the steps on the Apple Developer website (developer.apple.com) to configure App Groups and Push Notifications for your main iOS application and its extensions, which… - AppsFlyer - [AppsFlyer](/docs/integrations/analytics/appsflyer): Includes AppsFlyer Analytics Events, How to edit custom events in AppsFlyer and AppsFlyer One Link Configuration. - [AppsFlyer Analytics Events](/docs/integrations/analytics/appsflyer/events): AppsFlyer events sent by the app, with sample event data. - [How to edit custom events in AppsFlyer](/docs/integrations/analytics/appsflyer/custom-events): This guide will help you to edit custom events in AppsFlyer. - [AppsFlyer One Link Configuration](/docs/integrations/analytics/appsflyer/onelink): This guide shows you how to configure AppsFlyer One Link. - Klaviyo - [Klaviyo](/docs/integrations/analytics/klaviyo): Includes Klaviyo Integration Documentation and  Klaviyo Apple Developer Account Configuration Doc: App Groups. - [Klaviyo Integration Documentation](/docs/integrations/analytics/klaviyo/events): This document details the events and associated attributes that are sent from the Appmaker mobile app platform (integrated with Shopify) to Klaviyo for enhanced customer engagement, analytics, and… - [ Klaviyo Apple Developer Account Configuration Doc: App Groups](/docs/integrations/analytics/klaviyo/ios-app-groups): This guide walks you through the steps on the Apple Developer website (developer.apple.com) to configure App Groups for your main iOS application and its service extension, which is necessary for… - Meta (Facebook) - [Meta (Facebook)](/docs/integrations/analytics/meta): Includes How to test Facebook (Meta) App Events. - [How to test Facebook (Meta) App Events](/docs/integrations/analytics/meta/test-events): This guide explains how to verify that Facebook (Meta) app events are being sent correctly from your mobile application using Meta Events Manager. - Push notifications - [Push notifications](/docs/integrations/notifications): Includes How to get FCM token and How to Handle Notification Received and Clicked Events with Notification Payload in Plugin/Theme. - [How to get FCM token](/docs/integrations/notifications/how-to-get-fcm-token): This tutorial shows you how to get the FCM token from the appmaker app. - [How to Handle Notification Received and Clicked Events with Notification Payload in Plugin/Theme](/docs/integrations/notifications/notification-events): This guide explains how to handle notification events and their payloads when using react-native-firebase for notification handling. - Reviews - [Reviews](/docs/integrations/reviews): Includes Judgeme implementation and How to use Judgeme in your app - Native. - [Judgeme implementation](/docs/integrations/reviews/judgeme-implementation): Show Judge.me product ratings and reviews in your app with the Judge.me extension. - [How to use Judgeme in your app - Native](/docs/integrations/reviews/judgeme-implementation-native): Enable Judgeme in your app from the Appmaker dashboard. - Native code - [Native code](/docs/native-code): Native libraries, permissions and Expo config plugins. - [Instructions for adding libraries that contain native code](/docs/native-code/instructions-for-adding-libraries): This guide will help you to add libraries that contain native code to your app. - [How to add permissions on app](/docs/native-code/how-to-add-permissions-on-app): In this guide, we will learn how to add permissions on the app. - [App Groups Helper](/docs/native-code/app-groups): The withAppGroups helper function provides an easy way to add iOS App Groups entitlements to your Expo app. - Config plugins - [Config plugins](/docs/native-code/config-plugins): Modify native iOS and Android files with Expo config plugins. - [How to add config plugin in project](/docs/native-code/config-plugins/add-in-project): Appmaker uses expo for building the app. - [Sample expo plugin file for iOS and native changes](/docs/native-code/config-plugins/sample-expo-plugin-file): This is a sample expo plugin file that shows how to add custom codes in iOS and Android native files. - [How to add codes in your Info.plist file using expo](/docs/native-code/config-plugins/add-codes-in-info-plist): Inside your app.plugin.js file, add the following code. - [How to Add codes in IOS native files using expo in AppDelegate.m](/docs/native-code/config-plugins/adding-codes-in-appdelegate-m-file): Inside your app.plugin.js file, add the following code. - [Adding iOS Permissions with Expo Config Plugins](/docs/native-code/config-plugins/adding-ios-permissions): This guide explains how to add various iOS permissions to your Expo project using Config Plugins. - [How to add codes in your MainApplication.java file using expo](/docs/native-code/config-plugins/add-codes-in-main-application-android-file): Inside your app.plugin.js file, add the following code. - [How to modify build.gradle file](/docs/native-code/config-plugins/modify-build-gradle): In this guide, you will learn how to modify the build.gradle file using expo-config-plugins. - [How to add code to native using expo-bare-react-native-app](/docs/native-code/config-plugins/bare-app-config): For situations where you need to verify the generated platform files, the expo-bare-react-native-app repository is available. - Partner dashboard - [Partner dashboard](/docs/partner-dashboard): Extensions, team access and app builds in the Appmaker partner dashboard. - [Create an extension](/docs/partner-dashboard/create-extension): With the Appmaker partner dashboard, you can create extensions for your apps. - [How to invite a team member to the Appmaker Partner Dashboard.](/docs/partner-dashboard/invite-member): To prevent the creation of duplicate organizations and potential limitations on access to shared projects, we suggest that the admin initially signs up and then invites team members from the… - [How to request project access](/docs/partner-dashboard/request-project-access): If you want to request project access from the merchant on partner dashboard, you can do it by using the Project Access Requests tab. - [App Build](/docs/partner-dashboard/app-build): App build allows developers to create production builds from within the Appmaker partner dashboard, allowing them to quickly test and iterate changes they have made to themes and extensions. - [How to debug IOS on simulator](/docs/partner-dashboard/app-debug-build-ios): Select the IOS platform while creating the build and also select the type of build as Development. - [App build Trigger](/docs/partner-dashboard/app-build-trigger): To access the App build trigger section, navigate to App builds within the Appmaker dashboard (as shown in the screenshot below) - Reference - [Reference](/docs/reference): Actions, filters, functions, React hooks, config form and CLI. - [Actions](/docs/reference/actions): Appmaker Platform provides a set of predefined actions that you can use in your app. - [Appmaker Filters](/docs/reference/filters): Filters the Urls that are passed inside the webview. - Functions - [Appmaker Functions](/docs/reference/functions): Triggered before opening the checkout page. - [before-open-checkout](/docs/reference/functions/before-open-checkout): This function is triggered before opening the checkout page. - [Custom order fullfillment status](/docs/reference/functions/custom-shopify-order-fulfillment-status): With new custom-shopify-order-fulfillment-status appmaker trigger, you can add custom fulfillment status to order. - React hooks - [Appmaker Hooks](/docs/reference/hooks): Appmaker built-in hooks. - Cart - [Cart](/docs/reference/hooks/cart): Includes useCart, useCartActions, useCurrentCart and useCartProduct, and more. - [useCart](/docs/reference/hooks/cart/use-cart): This hook is used to get the cart data. - [useCartActions](/docs/reference/hooks/cart/use-cart-actions): This hook will help you to add multiple items to the cart. - [useCurrentCart](/docs/reference/hooks/cart/use-current-cart): This hook returns the current Shopify cart object from the app's persisted storage. - [useCartProduct](/docs/reference/hooks/cart/use-cart-product): This hook is used to get the cart product data. - [useProductCartQuantity](/docs/reference/hooks/cart/use-product-cart-quantity): The useProductCartQuantity hook is used to get the product cart quantity data. - [useLineItemAttributes](/docs/reference/hooks/cart/use-line-item-attributes): This hook manages custom line item attributes (cart item properties) on the product detail page. - [useDiscount](/docs/reference/hooks/cart/use-discount): This hook is used to get the discount data. - [useLocalCart](/docs/reference/hooks/cart/use-local-cart): The useLocalCart hook is used to get the local cart data. - Product - [Product](/docs/reference/hooks/product): Includes useProducts, useProductDetail, useProductDetailV2 and useProductListItem, and more. - [useProducts](/docs/reference/hooks/product/use-products): The useProducts hook is used to get the products data by passing the query params. - [useProductDetail](/docs/reference/hooks/product/use-product-detail): This hook is used to get the product detail data. - [useProductDetailV2](/docs/reference/hooks/product/use-product-detail-v2): This hook provides product detail page (PDP) functionality including add-to-cart, buy now, pricing, variant selection state, and selling plan support. - [useProductListItem](/docs/reference/hooks/product/use-product-list-item): This hook is used to get the product list item data. - [useProductImages](/docs/reference/hooks/product/use-product-image): This hook is used to get the product images and handle the image swiper actions. - [UseProductOptions](/docs/reference/hooks/product/use-product-options): This hook is used to get the variation options for a product. - [useProductVariations](/docs/reference/hooks/product/use-product-variations): This hook is usd to get the product variations in product list. - [useProductQuantity](/docs/reference/hooks/product/use-product-quantity): This hook manages the product quantity on the product detail page. - [useShopifyProduct](/docs/reference/hooks/product/use-shopify-product): The useShopifyProduct hook is used to get the product data in a specific format by passing the product node. - Filters & sort - [Filters & sort](/docs/reference/hooks/filters-and-sort): Includes useProductFilters, useProductFilterActions, useFilterOptions and useQuickFilters, and more. - [useProductFilters](/docs/reference/hooks/filters-and-sort/use-product-filters): This hook fetches available product filters from Shopify for a given collection or search query. - [useProductFilterActions](/docs/reference/hooks/filters-and-sort/use-product-filter-actions): This hook provides actions to programmatically manage product filters from outside the filter modal. - [useFilterOptions](/docs/reference/hooks/filters-and-sort/use-filter-options): This hook provides access to the filter selection state and actions for the product list filter UI. - [useQuickFilters](/docs/reference/hooks/filters-and-sort/use-quick-filter): The useQuickFilters hook is used to get the quick filters data for a collection. - [useSortModal](/docs/reference/hooks/filters-and-sort/use-sort-modal): This hook manages the visibility state of the sort modal on product list pages. - Search - [Search](/docs/reference/hooks/search): Includes useSearch, useSearchQuery, useSearchResult and useSearchSuggest, and more. - [useSearch](/docs/reference/hooks/search/use-search): This hook manages the search query state and provides the search result count on the search page. - [useSearchQuery](/docs/reference/hooks/search/use-search-query): This hook manages the search input value in page state. - [useSearchResult](/docs/reference/hooks/search/use-search-result): This hook retrieves the predictive search results stored in page state. - [useSearchSuggest](/docs/reference/hooks/search/use-search-suggest): This hook provides access to search suggestion terms from the block data, typically used to render search suggestion chips or tags. - [usePredictiveSearch](/docs/reference/hooks/search/use-predictive-search): This hook provides real-time predictive search results from Shopify's predictive search API. - [useRecentSearch](/docs/reference/hooks/search/use-recent-search): This hook manages the user's recent search history, stored in AsyncStorage. - User & auth - [User & auth](/docs/reference/hooks/user-and-auth): Includes useUser, useCurrentUser, useUserProfile and useUserProfileV2, and more. - [useUser](/docs/reference/hooks/user-and-auth/use-user): The current user, plus functions to register and log in. - [useCurrentUser](/docs/reference/hooks/user-and-auth/use-current-user): The useCurrentUser hook allows you to fetch the profile information of the currently authenticated user. - [useUserProfile](/docs/reference/hooks/user-and-auth/use-user-profile): This hook is used to get the user profile data. - [useUserProfileV2](/docs/reference/hooks/user-and-auth/use-user-profile-v2): This hook provides user profile management with form validation using react-hook-form and Zod schema. - [useLogin](/docs/reference/hooks/user-and-auth/use-login): This hook is used to get handle login functionality. - [useRegister](/docs/reference/hooks/user-and-auth/use-register): This hook is used to get handle register functionality. - [useOtpLogin](/docs/reference/hooks/user-and-auth/use-otp-login): You need to have an OTP login extension installed in your app. - [useEmailOtpLogin](/docs/reference/hooks/user-and-auth/use-email-otp-login): This hook manages email-based OTP (One-Time Password) login flow, including sending, verifying, and resending OTP codes. - [useForgotPassword](/docs/reference/hooks/user-and-auth/use-forgot-password): This hook allows you to send a reset password email to a customer. - Address & orders - [Address & orders](/docs/reference/hooks/address-and-orders): Includes useAddress, useAddAddress, useAddressItem and useOrders, and more. - [useAddress](/docs/reference/hooks/address-and-orders/use-address): To set selected address as default address, pass setDefault as true in the second param of selectAddress function Make sure to pass the second param as an object. - [useAddAddress](/docs/reference/hooks/address-and-orders/use-add-address): To set address as default address, pass setDefault as true in the second param of addNewAddress function - [useAddressItem](/docs/reference/hooks/address-and-orders/use-address-item): Data and actions for a single saved address, such as selecting or editing it. - [useOrders](/docs/reference/hooks/address-and-orders/use-orders): The useOrders hook is used to get the orders data of the user. - [useOrderItem](/docs/reference/hooks/address-and-orders/use-order-item): This hook extracts and formats order data from block attributes for rendering order items in the order list. - [useOrderLineItem](/docs/reference/hooks/address-and-orders/use-order-line-item): This hook is used to get the order line item data. - Wishlist - [Wishlist](/docs/reference/hooks/wishlist): Includes useProductWishList, useWishlistProductIds and useWishlistProducts. - [useProductWishList](/docs/reference/hooks/wishlist/use-product-wishlist): This hook is used to add or remove products from wishlist. - [useWishlistProductIds](/docs/reference/hooks/wishlist/use-wishlist-product-ids): This hook returns an array of product ids that are in the wishlist. - [useWishlistProducts](/docs/reference/hooks/wishlist/use-wishlist-products): This hook is used to get the wishlist products. - Reviews - [Reviews](/docs/reference/hooks/reviews): Includes useReviewSummary, useReviewsList, useReviewListItem and useAddReview. - [useReviewSummary](/docs/reference/hooks/reviews/use-review-summary): Average rating, review and question counts, and the rating breakdown for a product. - [useReviewsList](/docs/reference/hooks/reviews/use-review-list): The useReviewsList hook is designed to fetch and manage a list of product reviews from a Shopify data source. - [useReviewListItem](/docs/reference/hooks/reviews/use-review-list-item): The useReviewListItem hook is used to retrieve the data for a review item and is used in the review list item component. - [useAddReview](/docs/reference/hooks/reviews/use-add-review): The useAddReview hook is used to add review and rating for a product. - Page & utilities - [Page & utilities](/docs/reference/hooks/page-and-utils): Includes usePage, usePageState, useNavigationActions and useDataSourceV2, and more. - [usePage](/docs/reference/hooks/page-and-utils/use-page): Get the ID, handle, title and body of a Shopify online store page. - [usePageState](/docs/reference/hooks/page-and-utils/use-page-state): This hook provides access to the Zustand-based page-level state. - [useNavigationActions](/docs/reference/hooks/page-and-utils/use-navigation-actions): This hook allows you to get the navigation actions. - [useDataSourceV2](/docs/reference/hooks/page-and-utils/use-data-source-v2): This hook provides data fetching for single-page (non-paginated) data sources. - [useReusableBlocks](/docs/reference/hooks/page-and-utils/use-reusable-blocks): This hook provides access to the reusable blocks store, a persisted Zustand store that manages reusable block templates. - [useThemeSettings](/docs/reference/hooks/page-and-utils/use-theme-settings): This hook returns the current theme settings object from the plugin store. - [useScrollToBlock](/docs/reference/hooks/page-and-utils/use-scroll-to-block): This hook is used to scroll to a specific block on the page. - [useScrollValueY](/docs/reference/hooks/page-and-utils/use-scroll-value-y): This hook returns a shared animated scroll Y value (SharedValue from react-native-reanimated). - [Appmaker Config Form](/docs/reference/config-form): Appmaker Form config is used to render the form in the Appmaker Dashboard. - [Appmaker CLI Commands](/docs/reference/cli-commands): Every Appmaker CLI command, from logging in and creating a project to releasing and publishing your theme or extension. - Utilities - [Utilities](/docs/reference/utilities): Small helpers: currency, app version, build config and dashboard settings. - [How to get currency symbol](/docs/reference/utilities/how-to-get-currency-symbol): This can be done using the currencyHelper function. - [How to get app version number](/docs/reference/utilities/how-to-get-app-version-number): Read the app's version name with appSettings.getOption. - [How to get build config values](/docs/reference/utilities/how-to-get-build-config): This module is used to get build config values from appSettings, theme and extensions. - [How to get settings/config from dashboard in extension](/docs/reference/utilities/how-to-get-dashboard-settings-in-extension): Let's split this into two parts. - [How to get cart object outside the components](/docs/reference/utilities/how-to-get-cart-from-appstoragestate): You can access the cart through the AppPluginStoreApi. - Troubleshooting - [Troubleshooting](/docs/troubleshooting): Includes Appmaker starter app not connecting to local server, How to reset packager cache, IOS simulator not working and Debugging React Native Crashes with Firebase Crashlytics. - [Appmaker starter app not connecting to local server](/docs/troubleshooting/starter-app-not-connecting-to-server): Fix the Appmaker starter app when it cannot connect to the development server on your computer. - [How to reset packager cache](/docs/troubleshooting/how-to-reset-packager-cache): Clear the Watchman and Metro caches when the packager serves stale code. - [IOS simulator not working](/docs/troubleshooting/ios-simulator-not-working): If you are facing issues with the iOS simulator, like the app not launching or crashing, follow these steps to troubleshoot the issue. - [Debugging React Native Crashes with Firebase Crashlytics](/docs/troubleshooting/firebase-crashlytics-exception-debug): This guide outlines the step-by-step process for debugging JavaScript exceptions in React Native applications using Firebase Crashlytics. - Changelog: Release notes - [Changelog](/docs/changelog): Release notes for the Appmaker app platform. - [Checkout API removed: Cart API is now the default](/docs/changelog/release-expo-v2-25-03): Published 7 March 2025 - [Release 2.5.0](/docs/changelog/release-2-5-0): Published 25 January 2024 - [Release 2.3.6](/docs/changelog/release-2-3-6): Published 12 December 2023 - [Release 2.3.5](/docs/changelog/release-2-3-5): Published 7 November 2023 - [Release 2.3.4](/docs/changelog/release-2-3-4): Published 10 October 2023 - [Release 2.3.3](/docs/changelog/release-2-3-3): Published 4 October 2023 - [Release 2.3.2](/docs/changelog/release-2-3-2): Published 3 October 2023 - [Release 2.3.0](/docs/changelog/release-2-3-0): Published 27 September 2023 - [Release 2.3.1](/docs/changelog/release-2-3-1): Published 27 September 2023