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

TelerikColorGradient

Class

A component that lets you pick a color with a gradient canvas, hue/alpha sliders, and format toggle. Supports RGB/HEX formats, optional opacity editor, size variants, ARIA labeling, keyboard focus handling, and two-way value binding.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class TelerikColorGradient : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IColorGradientSettings

Inheritance: objectComponentBaseBaseComponentTelerikColorGradient

Implements: IColorGradientSettingsIComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)...

Constructors

TelerikColorGradient()

public TelerikColorGradient()

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

Task

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Task

protected override Task OnParametersSetAsync()

Returns:

Task

Overrides: ComponentBase.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Task

public override Task SetParametersAsync(ParameterView parameters)

Parameters:parametersParameterViewReturns:

Task

Overrides: ComponentBase.SetParametersAsync(ParameterView)

Properties

AriaLabel

string

[Accessibility] Describe the aria-label attribute for the component.

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

Enabled

bool

Specifies if the ColorGradient is in an enabled or disabled state. The default value is true and the component accepts user interaction.

[Parameter]
public bool Enabled { get; set; }

Format

ColorFormat

Specifies the value format, which users see initially. Supports Rgb and Hex formats. The default value is Rgb.

[Parameter]
public ColorFormat Format { get; set; }

Implements: IColorGradientSettings.Format

FormatChanged

EventCallback<ColorFormat>

Fires when the user clicks on the toggle button, which changes the input format.

[Parameter]
public EventCallback<ColorFormat> FormatChanged { get; set; }

Formats

IEnumerable<ColorFormat>

Defines the available color formats, which the user can see or use to select a color. The default list contains Rgb and Hex formats.

[Parameter]
public IEnumerable<ColorFormat> Formats { get; set; }

Implements: IColorGradientSettings.Formats

Id

string

The HTML id attribute of the component.

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

ShowOpacityEditor

bool

Defines the visibility of the opacity slider. Default value is true. When opacity is disabled, the ColorPicker Value will not include an alpha part.

[Parameter]
public bool ShowOpacityEditor { get; set; }

Implements: IColorGradientSettings.ShowOpacityEditor

Size

string

Specifies the size of the ColorGradient.

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

TabIndex

int?

[Accessibility] Specifies the tab index of the component for keyboard navigation.

[Parameter]
public int? TabIndex { get; set; }

Value

string

Specifies the color value of the component in a valid css format - hexadecimal (ex: #fff, #ffffff, #ffffff70) and rgb (ex: rgb(0, 0, 0), rgba(0,0,0, 0.6).

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

ValueChanged

EventCallback<string>

The event fires when the value of the ColorGradient changes.

[Parameter]
public EventCallback<string> ValueChanged { get; set; }

ValueFormat

ColorFormat

Defines the color format, which the component will return in the application code. Supports Rgb and Hex formats. The default value is Rgb.

[Parameter]
public ColorFormat ValueFormat { get; set; }