Skip to main content

Use parameters

After you install the Swell integration, the following parameter types are available. You can use these to incorporate content from Swell into your components and compositions.

Parameter typeDescription
Swell Product QuerySpecify search criteria that is used to select a single or multiple products from Swell.
Swell Product SelectorSelect one or more products from Swell.

Swell Product Query

This parameter type allows a Uniform user to configure a query that will determine the Swell products that are retrieved.

Add parameter to component

In order to allow a user to configure a query to determine the products from Swell to retrieve, you must add a parameter to a component. The parameter is used to store the query settings used to perform the search.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type Swell Product Query.

  3. The following values can be specified:

    NameDescription
    Allowed Content TypesBy default, no content types are selected, which means that any kind of products can be selected. If you want to limit the types of products that can be selected, click one or more of the content types listed.
    Display field (optional)In Uniform, this parameter type displays a list of products. By default, the product title is displayed. This field lets you change that so a different product property is displayed.
    parameter-config
    Swell Product Query parameter configuration.

Edit parameter value

When you use a component with a Swell Product Query parameter, by default no product will be selected. You are prompted to select a product.

Configuring this parameter type involves specifying the way a product search should work. You are able to control the following search settings:

FieldDescription
Product CategoryOnly products associated with the selected category are included.
KeywordOnly products whose names match the specified keyword(s) are included.
CountThe maximum number of products that are returned.
SortThe product property used to sort the products that are returned.
Sort OrderWhether the products should be sorted in ascending or descending order.
edit-parameter-value
Example of the editing interface for an Swell Product Query parameter on a component.

Configure an enhancer

When a product query is configured, Uniform only stores the search criteria, not the results of the search. Your front-end application must perform the search using that criteria. Uniform provides an enhancer to simplify this process.

tip

Using the enhancer provided by Uniform saves you from having to write logic to interact directly with Swell.

How Uniform stores the search criteria

The following is an example of what Uniform stores for the parameter.

{
"type": "swell-product-query",
"value": {
"options": {
"count": 2,
"categories": [],
"brand": "",
"keyword": "",
"sort": "date_modified",
"sortOrder": "desc"
}
}
}

The product search criteria is stored as the value.

Add the enhancer

Uniform provides an enhancer so you don't need to write the API calls to Swell to perform the product search.

tip

For more information about the enhancer, see the package documentation.

  1. Add the following npm packages to your front-end application:

    @uniformdev/canvas
    @uniformdev/canvas-swell
  2. In a text editor, open the file where you retrieve the composition definition from Uniform.

    About this step

    You are looking for the code calls the async function getComposition. The code below assumes the object returned is set in a variable composition.

  3. Add the following import statements:

    import { EnhancerBuilder, enhance } from '@uniformdev/canvas';
    import {
    createSwellEnhancer,
    SwellClient,
    SWELL_PARAMETER_TYPES,
    } from '@uniformdev/canvas-canvas-swell';
  4. Add the following code:

    const client = new SwellClient({
    storeId: '!!! YOUR SWELL STORE ID !!!',
    secretKey: '!!! YOUR SWELL SECRET KEY !!!',
    });
    const swellEnhancer = createSwellEnhancer({ clients: client });
    About this step

    We recommend you moving the Swell credentials to environment variables rather than hard-coding them in the front-end app.

  5. Add the following code:

    await enhance({
    composition,
    enhancers: new EnhancerBuilder().parameterType(
    SWELL_PARAMETER_TYPES,
    swellEnhancer
    ),
    context: {},
    });
    About this step

    This registers the enhancer to be used for any occurrence of the Swell Product Query parameter.

Next steps

Now, the parameter value in the composition is mutated to include the field values for the Swell products returned when the search runs (instead of just being settings).

Swell Product Selector

This parameter type allows a Uniform user to select one or more Swell products.

Add parameter to component

In order to allow a user to select products from Swell, you must add a parameter to a component. The parameter is used to store the identifier to the selected products when the user selects one or more products.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type Swell Product Selector.

  3. The following values can be specified:

    NameDescription
    Allowed Content TypesBy default, no content types are selected, which means that any kind of products can be selected. If you want to limit the types of products that can be selected, click one or more of the content types listed.
    Allow multiselectIndicates whether the user can select only one product (the default), or more than one product.
    Display field (optional)In Uniform, this parameter type displays a list of products. By default, the product name is displayed. This field lets you change that so a different product property is displayed.
    RequiredIndicates whether the value is required when the component is used.
    add-parameter-to-component
    Swell Product Selector parameter configuration.

Edit parameter value

When you use a component with a Swell Product Selector parameter, by default no product will be selected. You are prompted to select a product (or products, if you have allowed multi-selection).

  1. Click Select.

    edit-value-default
  2. Click the product(s) you want to select.

    edit-value-filters
    About this step

    A couple of filters are available. The dropdown allows you to filter by category. The text box allows you to filter by product name.

  3. Click Accept to save your selection.

    edit-value-saved
    About this step

    After your selected is saved, you are presented with the following options:

    • If you want to edit the selected product in Swell, click Edit.
    • If you want to unselect the product, click Unlink.

Configure an enhancer

This parameter type uses the same enhancer as the Swell Product Query parameter type.

note

The following is an example of what Uniform stores for the parameter.

{
"type": "swell-product-selector",
"value": {
"products": [
{
"id": "######################"
},
{
"id": "######################"
}
]
}
}