Consider your plan limits when adding recipes to your project.
Where can I find a ready-made project with navigation recipes?
You can clone the Navigation Cookbook project, which contains all navigation recipes, including styled navigation. Clone this project here and explore different navigation configurations without having to create them from scratch.
Features & Capabilities
What is a styled navigation in Hygraph?
A styled navigation in Hygraph is a content model that allows you to create navigation menus with customizable styling options. It includes an ID, a component field for multiple navigation items, and dropdowns for selecting styling options such as size and theme. Editors can style the navigation using predefined options, ensuring a cohesive look and feel across the project. The model also supports toggling menu items as 'new' for continuous updates. Source: Styled Navigation Recipe
What schema elements are used to build a styled navigation?
Styled navigation uses several schema elements:
Enumerations: Predefined sets of values for styling options (e.g., theme: light or dark).
Components: Reusable templates for navigation items, allowing multiple links.
References: Relations to other content models (e.g., Product, Blog, Store) for internal links.
Basic Component Fields: Fields that define which components can be used in a model, supporting multiple instances.
These elements enable flexible, reusable, and consistent navigation structures. Source: Core Concepts
How do I create navigation items that support both internal and external links?
To support both internal and external links in navigation items:
Add a Reference field to link to internal models (e.g., Product, Blog, Store).
Add a Slug field for external URLs, with validation for URL format and uniqueness.
Users can choose either an internal reference or an external link for each navigation item, providing flexibility for different use cases. Source: Navigation Item Component
Can I style navigation menus with themes in Hygraph?
Yes, you can style navigation menus using themes in Hygraph. By creating an enumeration (e.g., 'Navigation theme') and adding values such as 'light' and 'dark', you enable editors to select a theme for each navigation menu via a dropdown. This ensures consistent styling across your project. Source: Theme Enumeration
How do I indicate if a navigation item is new?
You can add a boolean field (e.g., 'New item toggle') to your navigation item component. This allows editors to mark menu items as new, which is useful for large projects with frequent updates. Source: Navigation Item Component
Technical Requirements & Implementation
What are the steps to create a styled navigation in Hygraph?
Can I reuse navigation components across different models?
Yes, components in Hygraph are designed to be reusable across models and content entries. You define the fields for a component once and can fill them with different content each time you use it. This flexibility allows you to maintain consistency and efficiency in your navigation structures. Source: Core Concepts
Where can I find documentation on enumerations, components, and references?
Hygraph provides detailed documentation for these schema elements:
What are the key capabilities and benefits of Hygraph?
Hygraph is a GraphQL-native Headless CMS that empowers businesses to build, manage, and deliver digital experiences at scale. Key capabilities include:
Operational efficiency: User-friendly interface, streamlined workflows, and content federation.
Financial benefits: Reduced operational costs, accelerated speed-to-market, and scalability.
Technical advantages: GraphQL-native architecture, content federation, and enterprise-grade security.
Unique features: Smart Edge Cache, custom roles, rich text formatting, and project backups.
Proven results: Komax achieved 3X faster time-to-market; Samsung improved customer engagement by 15%; Stobag increased online revenue share from 15% to 70%.
How does Hygraph perform in terms of speed and reliability?
Hygraph delivers exceptional performance through features like Smart Edge Cache and high-performance endpoints, ensuring fast and reliable content delivery for high-traffic and global audiences. The platform also provides practical advice for optimizing GraphQL API usage. For more details, see the performance improvements blog post.
What security and compliance certifications does Hygraph have?
Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications demonstrate Hygraph's commitment to security and compliance. For more details, visit the security features page and security and compliance report.
How does Hygraph handle maintenance, upgrades, and troubleshooting?
Hygraph is a cloud-based platform that handles all deployment, updates, security, and infrastructure maintenance. Upgrades are seamlessly integrated, and troubleshooting is supported via 24/7 chat, email, phone, Intercom chat, extensive documentation, and an API Playground. Enterprise customers receive a dedicated Customer Success Manager. Source: Documentation
Support & Training
What support and training resources are available for Hygraph users?
Financial challenges: Lowers operational costs, accelerates speed-to-market, and supports scalability.
Technical issues: Simplifies schema evolution, resolves integration difficulties, and optimizes performance with Smart Edge Cache.
Content consistency: Ensures consistent delivery across global teams via content federation.
Source: Hailey Feed .pdf
How does Hygraph differentiate itself in solving pain points?
Hygraph stands out by offering:
User-friendly interface for non-technical users.
GraphQL-native architecture for modern workflows and easy schema evolution.
Content federation to integrate multiple data sources without duplication.
Smart Edge Cache for performance optimization.
Enterprise-grade security and compliance.
These features set Hygraph apart from competitors like Sanity, Prismic, and Contentful by focusing on flexibility, scalability, and integration capabilities. Source: Hailey Feed - PMF Research.xlsx
KPIs & Metrics
What KPIs and metrics are associated with the pain points Hygraph solves?
Key metrics include:
Time saved on content updates and number of updates without developer intervention.
System uptime and speed of deployment for legacy tech stack modernization.
Content consistency across regions and coordination time for global teams.
User satisfaction scores and time to create/publish content.
Reduction in operational costs and ROI on CMS investment.
Time to market for new products and number of successful launches.
Maintenance costs and frequency of updates/fixes.
Scalability metrics and performance during peak usage.
Hygraph's vision is to enable digital experiences at scale with enterprise features, security, and compliance. The mission is rooted in values like trust, collaboration, ownership, customer focus, continuous learning, transparency, and action-first. Hygraph's product contributes by offering GraphQL-native architecture, content federation, Smart Edge Cache, enterprise-grade features, and ease of use for non-technical users. Source: Contact Hygraph
This guide shows how to build a styled navigation using enumerations and components.
Our styled navigation will be a content model containing an ID, a component field that allows multiple values, and a dropdown to select styling options. This way, to create a navigation using this configuration, you can create a content entry with its own ID, and as many navigation items as you need.
This is the type of navigation model you want if your project has different styling options available.
Here, by adding styling option dropdown menus for size and theme, you'll give Editors the possibility to style the navigation using the options you provide.
Dropdowns are great for this, because while they have options, it will only be within a limited selection that ensures the whole project has a cohesive look & feel.
It is also a great option for large projects that have continuous updates, since it includes a toggle button that lets you indicate if a menu item is new!
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 cookbook project. This is the way to go if you're curious about how the Navigation elements are made but don't want to follow the step-by-step creation process. This project contains the entire Navigation 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 Navigation 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.
Take plan limits into consideration when adding a recipe to your own project.
In this guide, you'll work with enumerations, references, 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.
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.
Path 1: Use this guide to create a styled navigation that you can use in your Hygraph projects.
Path 2: Clone the project that contains the entire Navigation cookbook to compare the different navigation configurations without having to clone multiple projects.
This cookbook contains all the recipes we have so far to create navigations, so you can compare the different navigation configurations without having to clone multiple projects.
To find this particular recipe in the cookbook project, navigate to the schema and look for "Styled Navigation".
We'll start by creating three sample models - Product, Store, and Blog - that we will use as referenceable models later to create our navigation items.
Pro Tip
In a real situation, you would use actual content models that you planned and built for your project, but for the sake of this example, we will simply create three empty content models so we can later on reference them.
We'll click + Add next to Models and use the following information:
Field
Input
Display Name
Product
API ID
Product
API ID Plural
Products
We'll click Add Model to save.
Create the models
Normally, we'd add fields to these models, but for the sake of this example, we'll simply leave them empty.
Repeat the process to create a second model:
Field
Input
Display Name
Blog
API ID
Blog
API ID Plural
Blogs
We'll click Add Model to save.
And one final time for our third model:
Field
Input
Display Name
Store
API ID
Store
API ID Plural
Stores
We'll click Add Model to save.
Finally, we will create one more model for our styled navigation, using the following information:
Field
Input
Display Name
Styled Navigation
API ID
StyledNavigation
API ID Plural
StyledNavigations
We'll click Add Model to save. This model won't stay empty, but before we can start adding fields to it, we need to build an enumeration and a component.
We want our navigation to contain a navigation item component that will allow you to add multiple links to your navigation.
We'll click + Add next to Components and use this information:
Field
Input
Display Name
Navigation item
API ID
NavigationItem
API ID Plural
NavigationItems
Navigation item component
We'll click Add component to save.
We can now start adding instances to this component. We'll start by adding a Single line text field by clicking on it on the Add fields right sidebar.
We'll use the following information:
Tab
Field
Input
Settings
Display Name
Link label
Settings
API ID
linkLabel
Settings
Use as title field checkbox
Select this checkbox
Validations
Make field required checkbox
Select this checkbox
Navigation item - Label
We'll click Add to save. This field will let us add a label to our links.
Next, we want our navigation to indicate if an item is new. To do this, we'll add a boolean field using the following information:
Tab
Field
Input
Settings
Display Name
New item toggle
Settings
API ID
newItemToggle
Navigation item - Toggle
We'll click Add to save.
We want our navigation to offer the possibility to add both internal and external links. We'll add a reference for the internal links, and a slug field for the external ones. In this case, we won't be making them required fields, because users will either use one or the other.
We'll start with the reference field. We'll find the Reference field on the Add fields right sidebar, click on it, and use the following information:
Tab
Field
Input
Define
Reference type
Select Allow multiple models to be referenced (Union Type)
Define
Models to reference
Use the dropdown menu to select Product, Blog and Store
Define
Reference direction
Select One-way reference
Define
Relation cardinality
Select One to One
Configure reference
Display Name
Page
Configure reference
API ID
page
Navigation item - Reference
We'll click Add to save. We've configured the reference in such a way that when we find this field in a content entry, it will allow us to select an entry from the models that we configured.
Finally, we'll add a slug field for our external URLs, using the following information:
Tab
Field
Input
Settings
Display Name
External Link
Settings
API ID
externalLink
Settings
Lowercase checkbox
Leave this checkbox selected
Validations
Set field as unique checkbox
Leave this checkbox selected
Validations
Match a specific pattern checkbox
Leave this checkbox selected, and use the dropdown to select the URL pattern. Write "Input value does not match the expected format." in the Custom error message field.
We want our navigation to allow choosing a theme. To do this, we'll create an enumeration that we can later add to our Navigation model.
We'll click + Add next to Enumerations and use the following information:
Field
Input
Display Name
Navigation theme
API ID
NavigationTheme
Themes enumeration
We'll click Add to save.
Next, we need to add enumeration values. These are the options we will get when using this later on as a dropdown menu. For this example, we'll use two theme options - light and dark.
For every enumeration value, you need to enter a Display name, an API ID, and click Add.
We'll go back into our Styled Navigation model now, to add fields to it. The reason we're creating this navigation as a model, is so that we can then create an entry per navigation that we want to build using this configuration.
First, we will add a slug field that will be our navigation ID. We'll click on the Slug field in the Add fields right sidebar and use the following information:
Tab
Field
Input
Settings
Display Name
Navigation ID
Settings
API ID
navigationId
Settings
Lowercase checkbox
Leave this checkbox selected
Settings
Use as title field checkbox
Select this checkbox
Validations
Set field as unique checkbox
Leave this checkbox selected
Validations
Match a specific pattern checkbox
Leave this checkbox selected, and use the dropdown to select the Slug pattern. Write "Input value does not match the expected format." in the Custom error message field.
Navigation model - ID
We'll click Add to save.
Now it is time to add the navigation item component that we created earlier. We'll click on the Basic component field in the Add fields right sidebar and use the following information:
Tab
Field
Input
Settings
Display Name
Navigation items
Settings
API ID
navigationItems
Settings
Allow multiple values checkbox
Select this checkbox
Settings
Select component
Use the dropdown to select the "Navigation item" component
Navigation model - Navigation item
We'll click Add to save. In this case, we've allowed multiple values, because that way we can add as many links as we want to our navigation.
Finally, we'll add the theme enumeration that we created earlier. We'll find the Enumeration field on the Add fields sidebar, and add it using this information:
Tab
Field
Input
Settings
Display Name
Theme
Settings
API ID
theme
Settings
Enumeration
Select "Navigation theme" from the dropdown menu
Navigation model - Theme
We'll click Add to save.
Pro Tip
We've created a styled navigation model that contains enumerations, components, as well as other schema elements, and that allows you to add internal content entries and external links.
You could potentially use this model to create different navigation elements for your project.
Our styled navigation model should look like this:
Styled navigation
This guide helped you create the schema element yourself. Alternatively, you can clone a project containing all our navigation recipes.