Image banner

#Overview

This guide shows how to build an image banner component containing a background image, a title, a subtitle for additional text, a button component and an enumeration for banner theme.

Image banner 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 basic models project. If you're already familiar with model creation and only want to follow the parts of the tutorial related to the banners, you can start here.
  • OPTION 3: Clone the entire cookbook. This is the way to go if you're curious about how the banners are made but don't want to follow the step-by-step creation process. This project contains the entire Banners Cookbook so you can compare them, or look into what instances they contain.
  • OPTION 4: Use an existing project of yours. If you have a project already and want to add this banner 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 components and basic component fields. Let's look into these concepts:

• 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.

• Component: a predefined 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.

• Basic component field: a component is a special field type in your Hygraph schema that defines which components of which type can be used in a model. Component fields can be of basic or modular types. A basic component field can only have one component attached to it. You can limit the number of component instances to one, or allow multiple component instances to be added in the content entry.

• Nested components: Nested components allow you to create component fields within a component, as if you had a parent component containing one or more child components.

• 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.

#What you can do

This guide offers two paths:

• Path 1: Use this guide to create an image banner component that you can reuse across different models in your Hygraph projects.
• Path 2: Clone one of the projects we created for you. You can clone a project that only contains the basic models so you can work on the banners right away, or you can clone the project that contains the entire Banners cookbook to compare the different banner configurations without having to clone multiple projects.

#Clone project

#Clone the basic models

We have prepared a project that contains only the basic models - Author, Shop, and Book - in case you don't want to build them from scratch:

Clone this project

If you decide to clone this project, you can skip model creation and start from this step.

#Clone the complete cookbook

We have prepared a project that contains the entire Banners cookbook:

Clone this project

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

To find this particular recipe in the cookbook project, navigate to the schema and look for "Image banner".

This project also contains a demo model that includes all the banner components as basic components, as well as a modular component that you can use as a banner type selector.

#Step-by-step guide

Before we can build a component - in this case our image banner component - we sometimes need to create other schema elements that will later be added to those components as instances.

In this guide, we will also be building nested components. When building nested components, you need to start building from the deepest level of nesting upwards, so you can have one component ready to nest it into the next one.

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

1. Create the models: We will create 3 sample models - Author, Book, and Shop - to use in our references.
2. Create a link component: We will build a link component that we can add to other components as a button or link element.
3. Create an enumeration: We will create an enumeration that will allow users to select a theme for their banners.
4. Create the image banner component: Finally, we'll combine the schema elements we created before to set up our image banner component.

#Create the models

Since our image banner component will ultimately allow linking to external URLs as well as internal content, we need to create a set of models that we can reference later on.

For this example, we'll go with the idea of an online bookshop that has real world subsidiaries, so we'll create 3 models:

• Author
• Book
• Shop

#Author model

Author model

Let's start with the Author model. In the Schema builder, we'll click +Add next to Models, and use the following information:

We'll click Add model to save.

Our model has been created but it's empty. To create a simple model that will contain basic author information, we'll add the author name, bio, and image.

Let's start with the author name, as a Single line text field. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

Next, we'll add a Rich text field, which will our author's bio. We'll select the Rich text field from the right sidebar and use the following information to create it:

We'll click Add to save.

Finally, we'll add an Asset picker field, which will be our author's image. We'll select the Asset picker field from the right sidebar and use the following information to create it:

We'll click Add to save.

Now that we're done with our Author model, let's move on to the Book model.

#Book model

Book model

Our second model will be the Book model. In the Schema builder, we'll click +Add next to Models, and use the following information:

We'll click Add model to save.

Our model has been created but it's empty. To create a simple model that will contain basic book information, we'll add the book name, description, cover image, and a relation to the author.

Let's start with the book name, as a Single line text field. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

Next, we'll add a Rich text field, which will our book description. We'll select the Rich text field from the right sidebar and use the following information to create it:

