Skip to content
Razor catalogue

On this page

@addTagHelper *, Webority.Ui.Razor

A review queue

Work through a queue one item at a time, with the open item beside the list.

Approvals
6 requestsNewest first
J K MoveEnter Open
List2 of 6

Expense claim: client travel

Pending

Dev Patel · Sales

The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.

Show code
<app-split-view current-key="@Model.OpenId">
    <app-split-header><strong>@Model.Requests.Count requests</strong></app-split-header>
    <app-split-shortcut key="a" label="Approve the open request" target="#approve"></app-split-shortcut>
    @foreach (var r in Model.Requests)
    {
        <app-split-item key="@r.Id" title="@r.Title" href="/Requests/@r.Id" pane-src="?handler=Pane&id=@r.Id">
            @r.From<app-split-trailing>@r.When</app-split-trailing>
        </app-split-item>
    }
    <app-split-pane-header><app-button variant="Ghost" size="WideSize.Sm" href="/Requests" class="d-xl-none">List</app-button></app-split-pane-header>
    <app-split-pane>@await Html.PartialAsync("_RequestPane", Model.Open)</app-split-pane>
</app-split-view>

Selection and bulk actions

Tick items to act on several at once, while the open item stays open beside them.

Tick to act on several
6 requestsNewest first
Status: Pending
J K MoveEnter Open
1 of 6

Leave request: 3 days

Pending

Asha Rao · Design

The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.

Show code
<app-split-view current-key="r1" selectable="true">
    <app-split-header>…</app-split-header>
    <app-split-chips><app-chip label="Status: Pending" size="Sm" removable="true"></app-chip></app-split-chips>
    <app-split-bulk><app-button size="WideSize.Sm" variant="Outline">Approve</app-button></app-split-bulk>
    <app-split-item key="r1" title="Leave request" pane-src="…" selected="true">…</app-split-item>
    …
</app-split-view>

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.

Where the keys listen
The keys act while focus is inside the view, or nowhere (the page body) for the first view on the page. They never fire while someone types in a field, and never with Ctrl, Cmd or Alt held. Turn them off with shortcuts-enabled="false" where a page already uses those keys, and for everything on the page with <html data-wui-shortcuts="off"> (a person's setting).
J K MoveEnter Open
2 of 6

Expense claim: client travel

Pending

Dev Patel · Sales

The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.

Show code
<app-split-view current-key="r2">
    <app-split-shortcut key="a" label="Approve the open request"></app-split-shortcut>
    @foreach (var r in Model.Requests)
    {
        <app-split-item key="@r.Id" title="@r.Title" pane-src="?handler=Pane&id=@r.Id">@r.From<app-split-trailing>@r.When</app-split-trailing></app-split-item>
    }
    <app-split-pane>…</app-split-pane>
</app-split-view>

On a phone

Below the stack breakpoint the list and the item take turns, so each screen shows one thing.

Two screens below xxl
J K MoveEnter Open
Nothing open
Choose a request from the list to read it here.
Show code
<app-split-view stack-below="Xxl" current-key="@Model.OpenId">
    <app-split-item key="r1" title="Leave request" href="/Requests/r1" pane-src="?handler=Pane&id=r1">…</app-split-item>
    <app-split-pane-header><app-button variant="Ghost" size="WideSize.Sm" href="/Requests">List</app-button></app-split-pane-header>
    <app-split-pane>…</app-split-pane>
</app-split-view>

Loading the pane

Show a placeholder in the pane while a slow request fetches the item it opens.

A placeholder while the item loads
1 of 6

Leave request: 3 days

Pending

Asha Rao · Design

The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.

Show code
public IActionResult OnGetPane(string id) => Partial("_RequestPane", _requests.Find(id));

Every option

Every value of every prop, one cell each.

items: the list

items: a review queue
J K MoveEnter Open
2 of 6

Expense claim: client travel

Pending

Dev 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
2 of 6

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 6

Expense claim: client travel

Pending

Dev 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)
Nothing here yet.
J K MoveEnter Open

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
current-key="r1"
J K MoveEnter Open
1 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
3 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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
2 selected
J K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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
2 selected
J K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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
2 selected
J K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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
6 requestsNewest first
J K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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
Status: Pending
J K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
Nothing open
Choose a request from the list to read it here.

paneHeader: above the pane

paneHeader: a status
J K MoveEnter Open
Pending2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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"
2 of 3

Expense claim: client travel

Pending

Dev 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)
Nothing here yet.
J K MoveEnter Open

Expense claim: client travel

Pending

Dev 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
All caught up
New requests show here.
J K MoveEnter Open

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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"
Loading
J K MoveEnter Open

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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"
Please wait
J K MoveEnter Open

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter View
move-label="Drag"
J K DragEnter Open
selected-label="{count} ticked"
2 ticked
J K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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 K MoveEnter Open
2 of 3

Expense claim: client travel

Pending

Dev 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

Do
J K MoveEnter Open
2 of 3

Expense claim: client travel

One item is open and marked in the list, so it is clear what the pane shows.

Avoid

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

Do
1 of 3

Leave request: 3 days

Items carry a title and one line of context; the detail waits in the pane.

Avoid
1 of 3

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.

a review queue with links titles only none
(none) r1 r2 r3
none two ticked
approve + reject none
count + sort none
one filter none
an open request nothing open
a status none
approve (A) none
default an empty state
3 4 5 6 7 8
sm md lg xl xxl
6 requestsNewest first
Status: Pending
J K MoveEnter Open
Pending2 of 6

Expense claim: client travel

Pending

Dev Patel · Sales

The request, its history and the approver's notes read here, beside the queue, so the next one is one key away.

React, generated from the controls
<AppSplitView
  items={items}
  currentKey="r2"
  onSelect={setCurrentKey}
  header={header}
  chips={chips}
  pane={pane}
  paneHeader={paneHeader}
  shortcuts={shortcuts}
/>
Razor, the same props
<app-split-view current-key="r2">
    <app-split-header>…</app-split-header>
    <app-split-chips>…</app-split-chips>
    <app-split-shortcut key="a" label="Approve the open request"></app-split-shortcut>
    <app-split-item key="r1" title="Leave request: 3 days" pane-src="?handler=Pane&id=r1">Asha Rao · Design<app-split-trailing>09:12</app-split-trailing></app-split-item>
    …
    <app-split-pane-header>…</app-split-pane-header>
    <app-split-pane>…</app-split-pane>
</app-split-view>

26 props. The 2 most used come first.

Used on most screens 2 props

PropTypeDefaultDescription
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

PropTypeDefaultDescription
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 pairs

Mark the open list item

Do
J K MoveEnter Open
2 of 3

Expense claim: client travel

One item is open and marked in the list, so it is clear what the pane shows.

Avoid

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

Do
1 of 3

Leave request: 3 days

Items carry a title and one line of context; the detail waits in the pane.

Avoid
1 of 3

Leave request: 3 days

Packing the detail into the list makes every item tall and the queue slow to scan.