Uniform Mesh is a powerful framework that allows developers to extend the Uniform user interface with custom web applications. These integrations appear as native parts of the Uniform dashboard while running as separate web applications that communicate through iframe messaging.
- Seamless Integration: Custom functionality appears native within Uniform's interface
- Flexible Architecture: Build with any web technology, hosted anywhere accessible to browsers
- Extensible: Add custom data connectors, parameter types, asset libraries, and tools
- Consistent UX: Use Uniform's design system for cohesive user experience
- Secure: Controlled communication through established messaging protocols
-
Web Application
- Next.js application (recommended) with page router
- Provides custom UI and business logic
- Communicates with Uniform through React SDK
-
Manifest File (
mesh-manifest.json)- JSON configuration defining integration capabilities
- Specifies locations, URLs, and metadata
- Registered with Uniform team settings
-
Location Types
- Specific integration points within Uniform's UI
- Each location has dedicated URL and functionality
- Supports dialogs and nested interfaces
- Purpose: Integration-wide configuration
- Access: Project Settings > Integrations
- Use Cases: API keys, connection settings, feature toggles
- Purpose: Connect external data sources to Uniform
- Components:
- Data Source Editor: Configure connection settings
- Data Type Editor: Define data structure and fields
- Data Resource Editor: Select specific data items
- Use Cases: CMS content, e-commerce products, external APIs
- Purpose: Custom input controls for Canvas components
- Features: Custom editors, validation, configuration options
- Use Cases: Specialized inputs, custom media selectors, business logic parameters
- Purpose: Extend asset management with external providers
- Components:
- Asset Library: Browse and search external assets
- Asset Parameter: Select assets within components
- Use Cases: Stock photo services, DAM systems, custom media repositories
- Purpose: Add custom functionality to Canvas and Entry editors
- Locations: Composition editor, component patterns, entry editor
- Use Cases: Content workflow tools, validation utilities, bulk operations
- Purpose: Add custom tools to project navigation
- Features: Dashboard widgets, analytics views, custom reports
- Use Cases: Analytics dashboards, content reports, external tool integration
- Purpose: Custom selection criteria for personalized content
- Use Cases: Custom visitor classification, business rule engines
- Purpose: Custom AI generation workflows
- Features: Template prompts, parameter configuration
- Use Cases: Content generation, optimization suggestions
Examples: WordPress, Contentful, custom CMS
Locations: Data source + type + resource editors
Features: Content selection, field mapping, preview variants
Examples: Pexels, Unsplash, internal DAM
Locations: Asset library + parameter editors
Features: Search, filters, metadata preservation
Examples: Umami, Google Analytics dashboard
Locations: Project tools, dashboard tools
Features: Embedded dashboards, metric visualization
Examples: Jira integration, approval workflows
Locations: Canvas editor tools
Features: Comment systems, status tracking, notifications
Examples: Rich text editors, specialized inputs
Locations: Canvas parameter types
Features: Custom validation, dynamic token support
- Framework: Next.js with page router (recommended)
- SDK:
@uniformdev/mesh-sdk-react - Design System:
@uniformdev/design-system - Language: TypeScript (strongly recommended)
- Custom Edgehancers: Server-side JavaScript execution at edge
- Dialog Management: Modal interfaces and nested workflows
- Validation Framework: Custom validation logic and error handling
- Run
npx @uniformdev/cli@latest new-integration - Configure environment variables (API keys, team/project IDs)
- Develop integration pages and components
- Test locally on
localhost:9000
- Register manifest with Uniform team
- Install integration on specific projects
- Configure integration settings
- Deploy to production hosting
- Deploy to hosting provider (Vercel, Netlify, etc.)
- Update manifest with production URLs
- Re-register updated manifest
- Test production functionality
- Use HTTPS for all production integrations
- Store sensitive data in integration settings (not public config)
- Configure appropriate CORS headers
- Validate all user inputs
- Implement proper error boundaries
- Use loading states for async operations
- Optimize asset loading and caching
- Minimize bundle size
- Follow Uniform's design system guidelines
- Implement proper validation feedback
- Use consistent interaction patterns
- Provide clear error messages
- Data Source: Configure API connection
- Data Type: Define data structure and fields
- Data Resource: Enable content selection
- Optional: Custom edgehancers for data processing
- Parameter Types: Custom input components
- Editor Tools: Workflow and utility functions
- Project Tools: Dashboard and reporting interfaces
- Asset Library: External media integration
- Custom Edgehancers: Server-side data processing
- Personalization: Custom audience algorithms
- AI Integration: Content generation workflows
- Multi-location: Complex integrations spanning multiple locations
- Custom edgehancers: 100ms CPU time limit
- Browser compatibility: Must work within iframe context
- Network access: Integration URLs must be accessible to browsers
- Hosting requirements: Public accessibility to https://uniform.app
- SSL certificates: Required for production deployments
- CORS configuration: Proper headers for cross-origin requests
- Framework compatibility: Optimized for React/Next.js
- Communication protocol: Limited to iframe messaging
- UI consistency: Must follow Uniform design system
- Uniform team and project access
- Node.js development environment
- Understanding of React/Next.js
- External system API access (if applicable)
- Run integration creation command
- Set up local development environment
- Implement required location pages
- Test locally with Uniform dashboard
- Configure production deployment
- Register and install integration
- HTTPS deployment configured
- Error handling implemented
- Security best practices followed
- User documentation created
- Testing completed across use cases
- Uniform CLI for integration management
- Development examples and templates
- TypeScript definitions and IntelliSense support
This overview provides developers with a comprehensive understanding of Uniform Mesh capabilities and how to leverage them for extending Uniform's functionality with custom integrations.