We'll click Add to save.

Now let's add an Asset picker field, which will be our book cover image. We'll select the Asset picker field from the right sidebar and use the following information to create it:

We'll click Add to save.

Finally, we want books and authors to be connected. A great way to do this is using a two-way reference in our Book model, that will create a relation with the Author model. This type of relation will also create a reverse field that we will later be able to see in our Author model, connecting back to our Book model.

We'll find the Reference field on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

Now that we're done with our Book model, let's move on to the Shop model.

#Shop model

Shop model

Our final model is the Shop model. In the Schema builder, we'll click +Add next to Models, and use the following information:

We'll click Add model to save.

Our model has been created but it's empty. To create a simple model that will contain basic shop information, we'll add the shop name, address, picture and location.

Let's start with the shop name, as a Single line text field. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

Next, we'll add another Single line text field for the shop address.

We'll use the following information:

We'll click Add to save.

Finally, we'll add an Asset picker field, which will be our shop's image. We'll select the Asset picker field from the right sidebar and use the following information to create it:

We'll click Add to save.

Finally, we'll add a location field so Editors can show the shop location on a map. We'll select the Location field from the right sidebar and use the following information to create it:

We'll click Add to save.

Now that we're done with our three models, let's create the link component.

#Create a link component

We are going to start by creating our first component. Our banners will need to have a link, and in this case we'll create a simple component for that.

We'll click +Add next to Components and we'll use the following information to create one:

Click Add component to save.

We can now start adding instances to this component.

Let's start with a Single line text field, which will be the label of our link. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

We want our users to be able to add internal and external links, so we'll add a Reference field to relate internal content, and a Slug for external URLs.

We'll start with the external links. Let's add a Slug field, which will be our link URL. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

The way we configured the field validations to match a URL pattern will ensure that users will complete this field with a valid URL pattern, preventing errors. If their input does not match the expected pattern, the custom error message will inform them.

Next, we're going to ensure Editors can create internal links to content entries from the models that we created at the start of this tutorial. To achieve this, we'll add a Reference field. We'll find it on the Add fields right sidebar and use the following information:

We'll click Add to save.

Finally, we'll add a Boolean field that users can toggle to indicate if the link should open on a new tab. We'll find the Boolean field on the Add fields right sidebar and use the following information:

We'll click Add to save.

This is how you build a link component in Hygraph. You can add this component to different models in your schema. We will add this to our image banner later on.

Link component

Next, we'll create our theme enumeration.

#Create an enumeration

The next step is to create the theme enumeration that we can later add to our image banner as a dropdown menu.

Let's navigate to our project schema and click +Add next to Enumerations.

We'll use the following information:

Next, we need to add enumeration values. These are the options we will get when using this later as a dropdown menu. For this example, we'll use two theme options - light and dark.

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

We'll add the following values:

Finally, we'll click Add enumeration to save.

Now that our theme enumeration has been created, we can finally start building our image banner component.

#Create the image banner component

To start building our image banner component, we'll click +Add next to Components and use the following information to create one:

Click Add component to save.

We can now start adding instances to this component.

Let's start with an Asset picker field, which will be our banner image. We'll select the Asset picker field from the right sidebar and use the following information to create it:

We'll click Add to save.

Next, we'll add a Single line text field, which will be our banner title. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

We'll add another Single line text field, which will be our banner subtitle to add an additional line of text if we need it. We'll find it on the Add fields right sidebar, and click Add on the field card to add it.

We'll use the following information:

We'll click Add to save.

Earlier, we created a link component. We will now add it as a Basic component field so users will be able to add a links to their banners.

We'll find the Basic component field on the Add fields right sidebar, click on Add to add it, and use the following information:

We'll click Add to save.

Finally, we'll include the enumeration that we created earlier as an enumeration field using the following information:

We'll click Add to save.

This is how you create an image banner for your Hygraph project!

#Useful links

• Components documentation