mcpField
S
syncfusion-blazor-range-selectors

syncfusion-blazor-range-selectors

github.com/syncfusionDesign & UI4334 installsUpdated 1w ago
Repository

About syncfusion-blazor-range-selectors

A skill for developers implementing the Syncfusion Blazor Range Selector to select and navigate data ranges. It covers time-series filtering, interaction settings, chart integration, and export.

Key features

  1. 01Select ranges with draggable thumbs
  2. 02DateTime, numeric, and logarithmic values
  3. 03Line, area, and step-line series
  4. 04Navigate with preset period buttons
  5. 05Data binding and chart integration
  6. 06Chart export and keyboard navigation

Use cases

  1. 01Filter stock data by date
  2. 02Filter dashboard charts by range
  3. 03Add range navigation to charts

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/syncfusion/blazor-ui-components-skills --skill syncfusion-blazor-range-selectors

After installing, type/syncfusion-blazor-range-selectorsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
references/
api-reference.md
axis-customization.md
data-binding.md
export-events-accessibility.md
getting-started.md
period-selector-integration.md
range-configuration.md
series-types.md
visual-customization.md

Details

From the project README

Implementing Range Selectors

NuGet: Syncfusion.Blazor.Charts + Syncfusion.Blazor.Themes (or Syncfusion.Blazor.RangeNavigator for individual package)
Namespace: Syncfusion.Blazor.Charts

A comprehensive skill for implementing Syncfusion Blazor Range Selector (RangeNavigator) components for data range selection and chart navigation. The Range Selector enables users to select a specific range from a large data collection using draggable thumbs, providing an intuitive way to filter and navigate through time-series or numeric data.

When to Use This Skill

Use this skill immediately when you need to:

  • Enable range selection in charts with draggable thumbs
  • Filter large time-series datasets by date range
  • Navigate through financial data or stock prices
  • Create chart zoom/pan controls with visual feedback
  • Implement dashboard filtering based on data ranges
  • Add period selector buttons (1M, 3M, 6M, YTD, 1Y, All) for quick navigation
  • Display data trends with area, line, or stepline series
  • Build interactive data exploration interfaces
  • Filter data for drill-down analysis
  • Create responsive range selection controls for Blazor Server, WebAssembly, or Web App
  • Enable synchronized filtering across multiple charts
  • Implement lightweight chart navigation for performance-critical scenarios
  • Provide visual context for selected data ranges

Component Overview

The Syncfusion Blazor Range Selector (SfRangeNavigator) is a specialized control designed for data range selection and navigation. It combines:

  • Draggable Thumbs: Left and right handles for selecting range boundaries
  • Visual Series: Line, Area, or StepLine visualization of data trends
  • Period Selector: Quick preset buttons via RangeNavigatorPeriodSelectorSettings, RangeNavigatorPeriods, and RangeNavigatorPeriod
  • Value Types: Support for DateTime, Numeric, and Logarithmic data
  • Interactive Selection: Click labels or drag thumbs to update range
  • Data Binding: Local and remote data source integration
  • Customization: Extensive styling, theming, and formatting options using RangeNavigatorBorder, RangeNavigatorMargin, RangeNavigatorStyleSettings, RangeNavigatorThumbSettings, and tooltip settings

Key Capabilities:

  • Range Selection Methods: Drag thumbs, tap labels, or set programmatically
  • Series Types: Line (default), Area, StepLine
  • Value Binding: One-way and two-way binding support
  • Integration: Works with period selectors and other charts
  • Export: PNG, JPEG, SVG, PDF export functionality
  • Accessibility: WCAG compliant with keyboard navigation

Documentation and Navigation Guide

Getting Started

📄 Read: references/getting-started.md

Start here for installation, setup, and your first range selector. Covers:

  • Installing Syncfusion.Blazor.RangeNavigator NuGet package
  • Blazor Server, WebAssembly, and Web App setup
  • Service registration and theme configuration
  • Basic SfRangeNavigator implementation with sample data
  • Project structure and script references
  • Troubleshooting common setup issues
Core Configuration
Range Selection and Values

📄 Read: references/range-configuration.md

