Design Requirements
The purpose of this document is to make construction and design homologation requirements more transparent. These requirements have been categorized by urgency and mandatory status.
Urgency Categorization
Mandatory Categorization
NubeSDK Usage
Starting on June 5, 2026, adopting the NubeSDK becomes mandatory for homologation approval. Apps submitted after that date will not be approved without the SDK.
For reviewers: from the deadline onward, verify as part of the approval flow whether the app was built with the NubeSDK. Apps using the legacy model (document, window, jQuery, or direct DOM manipulation) must not be approved.
In this item, the partner must ensure the application was built using the NubeSDK — the recommended model for apps running on Nuvemshop's storefront and checkout.
| Description | Link | Mandatory |
|---|---|---|
| App built with NubeSDK (from June 5, 2026 onward) | Migration Guide | Mandatory |
Does not use document, window, jQuery, or direct DOM | Migration Guide | Mandatory |
Before submitting, confirm that:
- The app is implemented with the NubeSDK and runs inside a Web Worker.
- There are no dependencies on direct DOM manipulation,
document,window, or libraries like jQuery. - The UI is built with the NubeSDK components and the appropriate UI Slots .
Use the NubeSDK DevTools (Chrome extension) to quickly confirm whether the app is running with the NubeSDK: the Apps section lists the applications built with the SDK and lets you inspect components, events, and state in real time.
For more context on the deadline, see the Homologation overview and the Applications overview .
Usage of Nimbus Templates
In this item, we must pay attention to the use of Nimbus templates in order to achieve greater visual consistency with Nuvemshop products.
| Description | Link | Mandatory |
|---|---|---|
| Empty and initial state page | See guidelines | Mandatory |
| Error page | See guidelines | Mandatory |
| Forms page | See guidelines | Recommended |
| Confirmation modal | See guidelines | Recommended |
| Settings page | See guidelines | Recommended |
| Simple table page | See guidelines | Recommended |
| Product table page | See guidelines | Recommended |
| Template customization limits | See guidelines | Mandatory |
Usage of Components and Patterns
In this item, we must pay attention to the assignment of components and patterns according to their respective documentation.
| Description | Link | Mandatory |
|---|---|---|
| Atomic and composite components | See guidelines | Mandatory |
| Composition patterns | See guidelines | Recommended |
| Form components | See guidelines | Recommended |
| Customization and flexibility limits | See guidelines | Mandatory |
Usage of UX/UI Concepts
In this item, we must pay attention to behaviors and element arrangement to achieve greater consistency with Nuvemshop products.
| Description | Link | Mandatory |
|---|---|---|
| Prioritization and organization of actions and contents | See guidelines | Mandatory |
| Status signaling and standardization of elements | See guidelines | Recommended |
| Feedback messages and confirmations | See guidelines | Recommended |
| Information processing and loading | See guidelines | Recommended |
| Data organization in tables | See guidelines | Recommended |
| Responsiveness and element alignment | See guidelines | Mandatory |
| Organization and signaling in forms | See guidelines | Recommended |
Usage of UX Writing Concepts
In this item, we must pay attention to the text in interfaces and their respective elements in order to provide a better user experience and understanding.
| Description | Link | Mandatory |
|---|---|---|
| Naming of applications and screens | See guidelines | Mandatory |
| UX Writing Fundamentals | See guidelines | Mandatory |
| Nuvemshop's Tone of Voice | See guidelines | Mandatory |
| Text Patterns | See guidelines | Mandatory |