You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/autocomplete/overview.md
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -47,24 +47,42 @@ User input: @TheValue
47
47
48
48
The AutoComplete is a generic component and its type is determined by the type of the model you use as its data source. You can find examples in the [Data Bind - Considerations]({%slug autocomplete-databind%}#considerations) article.
49
49
50
+
## Features
51
+
50
52
>caption The AutoComplete provides the following features:
51
53
52
54
*`Class` - the CSS class that will be rendered on the main wrapping element of the combobox.
55
+
53
56
*`ClearButton` - whether the user will have the option to clear the selected value with a button on the input. When it is clicked, the `Value` will be updated to `string.Empty`.
57
+
54
58
*`Data` - allows you to provide the data source. Required.
59
+
55
60
*`Enabled` - whether the component is enabled.
61
+
56
62
*`Filterable` - whether [filtering]({%slug autocomplete-filter%}) is enabled for the end user (suggestions will get narrowed down as they type).
63
+
57
64
*`FilterOperator` - the string operation that will be used for [filtering]({%slug autocomplete-filter%}). Defaults to `StartsWith`.
65
+
58
66
*`Id` - renders as the `id` attribute on the `<input />` element, so you can attach a `<label for="">` to the input.
67
+
59
68
*`MinLength` - how many characters the text has to be before the suggestions list appears. Cannot be `0`. Often works together with [filtering]({%slug autocomplete-filter%}).
69
+
60
70
*`Placeholder` - the text the user sees as a hint when there is no text in the input.
71
+
61
72
*`PopupHeight` - the height of the expanded dropdown list element.
62
-
*`PopupWidth` - the width of the expanded dropdown list element.
73
+
74
+
*`PopupWidth` - the width of the expanded dropdown list element. If you don't specify a value, the dropdown width will match the main element which can help with responsive layouts and 100% widths.
75
+
63
76
*`TItem` - the type of the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
77
+
64
78
*`Value` and `bind-Value`- get/set the value of the component, can be used for binding. Use the `@bind-Value` syntax for two-way binding, for example, to a variable of your own. The `Value` must be a `string`.
79
+
65
80
*`ValueField` - the name of the field from the model that will be shown as hints to the user. Defaults to `Value`. Not required when binding to a simple list of strings.
81
+
66
82
*`Width` - the width of the main element.
83
+
67
84
* Templates - they allow you to control the rendering of items in the component. See the [Templates]({%slug autocomplete-templates%}) article for more details.
85
+
68
86
* Validation - see the [Input Validation]({%slug common-features/input-validation%}) article for more details.
Copy file name to clipboardExpand all lines: components/combobox/overview.md
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -58,20 +58,35 @@ The ComboBox is a generic component and its type is determined by the type of th
58
58
>caption The ComboBox provides the following features:
59
59
60
60
*`AllowCustom` - whether the user can enter [custom values]({%slug components/combobox/custom-value%}). If enabled, the `ValueField` must be a `string`.
61
+
61
62
*`Class` - the CSS class that will be rendered on the main wrapping element of the combobox.
63
+
62
64
*`ClearButton` - whether the user will have the option to clear the selected value. When it is clicked, the `Value` will be updated to `default(TValue)`, so there must be no item in the `Data` that has such a `Value`. For example, if `TValue` is `int`, clearing the value will lead to a `0``Value`, so if there is an Item with `0` in its `ValueField` - issues may arise with its selection. This feature can often go together with `AllowCustom`.
65
+
63
66
*`Data` - allows you to provide the data source. Required.
67
+
64
68
*`Enabled` - whether the component is enabled.
69
+
65
70
*`Filterable` - whether [filtering]({%slug components/combobox/filter%}) is enabled for the end user.
71
+
66
72
*`FilterOperator` - the method of [filtering]({%slug components/combobox/filter%}) the items. Defaults to `StartsWith`.
73
+
67
74
*`Id` - renders as the `id` attribute on the `<input />` element, so you can attach a `<label for="">` to the input.
75
+
68
76
*`Placeholder` - the text the user sees as a hint when no item is selected (the `Value` is `null` or an empty string).
77
+
69
78
*`PopupHeight` - the height of the expanded dropdown list element.
70
-
*`PopupWidth` - the width of the expanded dropdown list element.
79
+
80
+
*`PopupWidth` - the width of the expanded dropdown list element. If you don't specify a value, the dropdown width will match the main element which can help with responsive layouts and 100% widths.
81
+
71
82
*`TItem` - the type of the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
83
+
72
84
*`TValue` - the type of the value field from the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
85
+
73
86
*`TextField` - the name of the field from the model that will be shown to the user. Defaults to `Text`.
87
+
74
88
*`ValueField` - the name of the field from the model that will be the underlying `value`. Defaults to `Value`.
89
+
75
90
*`Value` and `bind-Value`- get/set the value of the component, can be used for binding. If you set it to a value allowed by the model class value field, the corresponding item from the data collection will be pre-selected. Use the `bind-Value` syntax for two-way binding, for example, to a variable of your own.
76
91
77
92
The `Value` and `ValueField` can be of types:
@@ -80,8 +95,11 @@ The ComboBox is a generic component and its type is determined by the type of th
80
95
*`string`
81
96
*`Guid`
82
97
*`Enum`
98
+
83
99
*`Width` - the width of the dropdown and the main element.
100
+
84
101
* Templates - they allow you to control the rendering of items in the component. See the [Templates]({%slug components/combobox/templates%}) article for more details.
102
+
85
103
* Validation - see the [Input Validation]({%slug common-features/input-validation%}) article for more details.
Copy file name to clipboardExpand all lines: components/dropdownlist/overview.md
+16-1Lines changed: 16 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -56,17 +56,29 @@ See the [Component Reference]({%slug components/dropdownlist/databind%}#componen
56
56
The DropDownList provides the following features:
57
57
58
58
*`Class` - the CSS class that will be rendered on the main wrapping element of the dropdownlist.
59
+
59
60
*`Data` - allows you to provide the data source. Required.
61
+
60
62
*`DefaultText` - sets the hint that is shown if the `Value` has the `default` value for the type of the `ValueField`. For example, `0` for an `int`, and `null` for an `int?` or `string`. You need to make sure that it does not match the value of an existing item in the data source. You can find examples in the [Examples section](#examples) in this article and in the [Input Validation]({%slug common-features/input-validation%}#dropdownlist) article.
63
+
61
64
*`Enabled` - whether the component is enabled.
65
+
62
66
*`Id` - renders as the `id` attribute on the `<select />` element, so you can attach a `<label for="">` to it.
67
+
63
68
*`PopupHeight` - the height of the expanded dropdown list element.
64
-
*`PopupWidth` - the width of the expanded dropdown list element.
69
+
70
+
*`PopupWidth` - the width of the expanded dropdown list element. If you don't specify a value, the dropdown width will match the main element which can help with responsive layouts and 100% widths.
71
+
65
72
*`TItem` - the type of the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
73
+
66
74
*`TValue` - the type of the value field from the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
75
+
67
76
*`TabIndex` - the `tabindex` attribute rendered on the dropdown.
77
+
68
78
*`TextField` - the name of the field from the model that will be shown to the user. Defaults to `Text`.
79
+
69
80
*`ValueField` - the name of the field from the model that will be the underlying `value`. Defaults to `Value`.
81
+
70
82
*`Value` and `bind-Value`- get/set the value of the component, can be used for binding. If you set it to a value allowed by the model class value field, the corresponding item from the data collection will be pre-selected. Use the `bind-Value` syntax for two-way binding, for example, to a variable of your own.
71
83
72
84
The `Value` and `ValueField` can be of types:
@@ -75,8 +87,11 @@ The DropDownList provides the following features:
75
87
*`string`
76
88
*`Guid`
77
89
*`Enum`
90
+
78
91
*`Width` - the width of the dropdown and the main element.
92
+
79
93
* Templates - they allow you to control the rendering of items in the component. See the [Templates]({%slug components/dropdownlist/templates%}) article for more details.
94
+
80
95
* Validation - see the [Input Validation]({%slug common-features/input-validation%}) article for more details.
Copy file name to clipboardExpand all lines: components/multiselect/overview.md
+23-2Lines changed: 23 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -68,21 +68,38 @@ To use a Telerik MultiSelect for Blazor
68
68
69
69
The MultiSelect is a generic component and its type is determined by the type of the model you use as its data source. You can find examples in the [Data Bind - Considerations]({%slug multiselect-databind%}#considerations) article.
70
70
71
+
72
+
## Features
73
+
71
74
>caption The MultiSelect provides the following features:
72
75
73
76
*`Class` - the CSS class that will be rendered on the main wrapping element of the multiselect.
77
+
74
78
*`ClearButton` - whether the user will have the option to clear the selected items with a button on the input. When it is clicked, the `Value` will be updated to an empty list.
79
+
75
80
*`Data` - allows you to provide the data source. Required.
81
+
76
82
*`Enabled` - whether the component is enabled.
77
-
*`Filterable` - whether [filtering]({%slug multiselect-filter%}) is enabled for the end user (suggestions will get narrowed down as they type).
83
+
84
+
*`Filterable` - whether [filtering]({%slug multiselect-filter%}) is enabled for the end user
85
+
(suggestions will get narrowed down as they type).
86
+
78
87
*`FilterOperator` - the string operation that will be used for [filtering]({%slug multiselect-filter%}). Defaults to `StartsWith`.
88
+
79
89
*`Id` - renders as the `id` attribute on the `<select />` element, so you can attach a `<label for="">` to it.
90
+
80
91
*`MinLength` - how many characters the text has to be before the suggestions list appears. Cannot be `0`. Often works together with [filtering]({%slug multiselect-filter%}).
92
+
81
93
*`Placeholder` - the text the user sees as a hint when there is no selection.
94
+
82
95
*`PopupHeight` - the height of the expanded dropdown list element.
83
-
*`PopupWidth` - the width of the expanded dropdown list element.
96
+
97
+
*`PopupWidth` - the width of the expanded dropdown list element. If you don't specify a value, the dropdown width will match the main element which can help with responsive layouts and 100% widths.
98
+
84
99
*`TextField` - the field in the model from which the text of the items is taken. Defaults to `Text`.
100
+
85
101
*`TItem` - the type of the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
102
+
86
103
*`TValue` - the type of the value field in the model to which the component is bound. Required if you can't provide `Data` or `Value`. Determines the type of the reference object.
87
104
88
105
The type of the values can be:
@@ -93,9 +110,13 @@ The MultiSelect is a generic component and its type is determined by the type of
93
110
*`Enum`
94
111
95
112
*`Value` and `bind-Value`- get/set the value of the component, can be used for binding. Use the `@bind-Value` syntax for two-way binding, for example, to a variable of your own. The `Value` must be a `List<TValue>`.
113
+
96
114
*`ValueField` - the name of the field from the model that will be used as values in the selection. Defaults to `Value`.
115
+
97
116
*`Width` - the width of the main element.
117
+
98
118
* Templates - they allow you to control the rendering of items in the component. See the [Templates]({%slug multiselect-templates%}) article for more details.
119
+
99
120
* Validation - see the [Input Validation]({%slug common-features/input-validation%}) article for more details.
0 commit comments