Configure range selection behavior and value binding:

  • Value property for start and end values
  • One-way and two-way binding patterns
  • Value types (DateTime, Numeric, Logarithmic)
  • Thumb dragging for range selection
  • Label tapping for quick selection
  • Programmatic range updates and validation
Series Types

📄 Read: references/series-types.md

Choose and customize series visualization:

  • Line series for trend lines
  • Area series for filled regions
  • StepLine series for discrete data
  • Series customization (colors, width, fill)
  • Multiple series support
Data and Integration
Data Binding

📄 Read: references/data-binding.md

Configure data sources for the range selector:

  • Local data sources (List, Array, ExpandoObject)
  • Remote data binding with SfDataManager
  • DateTime data handling and formatting
  • Numeric and logarithmic scale data
  • Data refresh and dynamic updates
Period Selector Integration

📄 Read: references/period-selector-integration.md

Add period selector buttons for quick navigation:

  • Predefined period buttons (1M, 3M, 6M, YTD, 1Y, All)
  • Custom period configuration
  • Integration with range changes
  • Event handling for period selection
  • Styling and positioning
Customization and Styling
Axis Customization

📄 Read: references/axis-customization.md

Customize axis, grid, and labels:

  • Grid line configuration (major and minor)
  • Tick customization (size, color, position)
  • Label formatting and rotation
  • Interval types (Years, Months, Days, Hours, Minutes)
  • Logarithmic axis support
  • RTL (Right-to-Left) support
Visual Customization

📄 Read: references/visual-customization.md

Control appearance, themes, and layout:

  • Chart dimensions (Width, Height, Margin)
  • Theme selection (Material, Bootstrap, Fluent, Tailwind, Fabric, Highcontrast)
  • Tooltip configuration and templates
  • Lightweight rendering mode for performance
  • Custom styling and color schemes
  • Responsive design patterns
Advanced Features
Export, Events, and Accessibility

📄 Read: references/export-events-accessibility.md

Handle exports, events, and ensure accessibility:

  • Export: PNG, JPEG, SVG, PDF export functionality
  • Events: Changed, Loaded, TooltipRender event handling
  • Accessibility: WCAG compliance, keyboard navigation, screen readers, high contrast themes
  • ARIA attributes and testing checklist

Quick Start Example

Here's a minimal range selector for time-series data filtering with event handling:

@using Syncfusion.Blazor.Charts

@{
    DateTime[] range = SelectedRange as DateTime[] ?? new DateTime[] { DateTime.Now, DateTime.Now };
}
<h3>Stock Price Range Selector</h3>
<p>Selected Range: @range[0].ToShortDateString() to @range[1].ToShortDateString()</p>

<SfRangeNavigator @bind-Value="@SelectedRange" 
                  ValueType="RangeValueType.DateTime"
                  LabelFormat="MMM-yy"
                  IntervalType="RangeIntervalType.Months">
        <RangeNavigatorEvents Changed="OnRangeChanged"></RangeNavigatorEvents>
    <RangeNavigatorRangeTooltipSettings Enable="true"></RangeNavigatorRangeTooltipSettings>
    <RangeNavigatorSeriesCollection>
        <RangeNavigatorSeries DataSource="@StockData" 
                              XName="Date" 
                              YName="Close" 
                              Type="RangeNavigatorType.Area"
                              Fill="#3F51B5">
        </RangeNavigatorSeries>
    </RangeNavigatorSeriesCollection>
</SfRangeNavigator>

@code {
    public class StockInfo
    {
        public DateTime Date { get; set; }
        public double Close { get; set; }
    }
    
    public object SelectedRange = new DateTime[] 
    { 
        new DateTime(2020, 01, 01), 
        new DateTime(2021, 01, 01) 
    };
    
    public List<StockInfo> StockData = new List<StockInfo>
    {
        new StockInfo { Date = new DateTime(2018, 01, 01), Close = 35 },
        new StockInfo { Date = new DateTime(2019, 01, 01), Close = 42 },
        new StockInfo { Date = new DateTime(2020, 01, 01), Close = 48 },
        new StockInfo { Date = new DateTime(2021, 01, 01), Close = 56 },
        new StockInfo { Date = new DateTime(2022, 01, 01), Close = 62 }
    };
    
    private void OnRangeChanged(ChangedEventArgs args)
    {
        // Handle range change event
        Console.WriteLine($"Range changed: {args.Start} to {args.End}");
    }
}

