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

Hygraph
Docs

Glossary

#Basic concepts

ConceptDescription
API PlaygroundThe API Playground, located on the left sidebar of the Hygraph app, allows you to to experiment with querying, and mutating data.
AssetsThe Asset model is included in every project by default. It is commonly used for images, but can also support any file type. Assets can be fetched, referenced, transformed, uploaded, updated, published, localized, deleted, and embedded.
ComponentA component is 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 where 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.
Content modelingThe content model defines the schema of your content. It describes what kind of content you want to store, how it relates to each other, and in what way it can be edited within Hygraph.
Content viewsHygraph features default and custom content views. The default content views are the system views which list all content entries that have been created based on the respective content models. Custom content views are filtered for specific content entries.
EnumerationAn enumeration (or enum for short) can be used to group values within a type. Enums can be useful to filter, and define certain content entries in your project.
ModelYou can define your schema by adding models and then adding fields to said models. Click here to learn more about models.
MutationsOperations that allow you to insert new data or modify the existing data on the server-side. Click here to learn more about mutations.
Preview URLsPreview URLs are automatically generated links that allow you to preview content in your frontend before it's published. Configuring this feature adds a button to the Content Editor's right sidebar, so editors can quickly access content previews.
RelationsReferences, often referred as relations, allow you to connect one or more models together, and even reference multiple models as a single field type with GraphQL Union Types.
Remote sourcesRemote Sources is our content federation utility. It allows adding content from other systems and sources to the Hygraph API without having to migrate the content itself.
Schema builderInside the schema builder, you can add fields, create relationships between models, and much more. Click here to learn more about our schema builder.
SidebarWhen editing models in the schema editor, your sidebar is the second tab in the center section of the screen. Edit the contents of the sidebar tab to customize the sidebar you see in the content editor while creating or editing content.
System fieldsAll default, and custom content types come with some managed system fields. These fields reflect certain states of your content, such as when it was last updated, or published at.

#Content stages

This list offers a brief description of the two content stages every Hygraph project has by default.

Stage nameDescription
DraftContent that has never been published. Draft content can be added, edited and saved, without affecting published content.
PublishedPublished content. If the published button displays green, it means content that has been pushed live. If the published button displays blue, it means a new draft version has been saved and the published content is now outdated.

Additionally, you can create custom content stages for your project. Click to find out more.

#Widgets

This lists offer a brief description of the widgets available in Hygraph's schema editor.

#Field widgets

Widget nameDescription
Single line textString type field widget. It is used for adding headings and titles.
Multi line textString type field widget. It is used for adding text such as descriptions.
MarkdownString type field widget. This widget is a markdown editor.
SlugString type field widget. It is used for adding URL friendly identifiers to your content.
Rich textText type field widget. This widget is a text editor with formatting.
NumberInteger type field widget. It is used for adding a numeric field, such as an ID or identifier.
FloatFloat type field widget. It is used for adding numbers that are not integers because they can include decimal values, for example, ratings or prices.
BooleanBoolean type field widget. It is used for adding a switch that represents true/false.
DateDate type field widget. This is a calendar date picker.
Date and timeDate and time type field widget. This is a calendar date picker that includes time.
JSON editorJSON type field widget. It allows adding arbitrary JSON structures.
Cloudinary assetJSON type field widget. It allows picking assets from Cloudinary.
Asset pickerAsset type field widget. It allows selecting assets from your project, and supports any file type.
ColorColor type field widget. Supports HEX and RGBA.
MapLocation type field widget. Allows adding geo coordinates to your content.
DropdownEnumeration type field widget. Allows adding a dropdown list of values to your content.
Basic ComponentComponent type field widget. This basic widget is used for single components. Click here to learn more about Components.
Modular ComponentModular component type field widget. This modular widget is used for multiple components. Click here to learn more about Components.
ReferenceRelation type field widget. It is used for content relationships.
RESTREST type field widget. It is used to add external data via REST.
GraphQLGraphQL type field widget. It is used to add external data via GraphQL.
Widget nameDescription
Entry informationSystem sidebar widget, added to your model by default. It offers basic entry information.
LocalizationsSystem sidebar widget, added to your model by default. It allows viewing localized fields.
StagesSystem sidebar widget, added to your model by default. It allows viewing in-app content stages.
VersionsSystem sidebar widget, added to your model by default. It allows viewing the evolution of your content.
ScheduleSystem sidebar widget, added to your model by default. It allows scheduling entries to be published later.
PreviewSystem sidebar widget. It allows previewing content changes by adding a preview link to your content.

Click here to know more about system fields.

#Components

ConceptDescription
ComponentA component is a predefined set of fields that can be reused across models and content entries.
Component instanceA specific occurrence of the component type, containing content, inside a content entry.
Component fieldA 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.
Nested componentsFunctionality that allows you to create components within a component.

Click here to know more about components.