On this page
@addTagHelper *, Webority.Ui.RazorA review queue
Work through a queue one item at a time, with the open item beside the list.
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- A
- Approve the open request
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
Selection and bulk actions
Tick items to act on several at once, while the open item stays open beside them.
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Leave request: 3 days
PendingAsha Rao · Design
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
Keyboard
J and K move focus down and up the list, Enter opens the focused item, X ticks it (with selectable), ? opens the sheet of every shortcut and Escape closes it. Each <app-split-shortcut> adds a single key: it raises a cancelable wui:shortcut event (with the open item's key) and then clicks its target. The legend is an <app-shortcut-legend>, so the keys behave as they do everywhere else in the library.
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- A
- Approve the open request
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
On a phone
Below the stack breakpoint the list and the item take turns, so each screen shows one thing.
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Loading the pane
Show a placeholder in the pane while a slow request fetches the item it opens.
Leave request: 3 days
PendingAsha Rao · Design
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
Every option
Every value of every prop, one cell each.
items: the list
items: a review queue- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
items: with links- Leave request: 3 days09:122
- Expense claim: client travelYesterday
- Laptop replacementMon
- Training budget12 Oct
- Work from home: Friday11 Oct
- Conference ticket10 Oct
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
items: titles only- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
items: none (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
pane-src: the pane loads from a URL- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
currentKey: the open item
current-key: not set- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
current-key="r1"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
current-key="r3"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
onSelect, onToggle and onToggleAll: callbacks
onSelect: the wui-split:select event- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
onToggle: the selectionchange event- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
onToggleAll: the selectionchange event- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
selectable: checkboxes and the select-all box
selectable="false" (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
selectable="true"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
selectedKeys: the ticked items
selectedKeys: none ticked- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
selectedKeys: two ticked- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
bulkActions: buttons while items are ticked
bulkActions: approve and reject- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
bulkActions: not set- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
header: the list header
header: count and sort- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
header: not set- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
chips: filters under the header
chips: one filter- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
chips: not set- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
pane: the open item's content
pane: an open request- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
pane: nothing open- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
paneHeader: above the pane
paneHeader: a status- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
paneHeader: not set- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
pager: the record pager
pager="true" (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
pager="false"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
shortcuts: extra single keys
shortcuts: approve (A)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- A
- Approve the open request
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
shortcuts: not set- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
shortcutsEnabled: the legend and the keys
shortcuts-enabled="true" (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
shortcuts-enabled="false"Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
empty: shown with no items
empty: built-in text (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
empty: an empty state- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
loading: placeholder items
loading="false" (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
loading="true"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
listWidth: the list's share of 12 columns
list-width="3"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
list-width="4"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
list-width="5" (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
list-width="6"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
list-width="7"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
list-width="8"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
stackBelow: where the two screens begin
stack-below="sm"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
stack-below="md"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
stack-below="lg"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
stack-below="xl" (default)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
stack-below="xxl"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
linkComponent: router links
linkComponent: a router link (Razor: href)- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
labels: the built-in English text
loading-label="Please wait"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
items-label="Entries"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
select-item-label="Tick {title}"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
select-all-label="Tick every entry"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
reading-pane-label="Preview"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
previous-item-label="Earlier"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
next-item-label="Later"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
open-label="View"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
move-label="Drag"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
selected-label="{count} ticked"- J
- Next item
- K
- Previous item
- Enter
- Open the item
- X
- Select the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
untitledItemLabel: the React prop only, Razor has none- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
className: extra classes on the root element
className: the React prop, Razor uses class- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
PendingDev Patel · Sales
The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.
Guidance
What to do, and what to avoid.
Use it when
- People work through a queue one item at a time: approvals, an inbox, drafts, review.
- Each item needs reading, not just a glance at a row.
- Moving to the next item should take one key, not a page load.
Reach for something else when
- People compare items across many columns. → AppDataTable
- The detail is a quick peek from a table. → AppDrawer
- Each item is edited in a long form. → its own page
Mark the open list item
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
One item is open and marked in the list, so it is clear what the pane shows.
Expense claim: client travel
A pane with content but no open item: nothing in the list says which item it belongs to.
One line of context per item
Leave request: 3 days
Items carry a title and one line of context; the detail waits in the pane.
Leave request: 3 days
Packing the detail into the list makes every item tall and the queue slow to scan.
Reference
Try every prop, read the full list, and check keyboard and screen reader behaviour.
26 props. The 2 most used come first.
Used on most screens 2 props
| Prop | Type | Default | Description |
|---|---|---|---|
| current-keydefault - | string | - | The key of the open item. It gets aria-current and the subtle primary background. |
| selectabledefault false | bool | false | A checkbox on each item and a select-all box in the header. |
Less common 24 props
| Prop | Type | Default | Description |
|---|---|---|---|
| shortcuts-enableddefault true | bool | true | The keyboard shortcuts and their legend. They listen while focus is in the view, or nowhere for the first view on the page. |
| pagerdefault true | bool | true | The record pager at the end of the pane header: "3 of 12" over the items on screen, and previous and next, which open the item before or after the open one as a click on it would. Turn it off to put your own pager in paneHeader for a paged list whose total is larger than the items on screen. |
| loadingdefault false | bool | false | Placeholder items instead of the list. |
| list-widthdefault 5 | 3 | 4 | 5 | 6 | 7 | 8 | 5 | The list's share of 12 columns when side by side. |
| stack-belowdefault xl | sm | md | lg | xl | xxl | xl | Below this tier the list and pane are two screens. |
| app-split-itemdefault - | child | - | An item: key and title (required), href, pane-src (the URL whose HTML fills the pane), badge, selected. Its content is the line under the title; a trailing child sits at the end of the row. |
| app-split-headerdefault - | child | - | The list header: a count, a sort label, a filter trigger. |
| app-split-chipsdefault - | child | - | A row under the header for the active filters. |
| app-split-bulkdefault - | child | - | Buttons shown in place of the header while items are ticked. |
| app-split-panedefault - | child | - | The open item's content, rendered with the page. A loaded pane-src replaces it. |
| app-split-pane-headerdefault - | child | - | Above the pane, before the pager: the open item's status, a way back to the list on a phone. A pane head template in a fragment replaces the whole header, pager included. |
| app-split-shortcutdefault - | child | - | An extra single-key shortcut: key, label, and target (a selector it clicks). It raises a cancelable wui:shortcut event first. |
| app-split-emptydefault Nothing here yet. | child | Nothing here yet. | Shown when there are no items. |
| onSelect / onToggle / onToggleAlldefault - | callbacks | - | Razor raises wui-split:select, wui-split:loaded, wui-split:error and selectionchange on the view instead. |
| loading-labeldefault Loading | string | Loading | Replaces the built-in English text, for other languages. |
| items-labeldefault Items | string | Items | Replaces the built-in English text, for other languages. |
| select-item-labeldefault Select {title} | string | Select {title} | Replaces the built-in English text, for other languages. The token {title} is the item's title. |
| select-all-labeldefault Select all items | string | Select all items | Replaces the built-in English text, for other languages. |
| reading-pane-labeldefault Reading pane | string | Reading pane | Replaces the built-in English text, for other languages. |
| previous-item-labeldefault Previous item | string | Previous item | Replaces the built-in English text, for other languages. |
| next-item-labeldefault Next item | string | Next item | Replaces the built-in English text, for other languages. |
| open-labeldefault Open | string | Open | Replaces the built-in English text, for other languages. |
| move-labeldefault Move | string | Move | Replaces the built-in English text, for other languages. |
| selected-labeldefault {count} selected | string | {count} selected | Replaces the built-in English text, for other languages. The token {count} is the number of ticked items. |
Screen reader
3 notes- The open item carries aria-current true. J and K move between items, Enter opens the focused one, X ticks it when selectable, and ? lists every shortcut.
- Each item checkbox is named Select followed by the item title, and the select-all box is named Select all items; the selected count is a polite live region.
- The list is named Items and shows aria-busy while loading; the pane is a section named Reading pane that takes focus.
Do and avoid
2 pairsMark the open list item
- J
- Next item
- K
- Previous item
- Enter
- Open the item
- ?
- Show these shortcuts
Expense claim: client travel
One item is open and marked in the list, so it is clear what the pane shows.
Expense claim: client travel
A pane with content but no open item: nothing in the list says which item it belongs to.
One line of context per item
Leave request: 3 days
Items carry a title and one line of context; the detail waits in the pane.
Leave request: 3 days
Packing the detail into the list makes every item tall and the queue slow to scan.