What this creates:

  • Area chart showing stock price trend with blue fill (#3F51B5)
  • Draggable thumbs for range selection
  • Initially selected range: Jan 2020 to Jan 2021
  • Month labels with "MMM-yy" format
  • Tooltip showing values on hover
  • Event handler responding to range changes
  • Two-way binding with @bind-Value directive

Common Use Cases

1. Stock Price Filtering with Period Selector

Filter stock data with quick period buttons:

@using Syncfusion.Blazor.Charts

<SfRangeNavigator @bind-Value="@SelectedRange" 
                  ValueType="RangeValueType.DateTime"
                  IntervalType="RangeIntervalType.Months"
                  LabelFormat="MMM yy">
    <RangeNavigatorRangeTooltipSettings Enable="true" DisplayMode="TooltipDisplayMode.Always">
    </RangeNavigatorRangeTooltipSettings>
    <RangeNavigatorPeriodSelectorSettings>
        <RangeNavigatorPeriods>
            <RangeNavigatorPeriod Text="1M" Interval="1" IntervalType="RangeIntervalType.Months"></RangeNavigatorPeriod>
            <RangeNavigatorPeriod Text="3M" Interval="3" IntervalType="RangeIntervalType.Months"></RangeNavigatorPeriod>
            <RangeNavigatorPeriod Text="6M" Interval="6" IntervalType="RangeIntervalType.Months"></RangeNavigatorPeriod>
            <RangeNavigatorPeriod Text="YTD"></RangeNavigatorPeriod>
            <RangeNavigatorPeriod Text="1Y" Interval="1" IntervalType="RangeIntervalType.Years"></RangeNavigatorPeriod>
            <RangeNavigatorPeriod Text="All"></RangeNavigatorPeriod>
        </RangeNavigatorPeriods>
    </RangeNavigatorPeriodSelectorSettings>
    <RangeNavigatorSeriesCollection>
        <RangeNavigatorSeries DataSource="@StockData" XName="Date" YName="Close" Type="RangeNavigatorType.Area">
        </RangeNavigatorSeries>
    </RangeNavigatorSeriesCollection>
</SfRangeNavigator>

@{
    DateTime[] range = SelectedRange as DateTime[] ?? new DateTime[] { DateTime.Now, DateTime.Now };
}
<p>Selected Range: @range[0].ToShortDateString() to @range[1].ToShortDateString()</p>

@code {
    public object SelectedRange = new DateTime[] 
    { 
        new DateTime(2022, 01, 01), 
        new DateTime(2023, 01, 01) 
    };
    
    public List<StockInfo> StockData = GetStockData();
    
    private static List<StockInfo> GetStockData()
    {
        // Sample data generation
        var data = new List<StockInfo>();
        var startDate = new DateTime(2020, 01, 01);
        var random = new Random();
        
        for (int i = 0; i < 100; i++)
        {
            data.Add(new StockInfo 
            { 
                Date = startDate.AddDays(i * 10), 
                Close = 100 + random.Next(-20, 20) 
            });
        }
        
        return data;
    }

    public class StockInfo
    {
        public DateTime Date { get; set; }
        public double Close { get; set; }
    }
}
2. Dashboard with Range-Based Filtering

Synchronize chart data with range selector:

@using Syncfusion.Blazor.Charts

<div class="dashboard-container">
    <h3>Sales Dashboard</h3>
    <SfRangeNavigator Value="@SelectedRange"
                      ValueType="RangeValueType.DateTime"
                      Height="140px">

        <RangeNavigatorEvents Changed="OnRangeChanged" />

        <RangeNavigatorSeriesCollection>
            <RangeNavigatorSeries DataSource="@SalesDetails"
                                  XName="Date"
                                  YName="Revenue"
                                  Type="RangeNavigatorType.Area" />
        </RangeNavigatorSeriesCollection>

    </SfRangeNavigator>
    <SfChart Height="300px">
        <ChartPrimaryXAxis ValueType="Syncfusion.Blazor.Charts.ValueType.DateTime"
                           Minimum="@SelectedRange[0]"
                           Maximum="@SelectedRange[1]" />

        <ChartSeriesCollection>
            <ChartSeries DataSource="@FilteredData"
                         XName="Date"
                         YName="Revenue"
                         Type="ChartSeriesType.Column" />
        </ChartSeriesCollection>
    </SfChart>
</div>

@code {
    public DateTime[] SelectedRange =
    {
        new DateTime(2023, 01, 01),
        new DateTime(2023, 06, 30)
    };

    public List<SalesData> SalesDetails = new();
    public List<SalesData> FilteredData = new();

    protected override void OnInitialized()
    {
        SalesDetails = GetSalesData();
        ApplyFilter();
    }

    private void OnRangeChanged(ChangedEventArgs args)
    {
        if (args.Start is DateTime start && args.End is DateTime end)
        {
            SelectedRange = new[] { start, end };
            ApplyFilter();
        }
    }

    private void ApplyFilter()
    {
        FilteredData = SalesDetails
            .Where(d => d.Date >= SelectedRange[0] && d.Date <= SelectedRange[1])
            .ToList();
    }

    private List<SalesData> GetSalesData()
    {
        var data = new List<SalesData>();
        var random = new Random();
        var start = new DateTime(2023, 01, 01);
        decimal revenue = 15000;

        for (int i = 0; i < 180; i++)
        {
            revenue += random.Next(-1500, 2000);

            data.Add(new SalesData
            {
                Date = start.AddDays(i),
                Revenue = Math.Max(revenue, 5000)
            });
        }

        return data;
    }

    public class SalesData
    {
        public DateTime Date { get; set; }
        public decimal Revenue { get; set; }
    }
}
3. Lightweight Mode for Performance

Optimize for large datasets:

@using Syncfusion.Blazor.Charts

<SfRangeNavigator Value="@SelectedRange" 
                  ValueType="RangeValueType.DateTime"
                  EnableGrouping="true"
                  GroupBy="RangeIntervalType.Months"
                  AllowSnapping="true">
    <RangeNavigatorRangeTooltipSettings Enable="true"></RangeNavigatorRangeTooltipSettings>
    <RangeNavigatorSeriesCollection>
        <RangeNavigatorSeries DataSource="@LargeDataset" 
                              XName="Timestamp" 
                              YName="Value"
                              Type="RangeNavigatorType.Line">
        </RangeNavigatorSeries>
    </RangeNavigatorSeriesCollection>
</SfRangeNavigator>

@code {
    public DateTime[] SelectedRange;
    public List<DataPoint> LargeDataset = GenerateLargeDataset(10000);

    public class DataPoint
    {
        public DateTime Timestamp { get; set; }
        public double Value { get; set; }
    }
    
    private static List<DataPoint> GenerateLargeDataset(int count)
    {
        // Generate large dataset efficiently
        return Enumerable.Range(0, count)
            .Select(i => new DataPoint 
            { 
                Timestamp = DateTime.Now.AddHours(-count + i), 
                Value = Math.Sin(i * 0.1) * 100 
            })
            .ToList();
    }
}

Key Properties Reference

Essential Properties
PropertyTypeDescriptionDefault
ValueDateTime[] / double[]Selected range [start, end]null
ValueTypeRangeValueTypeData type (DateTime, Double, Logarithmic)Double
DataSourceobjectData collection for seriesnull
IntervalTypeRangeIntervalTypeAxis interval (Auto, Years, Months, Days, etc.)Auto
LabelFormatstringLabel display formatnull
WidthstringComponent width"100%"
HeightstringComponent height"80px"
ThemeThemeVisual theme (Material, Bootstrap5, Fluent, Tailwind, Fabric, HighContrast)Material
IntervalintAxis interval value1
LogBasedoubleBase for logarithmic axis10
OrientationOrientationHorizontal or VerticalHorizontal
Series Configuration
PropertyTypeDescriptionDefault
TypeRangeNavigatorTypeSeries type (Line, Area, StepLine)Line
XNamestringX-axis data field namenull
YNamestringY-axis data field namenull
FillstringSeries fill colornull
WidthdoubleSeries line width1
OpacitydoubleSeries opacity (0-1)1
NamestringSeries name/labelnull
Visual Properties
PropertyTypeDescriptionDefault
EnableGroupingboolEnable data groupingfalse
AllowSnappingboolSnap thumbs to data pointsfalse
EnableRtlboolRight-to-Left supportfalse
TabIndexintTab index for keyboard navigation0
Period Selector
PropertyTypeDescription
RangeNavigatorPeriodSelectorSettingsComponentPeriod selector configuration (Enabled, Height, Position)
RangeNavigatorPeriodsCollectionPeriod button collection container
RangeNavigatorPeriodItemIndividual period selector button (Text, Interval, IntervalType, Selected)
Tooltip Configuration
PropertyTypeDescriptionDefault
RangeNavigatorRangeTooltipSettings.EnableboolEnable/disable tooltiptrue
RangeNavigatorRangeTooltipSettings.DisplayModeTooltipDisplayModeDisplay mode (OnDemand, Always)OnDemand
RangeNavigatorRangeTooltipSettings.FormatstringTooltip content format templatenull
Axis Customization
PropertyTypeDescription
RangeNavigatorMarginComponentMargin (Left, Right, Top, Bottom)
RangeNavigatorBorderComponentBorder (Color, Width, DashArray)
RangeNavigatorMajorGridLinesComponentGridlines (Width, Color, DashArray)
RangeNavigatorMajorTickLinesComponentTick lines (Width, Color, Height)
RangeNavigatorLabelStyleComponentLabel styling (Color, FontFamily, Size, FontWeight)
Thumb Configuration
PropertyTypeDescriptionDefault
RangeNavigatorThumbSettings.TypeThumbTypeThumb shape (Circle, Rectangle)Circle
RangeNavigatorThumbSettings.FillstringThumb fill color"#f3f3f3"
RangeNavigatorThumbSettings.SizedoubleThumb size in pixels15

Events Reference

Key events for handling Range Navigator interactions:

EventEvent ArgsDescription
ChangedChangedEventArgsFires when range selection changes (start, end, value)
LoadedRangeLoadedEventArgsFires after component loads completely
ResizingRangeResizeEventArgsFires while dragging thumbs
ResizedRangeResizeEventArgsFires after thumb drag completes
RenderingRangeSelectorRenderEventArgsFires before selector renders
TooltipRenderRangeTooltipRenderEventArgsFires before tooltip renders
LabelRenderRangeLabelRenderEventArgsFires when labels render

Example Event Handler:

private void OnRangeChanged(ChangedEventArgs args)
{
    var startValue = args.Start;  // DateTime or double
    var endValue = args.End;      // DateTime or double
    var selectedData = args.SelectedData;  // Filtered data
    StateHasChanged();
}

Methods Reference

Key methods for programmatic control:

MethodReturn TypeDescription
ExportAsync(ExportType, string)TaskExport as PNG, JPEG, SVG, or PDF
Print()TaskPrint the Range Navigator
Refresh()TaskRefresh/redraw component
GetVisibleRangeModel()VisibleRangeModelGet current visible range

Implementation Workflow

When implementing a range selector, follow this sequence:

  1. Start with Getting Started for installation and basic setup
  2. Configure range values from Range Configuration for selection behavior
  3. Choose series type using Series Types for visualization
  4. Set up data binding from Data Binding for your data structure — when using remote data prefer trusted/internal APIs or mocked data; see Data Binding - Security Considerations
  5. Add period selector (optional) with Period Selector Integration
  6. Customize axis with Axis Customization for proper labeling
  7. Apply visual styling from Visual Customization
  8. Add export and events using Export, Events, and Accessibility
  9. Review API Reference for complete API documentation with all classes, properties, and enums

For questions or issues, refer to the troubleshooting sections in each reference file or consult Export, Events, and Accessibility for event handling patterns and accessibility requirements.

Comments

Markdown supported