Skip to content
BlazorUI

AI

AiCitationMarker

Bit.BlazorUI.AI

BitAiCitationMarker is the small numbered chip that appears inline where a claim is attributed to a source. It is a button rather than a link, because activating it reveals the source in place instead of navigating away; its native tooltip previews the title of the source and the passage the claim rests on, and its accessible name carries the number and the title. It is sized in em of the text around it, so it follows the claim it attributes - in a heading as in a footnote. BitAiMarkdownView, BitAiStreamingMarkdown and the text parts of a message draw one for every [n] that resolves to a citation.

Notes

To use this component, you need to install the Bit.BlazorUI.AI(opens in a new tab) nuget package, as described in the Optional steps of the Getting started page.

A marker draws a BitAiCitation - a claim attributed to a BitAiCitationSource. Its transport streams them as BitAiCitationEvents, which the session collects in BitAiMessage.Citations and numbers in document order when the message is finalised; citations an application builds itself carry the Number it gives them. The accessible name of a marker is BitAiStrings.CitationLabel ("Source 1: title"), so nothing its preview says is lost to a screen reader. BitAiUiOptions.InlineCitations turns the markers of the Markdown views off (the [n] stays text). See it in a chat in the Citations scenario.

Usage

Every example is live. Open its code to see exactly what produced the component running underneath.

Basic

Hand the marker a Citation: it shows the citation's Number right where the claim is made, and takes the size of the text around it.

Interactive Server keeps component state on the server and streams UI diffs over a SignalR circuit. If that circuit drops, the state goes with it unless you have persisted it yourself.

Preview

Point at a marker: its tooltip is the title of the source and - when the citation carries one - the Quote the claim rests on, cut short at 220 characters. A screen reader reads the accessible name instead, "Source 3: Prerendering", which an AriaLabel replaces.

Prerendering runs the component twice, once on the server and once in the browser.

Activation

OnActivate hands over the citation of a marker that is clicked or activated with the keyboard - the place to reveal the source in place, here as a BitAiSourceCard with the quoted passage. A Disabled marker hands over nothing.

Interactive Server keeps component state on the server and loses it with the circuit, and prerendering runs it twice.

In Markdown

The Markdown views turn every bracketed number of the text - [1] - into a marker of the citation of that number, as the text streams in; one that matches no citation stays the text it was. OnCitationClick is their OnActivate, and a BitAiSourceList under the answer lists the sources under the same numbers.



Anchored in a message

A citation streamed with a StartIndex and an EndIndex is anchored to the span of text it supports, and the text part of the message places its marker at the end of that span - no [n] in the text needed. Here a scripted transport of this site streams an answer with two anchored citations, and the message draws the markers and its source list.



Cascading parameters

BitParams with a BitAiCitationMarkerParams sets the look of every marker inside it - the ones the Markdown views draw included - and a marker's own value still wins (the last keeps its own Styles).

State lives on the server, goes with the circuit, and is rendered twice.

Style & Class

Style and Class reach the button, and so do Styles and Classes - the marker is one element, so their Root is all they hold. The public --bit-AiCitationMarker-* variables re-skin the markers from :root, an ancestor or Style - at rest and under the pointer.

A styled marker, a classy one, one with Styles and one with Classes.

Restyled by the variables of their container.

RTL

In right-to-left text the marker sits at the end of the claim in its reading direction, whether the direction comes from Dir or from a dir attribute around it.

حالت تعاملی سرور، وضعیت کامپوننت را روی سرور نگه می‌دارد و با قطع شدن اتصال آن را از دست می‌دهد.

CSS variables

The public custom properties this component reads off its root, for what no parameter covers.

Every variable is read with a fallback and never declared by the component, so it inherits like any other custom property: set one on :root (or in a [bit-theme] block) to restyle every instance, on any ancestor to restyle the ones inside it, or on the Style of one instance to restyle it - and any instance nested inside it, which inherits the value too; a parameter changes one alone, as does the real CSS property on the instance's Style / Styles when that property does not inherit (opacity: 1 keeps one disabled instance undimmed without undimming a disabled one inside it), while an inherited one such as color or font-family also reaches the nested instances that do not set it themselves. Leave a variable unset and the component falls back to the theme token beside it.

