Easily restore your project to a previous version with our new Instant One-click Backup Recovery
Hygraph
Docs

Styled image gallery

#Overview

This guide shows how to build a simple image gallery with style dropdowns.

This image gallery uses assets in your Hygraph project and allows you to add as many images as you need. It also lets you select a gallery theme and the size of the thumbnails.

Image gallery component with fieldsImage gallery component with fields

#Prerequisites

  • REQUIRED: You need to have a Hygraph account. If you don't have one, you can sign up here.
  • REQUIRED: You need to have a Hygraph project.
    • OPTION 1: Create a project. This is the way to go if you want to follow the entire tutorial for learning purposes.
    • OPTION 2: Clone the entire cookbook. This is the way to go if you're curious about how the galleries are made but don't want to follow the step-by-step creation process. This project contains the entire Image galleries Cookbook so you can compare them, or look into what instances they contain.
    • OPTION 3: Use an existing project of yours. If you have a project already and want to add this image gallery to it, this is the way to go. In this case, you may need to adjust parts of the tutorial to your own project schema.

#Core concepts

In this guide, you'll work with a number of schema elements. Let's look into them:

  • Enumerations: an enumeration is a predefined set of values that represents a list of possible options. You can use them to group values within a type.

  • References: References are relations between two or more content entries in your project. With references, you can reuse content entries by connecting them. Once the relation is configured, you can also use it to create related content from the content creation screen.

  • Component: a pre-defined set of fields that can be reused across models and content entries. You can think of a component as a flexible, reusable template: you define the fields that will be used inside a component once, and then fill them with different content every time you use it in a content entry.

#What you can do

This guide offers two paths:

  • Path 1: Use this guide to create an image gallery component with with style dropdowns that you can use in your project.
  • Path 2: Clone the project that we created for you. It contains the entire Image galleries cookbook to compare the different gallery configurations without having to clone multiple projects.

#Clone project

We have prepared a project that contains the entire Image galleries cookbook:

Clone this project

This cookbook contains all the recipes we have so far to create image galleries, so you can compare the different gallery configurations without having to clone multiple projects.

To find this particular recipe in the cookbook project, navigate to the schema and look for "Styled image gallery".

#Step-by-step guide

In this guide, we will create an image gallery component with with theme and thumbnail size dropdowns.

We will divide this process in steps to make it more manageable:

  1. Create the enumerations: We will create 2 enumerations that will later help us style our galleries; one for thumbnail size and another for gallery theme.
  2. Create the gallery component: We will create an image gallery component that you can later add as component field to your models.

#1. Create the enumerations

We want our image gallery to have dropdowns that will let us select theme and thumbnail size.

We'll start by creating the enumeration for theme. We'll click + Add next to Enumerations and use the following information:

FieldInput
Display NameTheme
API IDTheme

Next, we need to add enumeration values. These are the options we will get when using this later on as a dropdown menu.

For every enumeration value, you need to enter a Display name, an API ID, and click Add.

We'll add the following values:

Display nameAPI ID
Lightlight
Darkdark

We'll click Add enumeration to save.

Next, we need to create an enumeration for thumbnail size selection. We'll repeat the process using the following information:

FieldInput
Display NameThumbnail size
API IDThumbnailSize

Once more, we need to add enumeration values. For this example, we'll use two size options - large and small:

Display nameAPI ID
Largelarge
Smallsmall

We'll click Add enumeration to save.

In the next step, we will create our image gallery component and include them as enumeration fields.

Now that we have the two enumerations that will be a part of our final gallery component, we'll go ahead and create it.

We'll click + Add next to Components and add it using this information:

FieldInput
Display NameStyled image gallery
API IDStyledImageGallery
API ID PluralStyledImageGalleries

We'll click Add component to save, and then we'll start adding instances to it.

First, we'll add a Single line text field, which will be our image gallery title. Let's add it by clicking Add on the Single line text field card on the right sidebar.

We'll use the following information:

TabFieldInput
SettingsDisplay NameGallery title
SettingsAPI IDgalleryTitle
SettingsUse as title field checkboxSelect this checkbox

We'll click Add to save.

Next, we want the possibility to add multiple images to our gallery, so we'll add an Asset picker field that allows multiple values, using the following information:

TabFieldInput
SettingsDisplay NameImages
SettingsAPI IDimages
SettingsField optionsSelect the Allow multiple assets checkbox

We'll click Add to save.

Now its time to add the enumerations we created earlier as enumeration fields.

We'll start with the theme enumeration. We'll find the Enumeration field on the Add fields sidebar, and click Add on the field card.

We'll use the following information:

TabFieldInput
SettingsDisplay NameGallery theme
SettingsAPI IDgalleryTheme
SettingsEnumerationSelect "Theme" from the dropdown menu

We'll click Add to save.

Finally, we'll follow the same steps to add the thumbnail size enumeration, using the following information:

TabFieldInput
SettingsDisplay NameThumbnails size
SettingsAPI IDthumbnailsSize
SettingsEnumerationSelect "Thumbnail size" from the dropdown menu

We'll click Add to save.

This is how you create a simple image gallery component containing a title, an asset picker to add multiple images, and dropdowns for style that will let you select a gallery theme as well as a thumbnails size. Creating the gallery as a component, allows you to reuse the structure in different models in your project.