New to Telerik UI for Blazor? Start a free 30-day trial

TelerikCitation<TItem>

Class

Displays an inline source chip. When sources are available, clicking or activating the citation shows a resource popover with navigation through the associated Data.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

public class TelerikCitation<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikCitation<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Constructors

TelerikCitation()

public TelerikCitation()

Controls whether the additional-source count suffix is shown in the chip label. When null (default) the suffix is shown automatically when there is more than one source. Set to false to always hide it.

[Parameter]
public bool? AdditionalCount { get; set; }

BodyTemplate

RenderFragment<CitationBodyTemplateContext<TItem>>

Customizes the body of the source popover for each item in Data. When not set, the default rendering (title, URL, description) is used.

[Parameter]
public RenderFragment<CitationBodyTemplateContext<TItem>> BodyTemplate { get; set; }

CitationSettings

RenderFragment

Provides configuration for the citation popover via CitationPopoverSettings.

[Parameter]
public RenderFragment CitationSettings { get; set; }

Data

IList<TItem>

The ordered collection of source resources associated with the citation.

[Parameter]
public IList<TItem> Data { get; set; }

DescriptionField

string

Specifies which field of the model is used as the description of the source. Default field name is "Description".

[Parameter]
public string DescriptionField { get; set; }

Icon

object

The chip icon. Defaults to the globe icon. You can use either a predefined Telerik Icon or a custom one.

[Parameter]
public object Icon { get; set; }

Label

string

The inline chip label. Defaults to the host name of the first source URL when not set.

[Parameter]
public string Label { get; set; }

OnOpen

EventCallback<CitationOpenEventArgs<TItem>>

Fires when the citation's resource popover is about to open.

[Parameter]
public EventCallback<CitationOpenEventArgs<TItem>> OnOpen { get; set; }

ShowOn

CitationShowOn

Defines the event that triggers the citation popover to show. Click (default) — opens and closes the popover on chip click. MouseEnter — opens the popover on chip hover and closes it when the pointer leaves both the chip and the popover.

[Parameter]
public CitationShowOn ShowOn { get; set; }

TitleField

string

Specifies which field of the model is used as the title of the source. Default field name is "Title".

[Parameter]
public string TitleField { get; set; }

UrlField

string

Specifies which field of the model is used as the URL of the source. Default field name is "Url".

[Parameter]
public string UrlField { get; set; }

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)