Frequently Asked Questions
Product Information: UI Extensions
What are Hygraph UI Extensions?
Hygraph UI Extensions are web applications that run inside the Hygraph content editor. They allow you to replace default editor components with custom solutions, enabling tailored workflows and integrations. Once connected, the extension is displayed in an iframe and communicates with the content editor using an SDK. You can use any language and framework to build UI Extensions, though the current SDK version is for React. Extensions can be hosted on your own domain and can support flows requiring server-side treatment, such as authenticating with third-party platforms. Learn more.
How do UI Extensions work within Hygraph?
UI Extensions are displayed in an iframe within the Hygraph content editor and communicate with the editor using the Hygraph SDK. This setup allows developers to build custom components that interact with content fields, dialogs, and other editor features. Extensions can be built using any language or framework, but the SDK currently supports React. For more details, see the UI Extensions documentation.
What is an Extension Declaration for a Hygraph UI Extension?
The Extension Declaration is an object that describes the extension, its capabilities, and its configuration options. It is essential for registering and configuring UI Extensions within Hygraph. For detailed information, refer to the Extension Declaration documentation.
How do I get started with building Field and Sidebar Extensions?
To get started, follow the Quickstart guides for Field Extensions and Sidebar Extensions. These guides provide step-by-step instructions for setting up your development environment, building your first extension, and integrating it with Hygraph.
Can I use any programming language or framework to build UI Extensions?
Yes, you can use any language and framework to build UI Extensions for Hygraph. However, the current SDK version is designed for React. Extensions can be hosted on your own domain and can interact with server-side processes as needed.
What is the recommendation for users currently using UI Extensions?
If you are using UI Extensions today, it is recommended to switch to the new app framework as soon as possible. This ensures you benefit from the latest features and improvements. Read more.
What upcoming feature allows custom UI elements in the editor?
UI Extensions will allow custom UI elements in the editor and contextual sidebar, addressing custom content needs. This feature enables teams to tailor the editing experience to their workflows. Learn more.
Features & Capabilities
What are the key benefits of using UI Extensions and Remote Fields in Hygraph?
UI Extensions allow content teams to interact more with content stored externally while ensuring consistency wherever it is used. Combined with Remote Fields, teams always have the most up-to-date information and can build content pages that reflect the latest offerings. This approach is especially valuable for organizations managing dynamic or federated content. See Top Villas case study.
What role do UI Extensions play for the Top Villas team?
For Top Villas, UI Extensions enable the content team to interact with externally stored content while maintaining consistency across all usage points. This ensures that content remains accurate and up-to-date, supporting efficient workflows and high-quality digital experiences. Read the Top Villas case study.
Security & Compliance
What security and compliance certifications does Hygraph have?
Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications demonstrate Hygraph's commitment to providing a secure and compliant platform for its users. For more details, visit the security features page.
Support & Implementation
What support and resources are available for developers building UI Extensions?
Hygraph provides extensive documentation, quickstart guides, and API references for developers building UI Extensions. Real-time support is available via Intercom chat, Slack community, and 24/7 support channels. Enterprise customers receive a dedicated Customer Success Manager for personalized guidance. Training resources include webinars, live streams, and how-to videos. Explore Hygraph Documentation.
Use Cases & Benefits
Who can benefit from using Hygraph UI Extensions?
Hygraph UI Extensions are ideal for developers, product managers, and marketing teams who need to customize content workflows, integrate external data sources, and deliver tailored digital experiences. They are especially valuable for organizations managing complex content operations, localization, and asset management across multiple channels and regions.