Skip to content

Commit 4cd185f

Browse files
IvanDanchevIvanDanchev
authored
docs: remove obsolete event (#3341)
1 parent fcf2c8a commit 4cd185f

File tree

4 files changed

+83
-172
lines changed

4 files changed

+83
-172
lines changed

‎components/filter/events.md‎

Lines changed: 0 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ position: 11
1313
This article explains the available events for the Telerik Filter for Blazor:
1414

1515
* [OnUpdate](#onupdate)
16-
* [ValueChanged](#valuechanged)
1716

1817
## OnUpdate
1918

@@ -66,95 +65,6 @@ The `OnUpdate` event fires when the user changes the Filter `Value`. The compone
6665
}
6766
````
6867

69-
## ValueChanged
70-
71-
The `ValueChanged` event fires when the value has changed. Its event handler receives the updated `CompositeFilterDescriptor` as an argument.
72-
73-
> The `ValueChanged` event is deprecated and will be removed in future versions. Use the `OnUpdate` event instead.
74-
75-
>caption Handle ValueChanged
76-
77-
````RAZOR
78-
@* This code snippet showcases an example of how to handle the ValueChanged event. *@
79-
80-
@using Telerik.DataSource
81-
82-
<TelerikFilter Value="@Value" ValueChanged="@OnValueChanged">
83-
<FilterFields>
84-
<FilterField Name="@(nameof(Person.EmployeeId))" Type="@(typeof(int))" Label="Id"></FilterField>
85-
<FilterField Name="@(nameof(Person.Name))" Type="@(typeof(string))" Label="First Name"></FilterField>
86-
<FilterField Name="@(nameof(Person.AgeInYears))" Type="@(typeof(int))" Label="Age"></FilterField>
87-
<FilterField Name="@(nameof(Person.IsOutOfOffice))" Type="@(typeof(bool))" Label="Out Of Office"></FilterField>
88-
<FilterField Name="@(nameof(Person.HireDate))" Type="@(typeof(DateTime))" Label="Hire Date"></FilterField>
89-
</FilterFields>
90-
</TelerikFilter>
91-
92-
<div>
93-
<strong>ValueChanged triggered count: </strong> @TriggeredValueChangedCount
94-
95-
<div class="log-container">
96-
List of applied filters:
97-
@compositeFilterDescriptorFragment(Value)
98-
</div>
99-
</div>
100-
101-
@code {
102-
public CompositeFilterDescriptor Value { get; set; } = new CompositeFilterDescriptor();
103-
public int TriggeredValueChangedCount { get; set; }
104-
105-
private void OnValueChanged(CompositeFilterDescriptor filter)
106-
{
107-
Value = filter;
108-
TriggeredValueChangedCount++;
109-
}
110-
111-
static RenderFragment<CompositeFilterDescriptor> compositeFilterDescriptorFragment = (cfd) =>
112-
@<text>
113-
@{
114-
<div>CompositeFilterDescriptor info: Logical Operator: @cfd.LogicalOperator</div>
115-
116-
FilterDescriptor currentFilterDescriptor;
117-
CompositeFilterDescriptor currentCompositeDescriptor;
118-
119-
@foreach (var item in cfd.FilterDescriptors)
120-
{
121-
if (item is CompositeFilterDescriptor)
122-
{
123-
currentCompositeDescriptor = item as CompositeFilterDescriptor;
124-
@compositeFilterDescriptorFragment(currentCompositeDescriptor);
125-
}
126-
else
127-
{
128-
currentFilterDescriptor = item as FilterDescriptor;
129-
@filterDescriptorFragment(currentFilterDescriptor)
130-
}
131-
}
132-
}
133-
</text>;
134-
135-
static RenderFragment<FilterDescriptor> filterDescriptorFragment = (fd)
136-
=> @<text><div>FilterDescriptor info: Member: @fd.Member Type: @fd.MemberType Value: @fd.Value</div></text>;
137-
public class Person
138-
{
139-
public int EmployeeId { get; set; }
140-
141-
public string Name { get; set; }
142-
143-
public int AgeInYears { get; set; }
144-
145-
public bool IsOutOfOffice { get; set; }
146-
147-
public DateTime HireDate { get; set; }
148-
}
149-
}
150-
151-
<style>
152-
.log-container div {
153-
clear: both;
154-
}
155-
</style>
156-
````
157-
15868
## See Also
15969

16070
* [Live Demo: Filter](https://demos.telerik.com/blazor-ui/filter/overview)

‎components/filter/fields/templates.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To use the Filter Field value template, add a `<ValueTemplate>` tag inside the [
3333
@using Telerik.DataSource
3434
@using Telerik.DataSource.Extensions
3535
36-
<TelerikFilter Value="@FilterValue" ValueChanged="@OnValueChanged">
36+
<TelerikFilter Value="@FilterValue" OnUpdate="@OnUpdate">
3737
<FilterFields>
3838
<FilterField Name="@(nameof(Food.Id))" Type="@(typeof(int))" Label="Id" />
3939
<FilterField Name="@(nameof(Food.Name))" Type="@(typeof(string))" Label="Name">
@@ -49,7 +49,7 @@ To use the Filter Field value template, add a `<ValueTemplate>` tag inside the [
4949
<TelerikNumericTextBox Value="@((decimal?)context.FilterDescriptor.Value)"
5050
Format="C"
5151
Step="0.01m"
52-
ValueChanged="@( (decimal? value) => NumericValueChanged(context.FilterDescriptor, value) )">
52+
ValueChanged="@((decimal? value) => NumericValueChanged(context.FilterDescriptor, value))">
5353
</TelerikNumericTextBox>
5454
</ValueTemplate>
5555
</FilterField>
@@ -76,7 +76,7 @@ To use the Filter Field value template, add a `<ValueTemplate>` tag inside the [
7676
7777
private CompositeFilterDescriptor FilterValue { get; set; } = new();
7878
79-
private List<string> Suggestions { get; set; } = new () { "Pasta", "Burger", "Pizza", "Kebab", "Steak", "Ice Cream" };
79+
private List<string> Suggestions { get; set; } = new() { "Pasta", "Burger", "Pizza", "Kebab", "Steak", "Ice Cream" };
8080
8181
private void OnFilterValueChanged(FilterDescriptor fd, string value)
8282
{
@@ -89,10 +89,9 @@ To use the Filter Field value template, add a `<ValueTemplate>` tag inside the [
8989
fd.Value = value;
9090
ProcessGridData(FilterValue);
9191
}
92-
93-
private void OnValueChanged(CompositeFilterDescriptor value)
92+
93+
private void OnUpdate()
9494
{
95-
FilterValue = value;
9695
ProcessGridData(FilterValue);
9796
}
9897

‎components/filter/integration.md‎

Lines changed: 69 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This article contains the following sections:
2525

2626
**To integrate the Filter with the Telerik Grid, you need to:**
2727

28-
1. Set the Value parameter of the Filter via [one-way](slug:filter-events#valuechanged) or two-way binding. If you want to filter at the moment of change, use Filter with a one-way bound value.
28+
1. Set the Value parameter of the Filter via [one-way](slug:filter-events#onupdate) or two-way binding. If you want to filter at the moment of change, use Filter with a one-way bound value.
2929
2. Update the Grid data based on the Filter value.
3030

3131
>caption Filter with two-way bound value in Grid
@@ -124,7 +124,7 @@ This article contains the following sections:
124124
@using Telerik.DataSource
125125
@using Telerik.DataSource.Extensions
126126
127-
<TelerikFilter ValueChanged="@OnValueChanged">
127+
<TelerikFilter Value="@FilterValue" OnUpdate="@OnUpdate">
128128
<FilterFields>
129129
<FilterField Name="@(nameof(TreeItem.Id))" Type="@(typeof(int))" Label="Id"></FilterField>
130130
<FilterField Name="@(nameof(TreeItem.Text))" Type="@(typeof(string))" Label="Text"></FilterField>
@@ -140,13 +140,14 @@ This article contains the following sections:
140140
</TelerikTreeView>
141141
142142
@code {
143+
private CompositeFilterDescriptor FilterValue { get; set; } = new CompositeFilterDescriptor();
143144
public static List<TreeItem> InitialData { get; set; } = new List<TreeItem>();
144145
public List<TreeItem> FlatData { get; set; }
145146
public IEnumerable<object> ExpandedItems { get; set; } = new List<TreeItem>();
146147
147-
private void OnValueChanged(CompositeFilterDescriptor filter)
148+
private void OnUpdate()
148149
{
149-
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { filter } };
150+
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { FilterValue } };
150151
151152
var datasourceResult = InitialData.ToDataSourceResult(dataSourceRequest);
152153
var filteredList = datasourceResult.Data.Cast<TreeItem>().ToList();
@@ -157,7 +158,7 @@ This article contains the following sections:
157158
var currentItem = item;
158159
FlatData.Add(currentItem);
159160
160-
while(currentItem.ParentIdValue != null)
161+
while (currentItem.ParentIdValue != null)
161162
{
162163
var parent = InitialData.First(p => p.Id == currentItem.ParentIdValue);
163164
@@ -178,7 +179,7 @@ This article contains the following sections:
178179
public string Text { get; set; }
179180
public int? ParentIdValue { get; set; }
180181
public bool HasChildren { get; set; }
181-
public ISvgIcon Icon { get; set; }
182+
public ISvgIcon Icon { get; set; }
182183
}
183184
184185
protected override void OnInitialized()
@@ -192,63 +193,63 @@ This article contains the following sections:
192193
List<TreeItem> items = new List<TreeItem>();
193194
194195
items.Add(new TreeItem()
195-
{
196-
Id = 1,
197-
Text = "Project",
198-
ParentIdValue = null,
199-
HasChildren = true,
200-
Icon = SvgIcon.Folder
201-
});
196+
{
197+
Id = 1,
198+
Text = "Project",
199+
ParentIdValue = null,
200+
HasChildren = true,
201+
Icon = SvgIcon.Folder
202+
});
202203
203204
items.Add(new TreeItem()
204-
{
205-
Id = 2,
206-
Text = "Design",
207-
ParentIdValue = 1,
208-
HasChildren = true,
209-
Icon = SvgIcon.Brush
210-
});
205+
{
206+
Id = 2,
207+
Text = "Design",
208+
ParentIdValue = 1,
209+
HasChildren = true,
210+
Icon = SvgIcon.Brush
211+
});
211212
items.Add(new TreeItem()
212-
{
213-
Id = 3,
214-
Text = "Implementation",
215-
ParentIdValue = 1,
216-
HasChildren = true,
217-
Icon = SvgIcon.Folder
218-
});
213+
{
214+
Id = 3,
215+
Text = "Implementation",
216+
ParentIdValue = 1,
217+
HasChildren = true,
218+
Icon = SvgIcon.Folder
219+
});
219220
220221
items.Add(new TreeItem()
221-
{
222-
Id = 4,
223-
Text = "site.psd",
224-
ParentIdValue = 2,
225-
HasChildren = false,
226-
Icon = SvgIcon.FilePsd
227-
});
222+
{
223+
Id = 4,
224+
Text = "site.psd",
225+
ParentIdValue = 2,
226+
HasChildren = false,
227+
Icon = SvgIcon.FilePsd
228+
});
228229
items.Add(new TreeItem()
229-
{
230-
Id = 5,
231-
Text = "index.js",
232-
ParentIdValue = 3,
233-
HasChildren = false,
234-
Icon = SvgIcon.Js
235-
});
230+
{
231+
Id = 5,
232+
Text = "index.js",
233+
ParentIdValue = 3,
234+
HasChildren = false,
235+
Icon = SvgIcon.Js
236+
});
236237
items.Add(new TreeItem()
237-
{
238-
Id = 6,
239-
Text = "index.html",
240-
ParentIdValue = 3,
241-
HasChildren = false,
242-
Icon = SvgIcon.Html5
243-
});
238+
{
239+
Id = 6,
240+
Text = "index.html",
241+
ParentIdValue = 3,
242+
HasChildren = false,
243+
Icon = SvgIcon.Html5
244+
});
244245
items.Add(new TreeItem()
245-
{
246-
Id = 7,
247-
Text = "styles.css",
248-
ParentIdValue = 3,
249-
HasChildren = false,
250-
Icon = SvgIcon.Css
251-
});
246+
{
247+
Id = 7,
248+
Text = "styles.css",
249+
ParentIdValue = 3,
250+
HasChildren = false,
251+
Icon = SvgIcon.Css
252+
});
252253
253254
InitialData = items;
254255
FlatData = InitialData;
@@ -272,7 +273,7 @@ This article contains the following sections:
272273
@using Telerik.DataSource
273274
@using Telerik.DataSource.Extensions
274275
275-
<TelerikFilter ValueChanged="@OnValueChanged">
276+
<TelerikFilter Value="@FilterValue" OnUpdate="@OnUpdate">
276277
<FilterFields>
277278
<FilterField Name="@(nameof(Employee.EmployeeId))" Type="@(typeof(int))" Label="Id"></FilterField>
278279
<FilterField Name="@(nameof(Employee.FirstName))" Type="@(typeof(string))" Label="First Name"></FilterField>
@@ -291,12 +292,13 @@ This article contains the following sections:
291292
</TelerikTreeList>
292293
293294
@code {
295+
private CompositeFilterDescriptor FilterValue { get; set; } = new CompositeFilterDescriptor();
294296
public static List<Employee> InitialData { get; set; } = new List<Employee>();
295297
public List<Employee> Data { get; set; }
296298
297-
private void OnValueChanged(CompositeFilterDescriptor filter)
299+
private void OnUpdate()
298300
{
299-
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { filter } };
301+
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { FilterValue } };
300302
301303
var datasourceResult = InitialData.ToDataSourceResult(dataSourceRequest);
302304
var filteredList = datasourceResult.Data.Cast<Employee>().ToList();
@@ -381,7 +383,7 @@ This article contains the following sections:
381383
@using Telerik.DataSource
382384
@using Telerik.DataSource.Extensions
383385
384-
<TelerikFilter ValueChanged="@OnValueChanged">
386+
<TelerikFilter Value="@FilterValue" OnUpdate="@OnUpdate">
385387
<FilterFields>
386388
<FilterField Name="@(nameof(SampleData.Id))" Type="@(typeof(int))" Label="Id"></FilterField>
387389
<FilterField Name="@(nameof(SampleData.Name))" Type="@(typeof(string))" Label="Name"></FilterField>
@@ -401,12 +403,13 @@ This article contains the following sections:
401403
</Template>
402404
</TelerikListView>
403405
404-
@code{
406+
@code {
407+
private CompositeFilterDescriptor FilterValue { get; set; } = new CompositeFilterDescriptor();
405408
List<SampleData> ListViewData { get; set; } = InitialData;
406409
407-
private void OnValueChanged(CompositeFilterDescriptor filter)
410+
private void OnUpdate()
408411
{
409-
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor>{ filter } };
412+
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { FilterValue } };
410413
411414
var datasourceResult = InitialData.ToDataSourceResult(dataSourceRequest);
412415
@@ -458,7 +461,7 @@ This article contains the following sections:
458461
@using Telerik.DataSource
459462
@using Telerik.DataSource.Extensions
460463
461-
<TelerikFilter ValueChanged="@OnValueChanged">
464+
<TelerikFilter Value="@FilterValue" OnUpdate="@OnUpdate">
462465
<FilterFields>
463466
<FilterField Name="@(nameof(MyChartDataModel.ItemValue))" Type="@(typeof(double))" Label="Value"></FilterField>
464467
<FilterField Name="@(nameof(MyChartDataModel.Category))" Type="@(typeof(string))" Label="Category"></FilterField>
@@ -479,7 +482,7 @@ This article contains the following sections:
479482
480483
@code {
481484
TelerikChart myChartRef;
482-
485+
private CompositeFilterDescriptor FilterValue { get; set; } = new CompositeFilterDescriptor();
483486
public static List<MyChartDataModel> InitialData { get; set; } = new List<MyChartDataModel>();
484487
public List<MyChartDataModel> ChartData { get; set; }
485488
@@ -490,9 +493,9 @@ This article contains the following sections:
490493
public string Color { get; set; }
491494
}
492495
493-
private void OnValueChanged(CompositeFilterDescriptor filter)
496+
private void OnUpdate()
494497
{
495-
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { filter } };
498+
var dataSourceRequest = new DataSourceRequest { Filters = new List<IFilterDescriptor> { FilterValue } };
496499
497500
var datasourceResult = InitialData.ToDataSourceResult(dataSourceRequest);
498501

0 commit comments

Comments
 (0)