Order Installation

Version: 1.4.0 | 11 containers

Step-by-step

Use the following steps to install the Order component:

Note

These steps are specific for Edge Delivery Services projects, and may not necessarily be the same for other frameworks such as static HTML or React.

Install the packages

Install the required packages using npm:

npm install @dropins/tools @dropins/storefront-order

Tip

All drop-in components require the @dropins/tools package. This package contains the libraries that drop-in components need to initialize and communicate, including fetch-graphql, event-bus, and initializer utilities.

Map the packages

Add the drop-in to your importmap in the head.html file:

<script nonce="aem" type="importmap">
{
  "imports": {
    "@dropins/storefront-order/": "/scripts/__dropins__/@dropins/storefront-order/",
    "@dropins/tools/": "/scripts/__dropins__/tools/"
  }
}
</script>

With the importmap defined, you can now import the required files from these packages into your block as described in the next step.

Import the required files

Import the necessary components and utilities:

// GraphQL Client
import * as mesh from '@dropins/tools/fetch-graphql.js';

// Component tools
import { initializers } from '@dropins/tools/initializer.js';

// Drop-in component provider
import { render as provider } from '@dropins/storefront-order/render.js';

// Drop-in component API functions
import * as api from '@dropins/storefront-order/api.js';

// Drop-in component containers
import { CreateReturn } from '@dropins/storefront-order';

Connect to the endpoint

Configure the GraphQL endpoint:

// Set endpoint configuration
mesh.setEndpoint('https://<graphql-service-endpoint>/graphql');

// Set store code header
mesh.setFetchGraphQlHeader('store', '<default>');

Note

This setting is specific for GraphQL Mesh. Refer to the Commerce GraphQL Service for direct connections.

Register and load the drop-in

Mount the initializers after the page has loaded:

// Register drop-in initializer
initializers.register(api.initialize, {});

// Mount initializers (must be called after all initializers are registered)
initializers.mountImmediately(initialize, { langDefinitions });

Render the drop-in

Render the CreateReturn container on your page:

// Render Order
provider.render(CreateReturn, {
  // Add configuration options here
})(document.getElementById('your-dropin-element'));

Tip

See the Containers documentation for a complete list of available containers and their configuration options.

Next steps

• Explore the API functions available for programmatic control
• Customize the appearance using slots
• Learn about events for integration with other components