Take part in the GraphQL Challenges Survey 2023

Using enumerations

An enumeration can be used to group values within a type. Enumerations allow you to create a list of values that can be used when adding a Dropdown field to your models.

Create an enumerationAnchor

Navigate to the Schema builder. On the screen, you can add an enumeration or use a demo one. We will show you both procedures.

Create an enumeration
Create an enumeration

Add an enumerationAnchor

  1. Navigate to the Schema builder
  2. You can create an enumeration by navigating to the Schema builder, locating enumerations on the Schema list, and then clicking on + Add next to Enumerations on the Schema list, or the + Add Enumerations button located at the center of the screen. The Add enumeration screen will display as a result.
  3. Complete the Display name field with the name that will be displayed in Hygraph. The API ID field will be autocompleted when you complete the Display name, but you can edit this value. The API ID is the ID for accessing this enumeration through the API.
  4. Optionally, you can add a Description.
  5. Under enumeration values, you can add a list of values by manually entering the value names in the text field and then clicking on the + Add to list button.
  6. Once you have added all the enumeration values, click on the Add Enumeration button at the bottom of the screen to finish the process.

Use demo enumerationAnchor

  1. Navigate to the Schema builder.
  2. Click on the Use demo enumeration button, located at the center of the screen. The demo enumeration will be autogenerated as a result.
  3. The enumeration details screen will be displayed, where all the data will already be complete. You can edit this information.

Delete an enumerationAnchor

  1. Navigate to the Schema builder.
  2. Click on the enumeration you want to delete.
  3. Click on the three dots icon to display the Delete option, then click on it to delete the enumeration.

Use an enumeration in a modelAnchor

  1. Navigate to the Schema builder.
  2. Click on the model you wish to add the enumeration to.
  3. Select the Dropdown field under Enumerations from the Add fields right sidebar.
  4. Complete the Display name field, and the API ID will be auto-filled by the system.
  5. Use the Enumerations dropdown to select the enumeration you wish to add to this model.
  6. Optionally, you can also add a Description.
  7. This screen allows you to control different properties of your Dropdown field: you can allow multiple values, localize the field, or use it as title field, by selecting the checkboxes under the Field options section of the screen.
  8. Click on the Add button. Your dropdown field will be added on the model as a result.

After an enumeration has been configured for your model, you will be able to use the dropdown in the content editor.

Use an enumeration in a content entry
Use an enumeration in a content entry