Hygraph parameters

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

Parameter typeDescription
Hygraph EntrySelect one or more entry from Hygraph.

Hygraph Entry#

This parameter type allows a Uniform user to select one or more Hygraph entry.

To allow a user to select an entry from Hygraph, you must add a parameter to a component. The parameter is used to store the identifier to the selected entry when the user selects it.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type Hygraph Entry.

  3. The following values can be specified:

    Allowed Content ModelsSpecifies which content models will be available to select from when the parameter value is edited. You can select multiple content types to allow the user to select from a larger set of entries.
    Allow multi-selectIndicates whether the user can select only one entry (the default), or more than one entry.
    RequiredIndicates whether the value is required when the component is used.
    Hygraph Entry parameter with multiple content models selected.

When you use a component with a Hygraph Entry parameter, by default no entry will be selected. You are prompted to select an entry.

  1. Click Select.

  2. Click the entry you want to select.


    About this step

    A couple of filters are available. The dropdown allows you to filter by content model. The text box allows you to filter by entry content.

  3. Click Accept to save your selection.

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


    About this step

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

    • If you want to edit the selected entry in Hygraph, click Edit.
    • If you want to deselect the entry, click Unlink.

When an entry is selected, Uniform only stores the identifier for the entry. Your front-end application must retrieve the details for the entry. Uniform provides an enhancer to simplify this process.


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

The following is an example of what Uniform stores for the parameter. It stores the identifiers for the selected entries.

{ "type": "Hygraph-entry", "value": { "source": "default", "entryIds": [ "#########################" ] } }

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

  1. In Hygraph, get the following values:

    • Auth token
    • Public content API

    About this step

    The auth token is the same value used to configure the Hygraph integration in Canvas. You can get the public content API from the project settings in Hygraph.

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

    graphql graphql-request @uniformdev/canvas-Hygraph
  3. 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.

  4. Add the following import statements:

    import { EnhancerBuilder, enhance } from '@uniformdev/canvas'; import { createEnhancer, CANVAS_PARAMETER_TYPES, } from '@uniformdev/canvas-Hygraph';
  5. Add the following code:

    const HygraphClient = new GraphQLClient( '!!! YOUR Hygraph CONTENT API URL !!!', { headers: { Authorization: `Bearer !!! YOUR Hygraph AUTH TOKEN !!!`, }, } );

    About this step

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

  6. Add the following code:

    const HygraphEnhancer = createEnhancer({ client: HygraphClient, onGetEntryQueryOptions: ({defaultEntryQueryOptions}) => { return defaultEntryQueryOptions; }, });
  7. Add the following code:

    await enhance({ composition, enhancers: new EnhancerBuilder().parameterType( CANVAS_PARAMETER_TYPES, HygraphEnhancer, ), context: {}, });

    About this step

    This registers the enhancer to be used for any occurrence of the Hygraph Entry parameter.

Next steps

Now, the parameter value in the composition is mutated to include the field values for the selected Hygraph entry (instead of just being identifiers).