Blueprint UI
vyuh_blueprint_ui turns your model's UI metadata into Flutter screens. Use it to display records, edit fields, and run actions through your Blueprint server.
What you configure
- Collections: choose fields, filters, sorting, and layouts.
- Forms: choose which fields people enter and how they are grouped.
- Actions: make the model's available operations accessible from the screen.
- Navigation: organize entities and features into your application.
- Custom views: add specialized screens through extension points.
The record dock
When someone selects a record, the shell can show it in a dock beside the collection (or below it). The dock shows only the panes your application declares. Nothing is added for you:
Blueprint.application(
name: 'ops',
title: 'Operations',
version: '1.0.0',
blueprint: opsBlueprint,
workspace: const Workspace(
rightDock: WorkspaceRegion(
name: 'right_dock',
surfaceRefs: ['entity.details', 'entity.blueprint'],
),
),
);entity.detailsshows the selected record's fields and tabs.entity.blueprintshows the record's Blueprint metadata.
Declare them on rightDock or bottomStream. With no record pane declared, the dock is hidden, and the shell logs once that the application declares no record pane.
The shared Studio widgets ship in this package. Declare the model and presentation hints, then add custom screens where your application needs them.
Studio building blocks
Use the Studio components directly when building a custom screen.
| Component | Use it for |
|---|---|
| StudioWorkspace | Arrange an application's main content and panels |
| Collection view | Display records with filtering and sorting |
| Detail view | Show one record and its related information |
| Command palette | Provide searchable application commands |
| History and evidence panels | Show changes and supporting information |
Generic controls such as the action panel, the field-value table, section cards and the semantic icons come from vyuh_cdx_ui. Import it directly; vyuh_blueprint_ui does not re-export it.
Start with UI, queries, and forms, then explore UI hints.
Permissions shown in the interface reflect access rules; the server enforces those rules when an action runs.