Class BOBInputRangeSlider<TValue>
- Namespace
- BlazOrbit.Components.Forms
- Assembly
- BlazOrbit.dll
[GenerateComponentInfo]
public class BOBInputRangeSlider<TValue> : BOBInputComponentBase<BOBNumericRange<TValue>, BOBInputRangeSlider<TValue>, BOBInputVariant>, IHasReadOnly, IHasDisabled, IHasRequired, IHasError, IVariantComponent<BOBInputVariant>, IVariantComponent, IPureBuiltComponent, IBuiltComponent, IInputFamilyComponent, IHasSize, IHasDensity, IHasShadow, IHasColor, IHasBackgroundColor, IHasFullWidth where TValue : struct, INumber<TValue>
Type Parameters
TValue
- Inheritance
-
objectComponentBaseInputBase<BOBNumericRange<TValue>>BOBInputComponentBase<BOBNumericRange<TValue>>BOBInputRangeSlider<TValue>
- Implements
- Inherited Members
Constructors
BOBInputRangeSlider()
public BOBInputRangeSlider()
Properties
AriaLabelMax
Accessible label for the upper thumb.
[Parameter]
public string? AriaLabelMax { get; set; }
Property Value
- string
AriaLabelMin
Accessible label for the lower thumb.
[Parameter]
public string? AriaLabelMin { get; set; }
Property Value
- string
BackgroundColor
Background color of the rail. Accepts any valid CSS color value, PaletteColor or BOBColor.
[Parameter]
public string? BackgroundColor { get; set; }
Property Value
- string
BuiltInTemplates
protected override IReadOnlyDictionary<BOBInputVariant, Func<BOBInputRangeSlider<TValue>, RenderFragment>> BuiltInTemplates { get; }
Property Value
- IReadOnlyDictionary<BOBInputVariant, Func<BOBInputRangeSlider<TValue>, RenderFragment>>
Color
Filled-segment and thumb color. Accepts any valid CSS color value, PaletteColor or BOBColor.
[Parameter]
public string? Color { get; set; }
Property Value
- string
Culture
Culture used to format ValueLabelFormat. Defaults to System.Globalization.CultureInfo.CurrentCulture.
[Parameter]
public CultureInfo? Culture { get; set; }
Property Value
- CultureInfo
DefaultVariant
Default variant used when no explicit variant is specified.
public override BOBInputVariant DefaultVariant { get; }
Property Value
Density
Vertical density (gap) of the slider.
[Parameter]
public BOBDensity Density { get; set; }
Property Value
FullWidth
When true, the slider spans the full width (or height in vertical) of its container.
[Parameter]
public bool FullWidth { get; set; }
Property Value
- bool
HelperText
Helper text rendered below the slider for additional context.
[Parameter]
public string? HelperText { get; set; }
Property Value
- string
Label
Floating label rendered above the slider.
[Parameter]
public string? Label { get; set; }
Property Value
- string
Max
Upper bound of the slider track. Defaults to 100.
[Parameter]
public TValue Max { get; set; }
Property Value
- TValue
Min
Lower bound of the slider track. Defaults to TValue.Zero.
[Parameter]
public TValue Min { get; set; }
Property Value
- TValue
Orientation
Layout orientation of the track.
[Parameter]
public BOBSliderOrientation Orientation { get; set; }
Property Value
Shadow
Shadow style applied to the slider container.
[Parameter]
public ShadowStyle? Shadow { get; set; }
Property Value
ShowTicks
When true, tick marks are rendered along the rail at TickInterval spacing.
[Parameter]
public bool ShowTicks { get; set; }
Property Value
- bool
ShowValueLabel
When true, a label surfaces over each thumb during drag or focus.
[Parameter]
public bool ShowValueLabel { get; set; }
Property Value
- bool
Size
Visual size of the slider.
[Parameter]
public BOBSize Size { get; set; }
Property Value
Step
Step size used by keyboard increments and value snapping.
[Parameter]
public TValue Step { get; set; }
Property Value
- TValue
TickInterval
[Parameter]
public TValue? TickInterval { get; set; }
Property Value
- TValue?
ValueLabelFormat
Format string applied to value labels and aria-valuetext. Standard or custom System.IFormattable format.
[Parameter]
public string? ValueLabelFormat { get; set; }
Property Value
- string
Methods
BuildComponentCssVariables(Dictionary<string, string>)
Contributes additional CSS custom properties to the inline style attribute. Keys
that collide with framework-owned --bob-inline-* variables will be overwritten.
public void BuildComponentCssVariables(Dictionary<string, string> cssVariables)
Parameters
cssVariablesDictionary<string, string>
BuildComponentDataAttributes(Dictionary<string, object>)
Contributes additional data- attributes to the root element. Keys that collide
with framework-owned data-bob- attributes will be overwritten.
public void BuildComponentDataAttributes(Dictionary<string, object> dataAttributes)
Parameters
dataAttributesDictionary<string, object>
BuildRenderTree(RenderTreeBuilder)
Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builderRenderTreeBuilder
DisposeAsync()
Async disposal path. Blazor invokes this first when the component is unmounted because the type implements System.IAsyncDisposable; it tears down the JS-side behavior instance via BlazOrbit.Abstractions.BOBComponentPipeline.DisposeBehaviorAsync().
public override ValueTask DisposeAsync()
Returns
- ValueTask
Remarks
Both this method and Dispose(bool) run on disposal — Blazor calls
DisposeAsync for the async work and the framework's System.IDisposable
contract still invokes Dispose(true) afterward. The split is intentional:
async work (JS interop teardown) lives here, sync work (event unsubscribe) lives in
Dispose(true). Both set IsDisposed so derived components can
guard post-await continuations regardless of which path runs first.
TryParseValueFromString(string?, out BOBNumericRange<TValue>, out string?)
Parses a string to create an instance of BlazOrbit.Components.BOBNumericRange{`0}. Derived classes can override this to change how Microsoft.AspNetCore.Components.Forms.InputBase<TValue>.CurrentValueAsString interprets incoming values.
protected override bool TryParseValueFromString(string? value, out BOBNumericRange<TValue> result, out string? validationErrorMessage)
Parameters
valuestringThe string value to be parsed.
resultBOBNumericRange<TValue>An instance of BlazOrbit.Components.BOBNumericRange{`0}.
validationErrorMessagestringIf the value could not be parsed, provides a validation error message.
Returns
- bool
True if the value could be parsed; otherwise false.