Override ID Addressing

Every view in UIGen has a stable uigenId that you use to target it with the Override System. This page documents the full addressing scheme.

Default ID pattern

Auto-generated IDs follow the pattern:

{resourceSlug}.{viewHint}

Full addressing table

Resource slug derivation

The resource slug is derived from the path by:

1. Taking the first path segment after / (e.g. /users/{id} → users)
2. Lowercasing and replacing non-alphanumeric characters with -

For example:

• /users → users
• /api/v1/users → users (first meaningful segment)
• /user-profiles → user-profiles

Custom IDs

Pin a custom ID using the x-uigen-id annotation:

paths:
  /users:
    get:
      x-uigen-id: user-list

Then target it in the Override System:

overrideRegistry.register({
  id: 'user-list',
  mode: 'component',
  component: MyUserTable,
});

Wildcard targeting

You can target all views for a resource using a wildcard (planned, not yet available):

// Coming Soon
overrideRegistry.register({
  id: 'users.*',
  mode: 'useHooks',
  useHooks: myAnalyticsHook,
});

Inspecting IDs

To see the uigenId for each view, inspect ir.resources[n].operations[n].uigenId in the browser console:

console.log(window.__UIGEN_CONFIG__.resources.map(r => ({
  resource: r.slug,
  operations: r.operations.map(o => o.uigenId),
})));