Skip to content

Commit a0ddd4a

Browse files
Tsvetomir-HrTsvetomir-Hr
authored andcommitted
chore(Filter): document OnUpdate event
1 parent dbdcc78 commit a0ddd4a

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

components/filter/events.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,52 @@ position: 11
1212

1313
This article explains the available events for the Telerik Filter for Blazor:
1414

15+
* [OnUpdate](#onupdate)
1516
* [ValueChanged](#valuechanged)
1617

18+
## OnUpdate
19+
20+
The `OnUpdate` event fires when the filter value changes. The component works directly with the bound `CompositeFilterDescriptor` value and automatically updates it when it is used with one-way binding.
21+
22+
>caption Handle OnUpdate.
23+
24+
````RAZOR
25+
@using Telerik.DataSource
26+
27+
<TelerikFilter Value="@Value" OnUpdate="@OnFilterUpdate">
28+
<FilterFields>
29+
<FilterField Name="@(nameof(Person.EmployeeId))" Type="@(typeof(int))" Label="Id"></FilterField>
30+
<FilterField Name="@(nameof(Person.Name))" Type="@(typeof(string))" Label="First Name"></FilterField>
31+
<FilterField Name="@(nameof(Person.AgeInYears))" Type="@(typeof(int))" Label="Age"></FilterField>
32+
</FilterFields>
33+
</TelerikFilter>
34+
<br />
35+
<strong>OnUpdate triggered count: </strong> @TriggeredOnUpdateCount
36+
37+
@code {
38+
private CompositeFilterDescriptor Value { get; set; } = new CompositeFilterDescriptor();
39+
private int TriggeredOnUpdateCount { get; set; }
40+
41+
private void OnFilterUpdate()
42+
{
43+
TriggeredOnUpdateCount++;
44+
}
45+
46+
public class Person
47+
{
48+
public int EmployeeId { get; set; }
49+
public string Name { get; set; }
50+
public int AgeInYears { get; set; }
51+
}
52+
}
53+
````
54+
1755
## ValueChanged
1856

1957
The `ValueChanged` event fires when the value has changed. Its event handler receives the updated `CompositeFilterDescriptor` as an argument.
2058

59+
> The `ValueChanged` event will be deprecated in future versions. Use the `OnUpdate` event instead.
60+
2161
>caption Handle ValueChanged.
2262
2363
````RAZOR

0 commit comments

Comments
 (0)