Skip to content
Razor catalogue

On this page

@addTagHelper *, Webority.Ui.Razor

Basic facts

Use a grid of labelled facts for one record, such as contact details or an invoice's totals.

Contact details
Contact details
Name
Alice Chen
Email
alice@example.com
Status
Active
Show code
<app-descriptions title="Contact details">
    <app-description label="Name">Alice Chen</app-description>
    <app-description label="Email">alice@example.com</app-description>
    <app-description label="Status">Active</app-description>
</app-descriptions>

Columns and spans

Set the columns for the screen width, and let a long value span more of them.

Two and three columns
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA
columns=2
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA
columns=3
Show code
<app-descriptions columns="2">…</app-descriptions>
<app-descriptions columns="3">…</app-descriptions>
Items that span
Title
React Best Practices
Author
Alice Chen
Status
Published
Summary
A comprehensive guide to React patterns and best practices for modern web applications.
Show code
<app-descriptions columns="2">
    <app-description label="Title" span="2">React Best Practices</app-description>
    <app-description label="Author">Alice Chen</app-description>
    <app-description label="Status">Published</app-description>
    <app-description label="Summary" span="2">A comprehensive guide to React patterns and best practices for modern web applications.</app-description>
</app-descriptions>

Sizes and styles

Choose a small size for a dense panel, and a bordered or list layout where rows need a clear edge.

Small size
Full Name
Alice Chen
Email
alice@example.com
Show code
<app-descriptions size="Sm">
    <app-description label="Full Name">Alice Chen</app-description>
    <app-description label="Email">alice@example.com</app-description>
</app-descriptions>
Bordered rows
Full Name
Alice Chen
Email
alice@example.com
Show code
<app-descriptions bordered="true">
    <app-description label="Full Name">Alice Chen</app-description>
    <app-description label="Email">alice@example.com</app-description>
</app-descriptions>
List layout
Site
Pune, MH
Show code
<app-descriptions layout="List">
    <app-description label="Email" icon="mail" href="mailto:alice@example.com">alice@example.com</app-description>
    <app-description label="Site" icon="map-pin">Pune, MH</app-description>
</app-descriptions>

Summary and empty values

Use the summary layout for a label beside its value, and mark an empty value so it reads as blank.

Summary layout
Subtotal
$1,200.00
Tax
$96.00
Total
$1,296.00
Show code
<app-descriptions layout="Summary">
    <app-description label="Subtotal">$1,200.00</app-description>
    <app-description label="Tax">$96.00</app-description>
    <app-description label="Total" emphasis="true">$1,296.00</app-description>
</app-descriptions>
Empty values
Name
Alice
Middle Name
-
Suffix
-
Show code
<app-descriptions>
    <app-description label="Name">Alice</app-description>
    <app-description label="Middle Name"></app-description>
    <app-description label="Suffix"></app-description>
</app-descriptions>

Titles and cards

Add a heading above a group of facts, or place the list inside a card on a detail page.

With a title
Contact Information
Full Name
Alice Chen
Email
alice@example.com
Show code
<app-descriptions title="Contact Information">
    <app-description label="Full Name">Alice Chen</app-description>
    <app-description label="Email">alice@example.com</app-description>
</app-descriptions>
Inside a card
User Profile
Full Name
Alice Chen
Email
alice@example.com
Show code
<app-card title="User Profile">
    <app-descriptions>
        <app-description label="Full Name">Alice Chen</app-description>
        <app-description label="Email">alice@example.com</app-description>
    </app-descriptions>
</app-card>

Multiline values

Keep the line breaks in a value that is a note or an address, and leave other values on one line.

Line breaks kept
Address
12 MG Road Pune, MH 411001
Status
Active
Show code
<app-descriptions>
    <app-description label="Address" multiline="true">12 MG Road
Pune, MH 411001</app-description>
    <app-description label="Status">Active</app-description>
</app-descriptions>

Every option

Every value of every prop, one cell each.

columns: 1, 2, 3, 4

columns="1"
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA
(default) columns="2"
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA
columns="3"
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA
columns="4"
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA

size: md, sm

(default) size="md"
Full Name
Alice Chen
Email
alice@example.com
size="sm"
Full Name
Alice Chen
Email
alice@example.com

bordered

(default) bordered="false"
Full Name
Alice Chen
Email
alice@example.com
bordered="true"
Full Name
Alice Chen
Email
alice@example.com

layout: grid, summary, list

