The Bring Your Own framework is intended for developers who have a strong understanding of the Unqork Designer Platform and JavaScript.
Overview
The BYO framework enables developers to create custom events that integrate seamlessly with the Unqork Designer Platform. Custom events can be scoped to individual components or registered as global events. After defining and registering a custom event, it functions as a native event that can be used throughout the platform.
For security reasons, external URLs cannot be imported into a BYO implementation file. Unqork recommends copying external source code and importing it into the JavaScript file.
Event Definition
Define custom event key attributes in the manifest.json file. Each entry in the root-level or component-level events array (components → events) defines an event available in the Unqork Designer Platform.
Learn more about the event definition in our BYO: Understanding the manifest.json File article.
A component can dispatch custom events that are handled through configuration in the Operations Builder. This enables developers to trigger logic or workflows in response to component behavior.
Define each event as a named export in your main JavaScript file. The export name must match the type value specified in the manifest.json file.
class CustomEvent {
name = 'myComponentClick';
payload = {};
}
export const myComponentClick = {
model: async () => CustomEvent
}Event Payloads
Custom events can carry structured payload data. This data provides context about end-user interactions triggering events.
Developers define the event payloads in the implementation JavaScript and manifest.json. After implementation, a Creator can use the values of the event payload in their configuration by referencing the Operations Builder's Context Reference panel.
Passing values, like the content of an input field, ID of a clicked row, or a selected cell, lets Creators make operation logic dynamic and responsive to end-user actions. Downstream operations can use these values to perform targeted updates based on the event’s context.
Learn more about event payloads in our BYO: Event Payloads article.
Resources
Bring Your Own (BYO) Framework Landing Page
Find all the resources needed to build your own components here.
Introduction to the Bring Your Own (BYO) Framework
Get started building your own custom assets, including components, events, and operations.
Create a BYO Package
Discover the structure and content of a BYO Package
Understanding the manifest.json File
Learn about the file's specification, component and event definitions.
Understanding the BYO Runtime Engine API
Discover the interface between your custom BYO components and the Unqork platform.
Custom Component SDK
Extend component functionality in the Unqork Designer Platform.
Custom Component
Understand the state, interface, and events of a custom component.
Event Payloads
Learn more about viewing and using event payloads with the Operations Builder.
Custom Operations
Learn more about creating custom operations for use in the Operations Builder..
BYO Implementation Examples
Discover examples of component implementation using the Unqork Designer Platform.
BYO Best Practices
Learn about best practices for implementing and using BYO assets.
BYO General FAQ
Learn about the Bring Your Own Framework and discover frequently asked questions.