Enum representing the types of UI5 artifacts supported by the system.
Each artifact type corresponds to a distinct kind of module or UI component
that can be registered, versioned, and deployed within the Laravel-based UI5 integration.
Vocabulary-only entries — some cases (AnalyticTile, AnalyticCard,
AnalyticsSet) have no Core interface. Downstream packages provide
their own typed interfaces and bind them to these vocabulary tags
(Core Dashboard API v0.9 §D3).
| Cases |
Module = 0
A UI5 module providing a logical container for artifacts such as applications,
cards, analytic tiles, actions, or…
A UI5 module providing a logical container for artifacts such as applications,
cards, analytic tiles, actions, or libraries. Modules define the namespace scope
and slug used for routing and access control, and typically correspond to a PHP
package or subdirectory within the ui5/ structure.
Modules themselves are not directly routable or versioned as standalone resources,
but serve as the root context for all included artifacts.
|
#
|
Application = 1
A standalone UI5 application with its own routing, Component.js, and entry point.
Typically served as a separate HTML…
A standalone UI5 application with its own routing, Component.js, and entry point.
Typically served as a separate HTML page.
|
#
|
Library = 2
A reusable UI5 library containing controls, formatters, helpers, or shared logic.
Can be imported by multiple…
A reusable UI5 library containing controls, formatters, helpers, or shared logic.
Can be imported by multiple applications.
|
#
|
Card = 3
A UI5 Integration Card, such as ObjectCard, ListCard, or TableCard.
Usually configured via a manifest and rendered…
A UI5 Integration Card, such as ObjectCard, ListCard, or TableCard.
Usually configured via a manifest and rendered inside a dashboard or shell.
|
#
|
Report = 4
A backend-powered report providing structured tabular or aggregated data.
Typically supports parameterization and…
A backend-powered report providing structured tabular or aggregated data.
Typically supports parameterization and optional export (e.g., CSV, Excel).
|
#
|
Tile = 5
A Tile definition — single-value visual primitive rendered inside a
Dashboard Group. Each tile provides metadata such…
A Tile definition — single-value visual primitive rendered inside a
Dashboard Group. Each tile provides metadata such as title and
description, and produces a typed UI5 tile control (a Tile —
GenericTile / ActionTile / SlideTile) via its TileProviderInterface
at emission time.
Characteristics:
- Routable: No. Tiles are embedded only, never accessed via URL directly.
- Versionable: Yes. Tile metadata and tile-provider implementations may change.
- Discoverable: Yes. Tiles are registered in the Ui5Registry.
|
#
|
AnalyticTile = 6
Vocabulary entry for analytic tiles (Core Dashboard API v0.9 §D3).
**No Core interface ships** — downstream packages (e…
Vocabulary entry for analytic tiles (Core Dashboard API v0.9 §D3).
No Core interface ships — downstream packages (e.g. SDK Analytics)
bind their own typed interface to this tag.
Integer value 6 preserved from the renamed Kpi case to honor the
"never change ArtifactType enum values" invariant (core/CLAUDE.md).
|
#
|
Dashboard = 7
A dashboard aggregating Groups of Tiles and Cards in a layout.
The Dashboard JSON wire emits a `{ui5.class.name:…
A dashboard aggregating Groups of Tiles and Cards in a layout.
The Dashboard JSON wire emits a {ui5.class.name: properties} UI5
control tree (Core Dashboard API v0.9 §D1/§D4).
|
#
|
Action = 8
A backend-bound action that can be triggered via direct API route.
UI5 Actions are invokable controller classes…
A backend-bound action that can be triggered via direct API route.
UI5 Actions are invokable controller classes designed for stateless interaction,
such as toggling flags, triggering workflows, or executing custom business logic.
Actions are uniquely addressable within their module via an HTTP method and route segment.
|
#
|
Resource = 9
A Resource is a lightweight, read-only UI5 artifact that exposes
structured data for consumption by the client (e.g.,…
A Resource is a lightweight, read-only UI5 artifact that exposes
structured data for consumption by the client (e.g., cards, dashboards, lists).
|
#
|
Dialog = 10
A Ui5Dialog is a globally invokable View/Controller pair. It is not
routable — the shell opens it by namespace, it is…
A Ui5Dialog is a globally invokable View/Controller pair. It is not
routable — the shell opens it by namespace, it is never navigated to
by URL, and routePrefix() has no arm for it.
|
#
|
ValueHelp = 11
A ValueHelp — a provider-owned search-help modal any field can invoke
to browse a business object and return a…
A ValueHelp — a provider-owned search-help modal any field can invoke
to browse a business object and return a selection. The successor of the
global Dialog: it rides the Global Dialog API verbatim and adds only a
shell-brokered return channel (LUX Weave Facet D).
Accessible (carries #[Access]) but not routable — it is opened by
namespace through the shell, never navigated to by URL.
|
#
|
AnalyticsSet = 12
|
#
|
DashboardGroup = 13
Composition node between a Dashboard and the Tiles/Cards it
aggregates (Core Dashboard API v0.9).
Composition node between a Dashboard and the Tiles/Cards it
aggregates (Core Dashboard API v0.9).
|
#
|
AnalyticCard = 14
Vocabulary entry for analytic cards (Core Dashboard API v0.9 §D3).
**No Core interface ships** — downstream packages…
Vocabulary entry for analytic cards (Core Dashboard API v0.9 §D3).
No Core interface ships — downstream packages bind their own
typed interface to this tag.
|
#
|
Chart = 15
A Chart artifact — single visual primitive rendered inside a
Dashboard Group, emitting a {@see \LaravelUi5\Core\Ui5…
A Chart artifact — single visual primitive rendered inside a
Dashboard Group, emitting a {@see \LaravelUi5\Core\Ui5\Controls\Lux\Chart}
DTO carrying an engine-tagged option envelope (ECharts at v0.9).
Mirrors the Tile pattern: the artifact is pure metadata + a handle
to its {@see \LaravelUi5\Core\Ui5\Capabilities\ChartProviderInterface},
which computes the whole chart DTO (engine + option) from bound
slot values and the request context at emit time.
Characteristics:
- Routable: No. Charts are embedded only, listed alongside Tiles
and Cards in a Group's
getChildNamespaces().
- Versionable: Yes.
- Discoverable: Yes. Charts are registered in the Ui5Registry.
|
#
|