Skip to main content

Use parameters

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

Parameter typeDescription
GatherContent ItemsSelect an item from GatherContent.

GatherContent Items

This parameter type allows a Uniform user to select a GatherContent item.

Add parameter to component

In order to allow a user to select an item from GatherContent, you must add a parameter to a component. The parameter is used to store the identifier to the selected item when the user selects an item.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type GatherContent Items.

  3. The following values can be specified:

    NameDescription
    Allowed TemplatesSpecifies which templates will be available to select from when the parameter value is edited. You can select multiple templates in order to allow the user to select from a larger set of items.
    RequiredIndicates whether the value is required when the component is used.
    parameter-config
    GatherContent Items parameter with a single content type selected.

Edit parameter value

When you use a component with an GatherContent Items parameter, by default no item will be selected. You are prompted to select an item.

  1. Click Select.

    edit-value-default
  2. Click the item you want to select.

    edit-value-selected
    About this step

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

  3. Click Accept to save your selection.

  4. You will see details about the item you selected, including the title and some metadata.

    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 item in GatherContent, click Edit.
    • If you want to unselect the item, click Unlink.

Configure an enhancer

When an item is selected, Uniform only stores the identifier for the item. Your front-end application must retrieve the details for the item. 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 GatherContent.

How Uniform stores the selected item

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

{
"type": "gathercontent-items",
"value": {
"itemIds": [
00000000
],
"source": "default"
}
}

There is one identifier in this value:

  1. The item that was selected.

Add the enhancer

Uniform provides an enhancer so you don't need to write the API calls to GatherContent to retrieve data for items.

tip

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

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

    @uniformdev/canvas-gathercontent
  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 { 
    createGatherContentEnhancer,
    GatherContentClient,
    GatherContentClientList,
    CANVAS_GATHERCONTENT_PARAMETER_TYPES,
    } from '@uniformdev/canvas-gathercontent';
  4. Add the following code:

    const client = new GatherContentClient({
    apiKey: '!!! YOUR GC API KEY !!!',
    apiUsername: '!!! YOUR GC API USERNAME !!!',
    projectId: '!!! YOUR GC PROJECT ID !!!',
    });
    About this step

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

  5. Add the following code:

    const clients = new GatherContentClientList({ client });
    const gcEnhancer = createGatherContentEnhancer({ clients });
  6. Add the following code:

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

    This registers the enhancer to be used for any occurrence of the GatherContent Items parameter.

Next steps

Now, the parameter value in the composition is mutated to include the field values for the selected GatherContent item (instead of just being an identifier).