Glossary
#Basic concepts
| Concept | Description |
|---|---|
| API Playground | The API Playground, located on the left sidebar of the Hygraph app, allows you to to experiment with querying, and mutating data. |
| Assets | The 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. |
| Component | A 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 modeling | The 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 views | Hygraph 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. |
| Enumeration | An 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. |
| Model | You can define your schema by adding models and then adding fields to said models. Click here to learn more about models. |
| Mutations | Operations that allow you to insert new data or modify the existing data on the server-side. Click here to learn more about mutations. |
| Preview URLs | Preview 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. |
| Relations | References, 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 sources | Remote 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 editor | Inside the schema editor, you can add fields, create relationships between models, and much more. Click here to learn more about our schema editor. |
| Sidebar | When 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 fields | All 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 name | Description |
|---|---|
| Draft | Content that has never been published. Draft content can be added, edited and saved, without affecting published content. |
| Published | Published 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 name | Description |
|---|---|
| Single line text | String type field widget. It is used for adding headings and titles. |
| Multi line text | String type field widget. It is used for adding text such as descriptions. |
| Markdown | String type field widget. This widget is a markdown editor. |
| Slug | String type field widget. It is used for adding URL friendly identifiers to your content. |
| Rich text | Text type field widget. This widget is a text editor with formatting. |
| Number | Integer type field widget. It is used for adding a numeric field, such as an ID or identifier. |
| Float | Float type field widget. It is used for adding numbers that are not integers because they can include decimal values, for example, ratings or prices. |
| Boolean | Boolean type field widget. It is used for adding a switch that represents true/false. |
| Date | Date type field widget. This is a calendar date picker. |
| Date and time | Date and time type field widget. This is a calendar date picker that includes time. |
| JSON editor | JSON type field widget. It allows adding arbitrary JSON structures. |
| Cloudinary asset | JSON type field widget. It allows picking assets from Cloudinary. |
| Asset picker | Asset type field widget. It allows selecting assets from your project, and supports any file type. |
| Color | Color type field widget. Supports HEX and RGBA. |
| Map | Location type field widget. Allows adding geo coordinates to your content. |
| Dropdown | Enumeration type field widget. Allows adding a dropdown list of values to your content. |
| Basic Component | Component type field widget. This basic widget is used for single components. Click here to learn more about Components. |
| Modular Component | Modular component type field widget. This modular widget is used for multiple components. Click here to learn more about Components. |
| Reference | Relation type field widget. It is used for content relationships. |
| REST | REST type field widget. It is used to add external data via REST. |
| GraphQL | GraphQL type field widget. It is used to add external data via GraphQL. |
#Sidebar widgets
| Widget name | Description |
|---|---|
| Entry information | System sidebar widget, added to your model by default. It offers basic entry information. |
| Localizations | System sidebar widget, added to your model by default. It allows viewing localized fields. |
| Stages | System sidebar widget, added to your model by default. It allows viewing in-app content stages. |
| Versions | System sidebar widget, added to your model by default. It allows viewing the evolution of your content. |
| Schedule | System sidebar widget, added to your model by default. It allows scheduling entries to be published later. |
| Preview | System sidebar widget. It allows previewing content changes by adding a preview link to your content. |
Click here to know more about system fields.
#Components
| Concept | Description |
|---|---|
| Component | A component is a predefined set of fields that can be reused across models and content entries. |
| Component instance | A specific occurrence of the component type, containing content, inside a content entry. |
| Component field | 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. |
| Nested components | Functionality that allows you to create components within a component. |
Click here to know more about components.