PullToRefresh
The PullToRefresh component is used to add the pull down to refresh feature to a page or a specific element.
Usage
Basic
01. Item 41
02. Item 5
03. Item 10
04. Item 18
05. Item 38
06. Item 1
07. Item 4
08. Item 50
09. Item 15
10. Item 1
11. Item 2
12. Item 5
13. Item 50
14. Item 17
15. Item 46
16. Item 25
17. Item 30
18. Item 5
19. Item 49
20. Item 2
21. Item 18
22. Item 1
23. Item 20
24. Item 42
25. Item 27
26. Item 25
27. Item 24
28. Item 48
29. Item 38
30. Item 41
31. Item 18
32. Item 32
33. Item 37
34. Item 27
35. Item 14
36. Item 23
37. Item 44
38. Item 10
39. Item 47
40. Item 4
41. Item 17
42. Item 10
43. Item 28
44. Item 39
45. Item 33
46. Item 34
47. Item 30
48. Item 8
49. Item 44
50. Item 1
Custom loading
01. Item 11
02. Item 8
03. Item 2
04. Item 33
05. Item 1
06. Item 8
07. Item 30
08. Item 36
09. Item 42
10. Item 34
11. Item 19
12. Item 45
13. Item 47
14. Item 32
15. Item 35
16. Item 46
17. Item 31
18. Item 30
19. Item 2
20. Item 32
21. Item 49
22. Item 29
23. Item 50
24. Item 31
25. Item 48
26. Item 39
27. Item 28
28. Item 13
29. Item 38
30. Item 39
31. Item 9
32. Item 35
33. Item 32
34. Item 38
35. Item 46
36. Item 5
37. Item 50
38. Item 47
39. Item 45
40. Item 16
41. Item 43
42. Item 39
43. Item 22
44. Item 49
45. Item 10
46. Item 13
47. Item 30
48. Item 34
49. Item 34
50. Item 20
Multiple
00. Item 14
01. Item 43
02. Item 49
03. Item 35
04. Item 1
05. Item 45
06. Item 38
07. Item 1
08. Item 42
09. Item 32
10. Item 2
11. Item 46
12. Item 38
13. Item 41
14. Item 35
15. Item 26
16. Item 20
17. Item 38
18. Item 1
19. Item 2
20. Item 0
21. Item 5
22. Item 31
23. Item 45
24. Item 46
25. Item 1
26. Item 17
27. Item 24
28. Item 30
29. Item 41
30. Item 44
31. Item 9
32. Item 47
33. Item 21
34. Item 35
35. Item 16
36. Item 3
37. Item 43
38. Item 14
39. Item 37
40. Item 37
41. Item 33
42. Item 7
43. Item 25
44. Item 21
45. Item 17
46. Item 20
47. Item 30
48. Item 26
49. Item 8
51. Item 65
52. Item 78
53. Item 62
54. Item 69
55. Item 95
56. Item 64
57. Item 88
58. Item 96
59. Item 86
60. Item 95
61. Item 82
62. Item 62
63. Item 86
64. Item 63
65. Item 70
66. Item 63
67. Item 53
68. Item 79
69. Item 91
70. Item 51
71. Item 57
72. Item 93
73. Item 93
74. Item 87
75. Item 91
76. Item 99
77. Item 74
78. Item 71
79. Item 94
80. Item 98
81. Item 88
82. Item 81
83. Item 77
84. Item 82
85. Item 60
86. Item 92
87. Item 71
88. Item 80
89. Item 52
90. Item 57
91. Item 51
92. Item 67
93. Item 98
94. Item 76
95. Item 70
96. Item 80
97. Item 77
98. Item 87
99. Item 68
100. Item 91
Advanced
An illustrative example of integrating this component into a straightforward mobile application.
BlazorUI
01. Item 12
02. Item 48
03. Item 35
04. Item 11
05. Item 19
06. Item 20
07. Item 16
08. Item 34
09. Item 43
10. Item 19
11. Item 8
12. Item 39
13. Item 23
14. Item 35
15. Item 28
16. Item 50
17. Item 16
18. Item 28
19. Item 43
20. Item 37
21. Item 50
22. Item 19
23. Item 8
24. Item 5
25. Item 49
26. Item 42
27. Item 49
28. Item 37
29. Item 36
30. Item 6
31. Item 45
32. Item 19
33. Item 31
34. Item 6
35. Item 2
36. Item 2
37. Item 35
38. Item 11
39. Item 9
40. Item 45
41. Item 40
42. Item 44
43. Item 50
44. Item 3
45. Item 35
46. Item 18
47. Item 17
48. Item 26
49. Item 26
50. Item 3
Style & Class
Empower customization by overriding default styles and classes, allowing tailored design modifications to suit specific UI requirements.
01. Item 19
02. Item 33
03. Item 15
04. Item 35
05. Item 18
06. Item 13
07. Item 14
08. Item 46
09. Item 25
10. Item 11
11. Item 13
12. Item 45
13. Item 28
14. Item 12
15. Item 27
16. Item 16
17. Item 50
18. Item 10
19. Item 15
20. Item 48
21. Item 47
22. Item 34
23. Item 19
24. Item 13
25. Item 8
26. Item 45
27. Item 18
28. Item 24
29. Item 12
30. Item 44
31. Item 28
32. Item 26
33. Item 45
34. Item 23
35. Item 28
36. Item 35
37. Item 37
38. Item 4
39. Item 17
40. Item 43
41. Item 31
42. Item 45
43. Item 13
44. Item 40
45. Item 38
46. Item 49
47. Item 12
48. Item 9
49. Item 15
50. Item 50
51. Item 83
52. Item 85
53. Item 75
54. Item 83
55. Item 77
56. Item 73
57. Item 65
58. Item 74
59. Item 63
60. Item 52
61. Item 64
62. Item 75
63. Item 57
64. Item 97
65. Item 84
66. Item 65
67. Item 60
68. Item 66
69. Item 87
70. Item 60
71. Item 68
72. Item 85
73. Item 100
74. Item 59
75. Item 64
76. Item 92
77. Item 78
78. Item 85
79. Item 100
80. Item 59
81. Item 81
82. Item 61
83. Item 91
84. Item 72
85. Item 55
86. Item 54
87. Item 56
88. Item 75
89. Item 55
90. Item 81
91. Item 100
92. Item 89
93. Item 57
94. Item 55
95. Item 97
96. Item 58
97. Item 58
98. Item 87
99. Item 54
100. Item 83
API
BitPullToRefresh parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| Anchor | RenderFragment? | null | The anchor element that the pull to refresh component adheres to (alias of ChildContent). |
| ChildContent | RenderFragment? | null | The anchor element that the pull to refresh component adheres to. |
| Classes | BitPullToRefreshClassStyles? | null | Custom CSS classes for different parts of the BitPullToRefresh. |
| Factor | decimal | 2 | The factor to balance the pull height out. |
| Loading | RenderFragment? | null | The custom loading template to replace the default loading svg. |
| Margin | int | 30 | The value in pixel to add to the top of pull element as a margin for the pull height. |
| OnRefresh | EventCallback | The callback for when the threshold of the pull-down happens. | |
| OnPullStart | EventCallback<BitPullToRefreshPullStartArgs> | The callback for the starting of the pull-down. | |
| OnPullMove | EventCallback<decimal> | The callback for when the pull-down is in progress. | |
| OnPullEnd | EventCallback<decimal> | The callback for the ending of the pull-down. | |
| ScrollerElement | ElementReference? | null | The element that is the scroller in the anchor to control the behavior of the pull to refresh. |
| ScrollerSelector | string? | null | The CSS selector of the element that is the scroller in the anchor to control the behavior of the pull to refresh. |
| Styles | BitPullToRefreshClassStyles? | null | Custom CSS styles for different parts of the BitPullToRefresh. |
| Threshold | int | 0 | The threshold in pixel for pulling height that starts the pull to refresh process. |
| Trigger | int | 80 | The pulling height in pixel that triggers the refresh. |
BitComponentBase parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AriaLabel | string? | null | Gets or sets the accessible label for the component, used by assistive technologies. |
| Class | string? | null | Gets or sets the CSS class name(s) to apply to the rendered element. |
| Dir | BitDir? | null | Gets or sets the text directionality for the component's content. |
| HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. |
| Id | string? | null | Gets or sets the unique identifier for the component's root element. |
| IsEnabled | bool | true | Gets or sets a value indicating whether the component is enabled and can respond to user interaction. |
| Style | string? | null | Gets or sets the CSS style string to apply to the rendered element. |
| TabIndex | string? | null | Gets or sets the tab order index for the component when navigating with the keyboard. |
| Visibility | BitVisibility | BitVisibility.Visible | Gets or sets the visibility state (visible, hidden, or collapsed) of the component. |
BitComponentBase public members
Name |
Type |
Default value |
Description |
|---|---|---|---|
| UniqueId | Guid | Guid.NewGuid() | Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed. |
| RootElement | ElementReference | Gets the reference to the root HTML element associated with this component. |
BitPullToRefreshPullStartArgs properties
Name |
Type |
Default value |
Description |
|---|---|---|---|
| Top | decimal | The top offset of the pull to refresh element in pixels. | |
| Left | decimal | The left offset of the pull to refresh element in pixels. | |
| Width | decimal | The width of the pull to refresh element in pixels. |
BitPullToRefreshClassStyles properties
Name |
Type |
Default value |
Description |
|---|---|---|---|
| Root | string? | null | Custom CSS classes/styles for the root element of the PullToRefresh. |
| Loading | string? | null | Custom CSS classes/styles for the loading element. |
| SpinnerWrapper | string? | null | Custom CSS classes/styles for the spinner wrapper element. |
| SpinnerWrapperRefreshing | string? | null | Custom CSS classes/styles for the spinner wrapper element in refreshing mode. |
| Spinner | string? | null | Custom CSS classes/styles for the spinner element. |
| SpinnerRefreshing | string? | null | Custom CSS classes/styles for the spinner element in refreshing mode. |
BitVisibility enum
Name |
Value |
Description |
|---|---|---|
| Visible | 0 | The content of the component is visible. |
| Hidden | 1 | The content of the component is hidden, but the space it takes on the page remains (visibility:hidden). |
| Collapsed | 2 | The component is hidden (display:none). |
BitDir enum
Name |
Value |
Description |
|---|---|---|
| Ltr | 0 | Ltr (left to right) is to be used for languages that are written from the left to the right (like English). |
| Rtl | 1 | Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic). |
| Auto | 2 | Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element. |
Feedback
You can give us your feedback through our GitHub repo by filing a new Issue or starting a new Discussion.
Or you can review / edit this page on GitHub.
Or you can review / edit this component on GitHub.
- On this page