BitAiCitationMarker CSS variables

Name Default value Description
--bit-AiCitationMarker-color var(--bit-clr-pri-fg) The number at rest.
--bit-AiCitationMarker-background var(--bit-clr-pri-tint) The chip at rest.
--bit-AiCitationMarker-hover-color var(--bit-clr-pri-text) The number under the pointer.
--bit-AiCitationMarker-hover-background var(--bit-clr-pri) The chip under the pointer.
--bit-AiCitationMarker-radius var(--bit-shp-radius-xs) Corner of the chip.

API

Every parameter, public member, sub-class and enum this component exposes.

BitAiCitationMarker parameters

Name Type Default value Description
Citation BitAiCitation The citation this marker points at (required). The marker shows its Number, previews the title of its source and its Quote in the native tooltip, and is named after both for assistive technologies.
Classes BitAiCitationMarkerClassStyles? null Custom CSS classes for different parts of the citation marker.
OnActivate EventCallback<BitAiCitation> The callback for when the user activates the marker (a click, or Enter / Space while it has the focus), with its citation - the place to reveal the source in place. A disabled marker raises nothing.
Styles BitAiCitationMarkerClassStyles? null Custom CSS styles for different parts of the citation marker.

BitComponentBase parameters

Name Type Default value Description
AriaLabel string? null Gets or sets the accessible label for the component, used by assistive technologies.
Class string? null Gets or sets the CSS class name(s) to apply to the rendered element.
Dir BitDir? null Gets or sets the text directionality for the component's content.
Disabled bool false Gets or sets a value indicating whether the component is disabled and cannot respond to user interaction.
ForceAnimation bool false Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. An attribute written on the component wins over an entry of the same name.
Id string? null Gets or sets the unique identifier for the component's root element.
Style string? null Gets or sets the CSS style string to apply to the rendered element.
TabIndex string? null Gets or sets the tab order index for the component when navigating with the keyboard.
Visibility BitVisibility BitVisibility.Visible Gets or sets the visibility state (visible, hidden, or collapsed) of the component.

BitComponentBase public members

Name Type Default value Description
UniqueId Guid Guid.NewGuid() Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed.
RootElement ElementReference Gets the reference to the root HTML element associated with this component.

BitAiCitationMarkerClassStyles properties

Name Type Default value Description
Root string? null Custom CSS classes/styles for the root element (the button) of the BitAiCitationMarker.

BitAiCitation properties

A claim of a response attributed to a BitAiCitationSource: new BitAiCitation(citationId, source). A transport streams one as a BitAiCitationEvent; the message collects them in BitAiMessage.Citations. A sealed record.

Name Type Default value Description
CitationId string The identifier of the citation, unique within its message.
Source BitAiCitationSource The source being cited. Several citations of one source (the same SourceId) share one entry of the source list.
PartId string? null The identifier of the part the span refers to, when the citation is anchored.
StartIndex int? null The start of the cited span of the text of the part, in UTF-16 code units. With EndIndex, it is what lets the text of a message place the marker at exactly the right position; during streaming a citation whose span runs past the text received so far is held back until the text catches up.
EndIndex int? null The end of the cited span, exclusive, in UTF-16 code units.
Quote string? null The exact text quoted from the source, shown in the preview of the marker (cut short at 220 characters).
Locator string? null A page number, a section or another location within the source.
Number int? null The one-based number of the marker - what the marker shows, what an [n] of the Markdown resolves against and what the source list numbers the source with. A session assigns it when the message is finalised, in document order whatever the order the events arrived in; set it yourself on citations you build.
IsAnchored bool false Whether the citation addresses a span of text: both StartIndex and EndIndex are set, and EndIndex is past StartIndex.

BitVisibility enum

Name Value Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).

BitDir enum

Name Value Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

Found a mistake, a gap, or something that could be clearer? Every page and every component is one click from its source.