Resource View Service

The resource-view service holds the resource view registries: named slots in each engine's tables and details views that other extensions can add columns, actions and buttons to.

// addon/extension.js
export default {
    setupExtension(app, universe) {
        const views = universe.getService('resource-view');
    },
};

getService also accepts 'resourceView', 'resource-views', 'resource-view-service' and 'universe/resource-view-service'. Inside an engine, the service is universe/resource-view-service. It is shared with the host, so every engine sees the same registries.

Registering

register(registryName, items)

Register one item, or an array of items, into a slot. Returns true when every item was accepted.

views.register('fleet-ops:driver:table:columns', new TableColumn({ id: 'acme-score', label: 'Score', valuePath: 'meta.acme_score' }));
views.register('ledger:invoice:details:menu', [itemA, itemB]);

An item is rejected, with a debug message in the console, when:

• registryName does not follow <extension>:<resource>:<table|details>:<slot>, or uses a slot that surface does not have (see Registry Names);
• the item has no id;
• it is a contract of the wrong kind for the slot, for example an ActionButton in columns.

Registering an id that is already in the slot replaces the earlier item. Items may be contracts or plain objects. Each is stored as a plain object, tagged with its kind.

Shortcuts

Each takes (extension, resource, item) and builds the registry name for you:

The same shortcuts are on the Universe facade, as universe.registerTableColumn(…) and so on, alongside universe.registerInResourceView(registryName, items).

unregister(registryName, id)

Remove an item. Returns true if one was removed.

Reading

get(registryName)

The items registered in a slot, in registration order. An invalid name returns an empty array.

resourceRegistryNames(extension, resource)

The seven registry names for one resource:

views.resourceRegistryNames('iam', 'user');
// ['iam:user:table:columns', 'iam:user:table:row-actions', 'iam:user:table:bulk-actions',
//  'iam:user:table:actions', 'iam:user:details:actions', 'iam:user:details:menu',
//  'iam:user:details:tabs']

The tabs Slot

<extension>:<resource>:details:tabs is an alias. Details tabs are stored where they always have been, in the menu service's <extension>:component:<resource>:details registry, so tabs registered under either name are the same tabs. register, get, unregister and declare all accept the alias. Tabs must be MenuItems (or plain objects), and are keyed by slug rather than id.

Declaring (Engine Authors)

declare(extension, resources)

Create every registry for the given resources, and return their names. Call it from your engine's setupExtension:

universe.getService('universe/resource-view-service')?.declare('acme', ['shipment', 'carrier']);

Merging (Engine Authors)

The resource layouts merge for you when given @registry. These methods are for views that build their own lists. See Making Views Extensible.

merge(registryName, baseItems = [], context = {})

A view's built-in items with the slot's registered items merged in. Registered items are placed by before, after, index and priority, or at the slot's default spot. Their handlers are bound to the view context. Each registered item is a fresh copy, so changing it does not change the registry. When nothing is registered, or the name is invalid, it returns the built-in items as a plain array.

context is merged with registry, extension, surface, resourceName, slot and owner, and handed to every handler. Getters on it stay getters.

mergeSlot(prefix, slot, baseItems = [], context = {})

merge(), addressed by a surface prefix and a slot: mergeSlot('acme:shipment:table', 'bulk-actions', items, ctx).

mergeRowActions(prefix, columns = [], context = {})

The columns, with registered row actions merged into the actions of the column whose cellComponent is table/cell/dropdown. Other columns are returned as they are.

Filters

queryParamsFor(extension, resource, baseQueryParams = [])

An index controller's query params, plus the filterParam of each filterable column registered for <extension>:<resource>:table. Use it for the controller's queryParams class field:

queryParams = views.queryParamsFor('acme', 'shipment', ['page', 'limit', 'sort', 'query']);

After this is called for a table, registering another filterable column for it logs a warning, because the controller's query params are already fixed. See Filterable Columns.

On ResourceActionService

Action services extending ResourceActionService get these, derived from initialize(modelName, { mountPrefix, registryResource, registryExtension }):

In @fleetbase/ember-ui

See Also

• Resource Views: what you can add, with diagrams
• Getting Started: a first column and action, step by step
• Columns, Row Actions, Bulk Actions, Toolbar Buttons, Header Buttons, Menu Items, Tabs: every option, per element
• Contracts: TableColumn, ResourceAction, ActionButton
• Registry Service: the storage underneath

Source