(default) layout="grid"
Full Name
Alice Chen
Email
alice@example.com
layout="summary"
Full Name
Alice Chen
Email
alice@example.com
layout="list"
Full Name
Alice Chen
Email
alice@example.com

title: present vs absent

(default) no title
Full Name
Alice Chen
Email
alice@example.com
title="Contact Information"
Contact Information
Full Name
Alice Chen
Email
alice@example.com

items: label

label (required)
Full Name
Alice Chen

items: key

key="email" (React only)
Email
alice@example.com

items: span, at every columns count

(default) span="1"
Title
React Best Practices
Author
Alice Chen
columns="2", span="2"
Title
React Best Practices
Author
Alice Chen
Status
Published
columns="3", span="2"
Title
React Best Practices
Author
Alice Chen
Status
Published
columns="3", span="3" (full-width row)
Summary
A comprehensive guide to React patterns and best practices for modern web applications.
Author
Alice Chen
Status
Published

items: emphasis, the total row

(default) no emphasis
Subtotal
$1,200.00
Total
$1,200.00
emphasis="true"
Subtotal
$1,200.00
Total
$1,200.00

items: multiline

(default) multiline="false"
Address
12 MG Road Pune, MH 411001
multiline="true"
Address
12 MG Road Pune, MH 411001

items: icon and href

(default) no icon or href
Email
alice@example.com
icon="mail"
Email
alice@example.com
href="mailto:alice@example.com"

items: populated and empty values

populated
Name
Alice
value null, shown as a dash
Middle Name
-
value empty, shown as a dash
Suffix
-

items: long values

a long unbroken value wraps inside its cell, span="1"
Notes
Averylongsinglewordvaluewithoutspacesorhyphensthatmustwrapinsteadofoverflowingitscell1234567890
Status
Active
a long sentence value at span="2" for extra width
Summary
A comprehensive guide to React patterns and best practices for modern web applications, covering hooks, performance, testing, and accessibility in real production codebases.

linkComponent

linkComponent="a" (React only)

className

class: extra classes on the grid (React: className), no visible change
Full Name
Alice Chen
Email
alice@example.com

Guidance

What to do, and what to avoid.

Use it when

  • You are displaying many attributes of a single record.
  • Some values are longer (spanning multiple grid columns helps).
  • The panel is read-only: a detail view, a drawer, a profile sidebar.
  • You want a clean tabular layout that reflows on mobile.

Reach for something else when

  • The values are editable. → Form fields (AppInput, AppSelect, …)
  • It is one headline number. → AppKpiTile
  • You are listing many records. → AppDataTable

Name each value

Do
Email
alice@example.com
Status
Active

Specific, concise labels (no generic "Info") and clear values.

Avoid
Data 1
alice@example.com
Data 2
…

Generic labels like "Data 1" and ellipsis placeholders carry no meaning.

Reference

Try every prop, read the full list, and check keyboard and screen reader behaviour.

1 2 3 4
md sm
grid summary list
Full Name
Alice Chen
Email
alice@example.com
Phone
+1 555-0123
Location
San Francisco, CA
React, generated from the controls
<AppDescriptions items={items} />
Razor, the same props
<app-descriptions>
    <app-description label="Full Name">Alice Chen</app-description>
    <app-description label="Email">alice@example.com</app-description>
    <app-description label="Phone">+1 555-0123</app-description>
    <app-description label="Location">San Francisco, CA</app-description>
</app-descriptions>

8 props. The 4 most used come first.

Used on most screens 4 props

PropTypeDefaultDescription
columnsdefault 2 1 | 2 | 3 | 4 2 How many columns the grid should have, before the media-breakpoint collapse.
sizedefault md sm | md md Item padding and font size.
bordereddefault false bool false Draws a rule between rows, across every column.
layoutdefault grid grid | summary | list grid summary puts each label left of its value, with tabular figures. list is one column of rows with a rule between them, a flush first and last row and a single-line value.

Less common 4 props

PropTypeDefaultDescription
titledefault - string - Optional heading above the grid.
labeldefault - string - The column label (required).
spandefault 1 1 | 2 | 3 1 How many columns this item spans.
emphasisdefault false bool false The total row: bold, with a rule above it.

Screen reader

2 notes
  • Renders a description list: each label is a dt and its value the dd of the same item.
  • An empty value renders a muted placeholder rather than a blank cell.

Do and avoid

1 pairs

Name each value

Do
Email
alice@example.com
Status
Active

Specific, concise labels (no generic "Info") and clear values.

Avoid
Data 1
alice@example.com
Data 2
…

Generic labels like "Data 1" and ellipsis placeholders carry no meaning.