Skip to content
Razor catalogue

On this page

@addTagHelper *, Webority.Ui.Razor

Blocks

Use it for a brief, a comment or a work item that people wrote in Markdown and read back.

A work brief
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
Show code
<app-markdown value="@brief"></app-markdown>
A table
| Field | Value | Owner |
| --- | --- | --- |
| Region | EU-West | Ops |
| Limit | 500 per day | Finance |
Show code
<app-markdown value="@table"></app-markdown>
Headings as text
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
Show code
<app-markdown value="@brief" headings="Text"></app-markdown>

Safety

Pick the links setting to decide which addresses a reader can open from text someone else wrote.

Mixed input
Plain text with `inline code` and a [link to a ticket](ticket:support/3f2a).

<script>alert("not run")</script>

Quotes stay as text: > this is not a quote.

![Architecture diagram](https://example.com/diagram.png)

---

[Bad link](javascript:void) shows as text, and `code` stays code.
Show code
<app-markdown value="@mixed"></app-markdown>
In-app links only
Plain text with `inline code` and a [link to a ticket](ticket:support/3f2a).

<script>alert("not run")</script>

Quotes stay as text: > this is not a quote.

![Architecture diagram](https://example.com/diagram.png)

---

[Bad link](javascript:void) shows as text, and `code` stays code.
Show code
<app-markdown value="@mixed" links="App"></app-markdown>

Citations

A bracketed run the page accepts becomes a chip a reader can press, such as a standards clause.

Standards clauses
Clause [AS1768 4.2] sets the spacing; see [NFPA 780 4.6].

No citation chosen.

Show code
<app-markdown value="@citationText"></app-markdown>

Every option

Every value of every prop, one cell each.

value

value: Launch brief
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
value: Comment
Thanks for the report. The fix is in **build 3.25.80**.

Steps I used to confirm it:

1. Open the board
2. Move a card twice
3. The card stays put

Contact [support](mailto:support@example.com) if it returns.
value: Table
| Field | Value | Owner |
| --- | --- | --- |
| Region | EU-West | Ops |
| Limit | 500 per day | Finance |
value: Mixed
Plain text with `inline code` and a [link to a ticket](ticket:support/3f2a).

<script>alert("not run")</script>

Quotes stay as text: > this is not a quote.

![Architecture diagram](https://example.com/diagram.png)

---

[Bad link](javascript:void) shows as text, and `code` stays code.
value: Empty, which renders nothing
value: Figures
Water is H2O and the roof covers 120 m2. `H2O in code stays as written`.

resolveLink

resolveLink: React only; Razor has no route resolver, so links app opens nothing
Plain text with `inline code` and a [link to a ticket](ticket:support/3f2a).

<script>alert("not run")</script>

Quotes stay as text: > this is not a quote.

![Architecture diagram](https://example.com/diagram.png)

---

[Bad link](javascript:void) shows as text, and `code` stays code.

linkComponent

linkComponent: React only; Razor writes a plain anchor for an in-app route
Plain text with `inline code` and a [link to a ticket](ticket:support/3f2a).

<script>alert("not run")</script>

Quotes stay as text: > this is not a quote.

![Architecture diagram](https://example.com/diagram.png)

---

[Bad link](javascript:void) shows as text, and `code` stays code.

links

links="app"
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
links="web" (default)
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
links="page"
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish

headings

headings="outline" (default)
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
headings="text"
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish

isCitation

isCitation: React prop; the Citations example sets it on Razor from script
Clause [AS1768 4.2] sets the spacing; see [NFPA 780 4.6].

onOpenCitation

onOpenCitation: React prop; on Razor a chip press raises wui-markdown-citation
Clause [AS1768 4.2] sets the spacing; see [NFPA 780 4.6].

figureText

figureText: React prop; Razor draws the text as written
Water is H2O and the roof covers 120 m2. `H2O in code stays as written`.

className

class="mb-0"; React uses className
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish

base

base: none (default)
See [pricing](/pricing).
base="https://example.com"
See [pricing](/pricing).

Guidance

What to do, and what to avoid.

Use it when

  • A brief, a comment or a work-item text that people wrote in Markdown.
  • A read-only view of formatted text from the server.

Reach for something else when

  • Text a person edits. → AppRichText
  • A code sample people copy. → AppCodeBlock
  • Plain text with no formatting. → the text itself

Reference

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

Launch brief Comment Table Mixed Empty
web app page
none https://example.com
outline text
## Launch brief

Ship the **Q3 release** to *all* portals by Friday.

- Confirm the `AppMarkdown` rollout with support
- Update the [release notes](https://example.com/notes)
- Ask ops for a *read-only* window

1. Freeze the branch
2. Run the smoke tests
3. Publish
React, generated from the controls
<AppMarkdown value={source} links="web" headings="outline" resolveLink={resolveLink} />
Razor, the same props
<app-markdown value="@source" links="Web" headings="Outline"></app-markdown>

4 props. The 4 most used come first.

Used on most screens 4 props

PropTypeDefaultDescription
valuedefault tag content string tag content The Markdown source. Missing text renders nothing.
linksdefault web app | web | page web App opens no link on this surface, because Razor has no route resolver. Web also opens web, mail and phone addresses in a new tab. Page also opens an absolute address on this site in the same tab.
basedefault none string none An https origin such as https://example.com that a relative link resolves against: /pricing opens https://example.com/pricing. Any other value (a path, a query, credentials, http) is ignored.
headingsdefault outline outline | text outline Outline draws a heading as an h2 in the page outline. Text draws it as a bold line that stays out of the outline.

Screen reader

2 notes
  • Raw markup never reaches the page as elements: it shows as text, and an image shows as its alt text in brackets, so no picture is requested or announced.
  • By default a link opens only for an in-app route, a web address (in a new tab) or a mail or phone address. With links app, only the in-app route opens. Any other link shows its label as plain text.