Skip to content

Commit ff1949f

Browse files
dimodiikoevska
andauthored
docs(common): Remove promises for the future (#2330)
* docs(common): Remove promises for the future * Update knowledge-base/requires-valueexpression.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update upgrade/overview.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update form-chrome-autofill.md * Update overview.md --------- Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
1 parent 048d242 commit ff1949f

33 files changed

+69
-108
lines changed

_contentTemplates/common/dropdowns-virtualization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ the component will call this method to request the model that matches the `Value
3333

3434
#limitations
3535
* When the initially selected item/items are on a page different than the first one, opening the dropdown list will NOT scroll the list to the selected item.
36-
* When virtualization is enabled, the component calculates the position of the items. In this case, the loading indicators are not displayed as they would affect the proper item positioning. This limitation will be removed in a future version of UI for Blazor.
36+
* When virtualization is enabled, the component calculates the position of the items. In this case, the loading indicators are not displayed as they would affect the proper item positioning.
3737
#end
3838

3939
#remote-data-sample-intro

_contentTemplates/treelist/state.md

Lines changed: 23 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -554,9 +554,7 @@
554554

555555
#get-column-state-from-code
556556

557-
@* Click the button, reorder some columns, maybe lock one of them, hide another, and click the button again to see how the state changes but the order of the columns in the state collection remains the same. This example also shows a workaround for getting the Field of the column that will be availale in a future release as part of the column state. *@
558-
559-
@using Telerik.DataSource;
557+
@* Click the button, reorder some columns, maybe lock one of them, hide another, and click the button again to see how the state changes but the order of the columns in the state collection remains the same. *@
560558

561559
<TelerikButton OnClick="@GetColumnsFromState">Get the state of the Columns</TelerikButton>
562560

@@ -580,64 +578,36 @@
580578
</TelerikTreeList>
581579

582580
@code {
583-
public TelerikTreeList<Employee> TreeListRef { get; set; } = new TelerikTreeList<Employee>();
584-
585-
//part of workaround for getting the field too
586-
public List<string> ColumnFields => new List<string>
587-
{
588-
nameof(Employee.Name),
589-
nameof(Employee.Id),
590-
nameof(Employee.EmailAddress),
591-
nameof(Employee.HireDate)
592-
};
593-
public string Logger { get; set; } = String.Empty;
594-
595-
public async Task GetColumnsFromState()
581+
private TelerikTreeList<Employee>? TreeListRef { get; set; }
582+
583+
private string Logger { get; set; } = String.Empty;
584+
585+
private List<Employee> Data { get; set; } = new();
586+
587+
private void GetColumnsFromState()
596588
{
597-
// final part of the workaround for getting the field
598-
var columnsState = TreeListRef.GetState().ColumnStates;
589+
var columnsState = TreeListRef!.GetState().ColumnStates;
599590

600591
int index = 0;
601592

602593
foreach (var item in columnsState)
603594
{
604-
string columnField = ColumnFields[index];
605-
606595
bool isVisible = item.Visible != false;
607596

608-
string log = $"<p>Column: <strong>{columnField}</strong> | Index in TreeList: {item.Index} | Index in state: {index} | Visible: {isVisible} | Locked: {item.Locked}</p>";
597+
string log = $"<p>Column: <strong>{item.Field}</strong> | Index in TreeList: {item.Index} | Index in state: {index} | Visible: {isVisible} | Locked: {item.Locked}</p>";
609598
Logger += log;
610599
index++;
611600
}
612601
}
613602

614-
public List<Employee> Data { get; set; }
615-
616-
// sample model
617-
618-
public class Employee
603+
protected override void OnInitialized()
619604
{
620-
// hierarchical data collections
621-
public List<Employee> DirectReports { get; set; }
622-
623-
// data fields for display
624-
public int Id { get; set; }
625-
public string Name { get; set; }
626-
public string EmailAddress { get; set; }
627-
public DateTime HireDate { get; set; }
605+
Data = GetTreeListData();
628606
}
629607

630-
// data generation
631-
632-
// used in this example for data generation and retrieval for CUD operations on the current view-model data
633608
public int LastId { get; set; } = 1;
634609

635-
protected override async Task OnInitializedAsync()
636-
{
637-
Data = await GetTreeListData();
638-
}
639-
640-
async Task<List<Employee>> GetTreeListData()
610+
private List<Employee> GetTreeListData()
641611
{
642612
List<Employee> data = new List<Employee>();
643613

@@ -684,7 +654,16 @@
684654
}
685655
}
686656

687-
return await Task.FromResult(data);
657+
return data;
658+
}
659+
660+
public class Employee
661+
{
662+
public int Id { get; set; }
663+
public string Name { get; set; } = string.Empty;
664+
public string EmailAddress { get; set; } = string.Empty;
665+
public DateTime HireDate { get; set; }
666+
public List<Employee>? DirectReports { get; set; }
688667
}
689668
}
690669
#end

common-features/data-binding/observable-data.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ In this article:
1717
* [Observable data](#observable-data)
1818
* [Refresh Data](#refresh-data)
1919
* [Telerik components that support Observable Data](#telerik-components-that-support-observable-data)
20-
* [Telerik components that will support Observable Data in a future release](#telerik-components-that-will-support-observable-data-in-a-future-release)
2120

2221
## Observable Data
2322

@@ -52,9 +51,7 @@ The following components support observable data for their `Data` parameter. Not
5251
* [TreeView]({%slug treeview-refresh-data%})
5352

5453

55-
## Telerik components that will support Observable Data in a future release
56-
57-
The following components will receive this feature in a future release. You can currently refresh their Data by creating a [New collection reference](#refresh-data).
54+
You can refresh other components that do not support observable data by creating a [New collection reference](#refresh-data).
5855

5956
* [Scheduler]({%slug scheduler-refresh-data%})
6057

@@ -67,5 +64,5 @@ The following components will receive this feature in a future release. You can
6764

6865
## See Also
6966

70-
* [INotifyCollectionChanged Interface](https://docs.microsoft.com/en-us/dotnet/api/system.collections.specialized.inotifycollectionchanged?view=netframework-4.8)
71-
* [Live Demos](https://demos.telerik.com/blazor-ui/)
67+
* [INotifyCollectionChanged Interface](https://docs.microsoft.com/en-us/dotnet/api/system.collections.specialized.inotifycollectionchanged?view=netframework-4.8)
68+
* [Live Demos](https://demos.telerik.com/blazor-ui/)

components/autocomplete/grouping.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@ The group headers can stick to the top of the dropdown during scrolling. In othe
6767

6868
* One level of grouping is supported.
6969
* A grouped AutoComplete will provide a `Groups` property with a single [`GroupDescriptor`](/blazor-ui/api/Telerik.DataSource.GroupDescriptor) in the [`DataSourceRequest`](/blazor-ui/api/Telerik.DataSource.DataSourceRequest) argument of its [OnRead event]({%slug autocomplete-events%}#onread). This will allow the developer to apply grouping with [manual data operations]({%slug components/grid/manual-operations%}).
70-
* `GroupHeaderTemplate` and `GroupItemTemplate` will be introduced in a future version. Currently there is a bug in the Blazor framework that prevents us from supporting them.
71-
* Virtual scrolling with grouping will be supported in a future version.
7270

7371
## See Also
7472

components/combobox/grouping.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ The group headers can stick to the top of the dropdown during scrolling. In othe
6868

6969
* One level of grouping is supported.
7070
* A grouped ComboBox will provide a `Groups` property with a single [`GroupDescriptor`](/blazor-ui/api/Telerik.DataSource.GroupDescriptor) in the [`DataSourceRequest`](/blazor-ui/api/Telerik.DataSource.DataSourceRequest) argument of its [OnRead event]({%slug components/combobox/events%}#onread). This will allow the developer to apply grouping with [manual data operations]({%slug components/grid/manual-operations%}).
71-
* `GroupHeaderTemplate` and `GroupItemTemplate` will be introduced in a future version. Currently there is a bug in the Blazor framework that prevents us from supporting them.
72-
* Virtual scrolling with grouping will be supported in a future version.
7371

7472
## See Also
7573

components/contextmenu/refresh-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In this article:
1818

1919
## Observable Data
2020

21-
>note The Context Menu will receive this feature in a future release. You can currently refresh its Data by creating a [New collection reference](#new-collection-reference).
21+
>note The Context Menu does not support binding to observable data. You can currently refresh the component by creating a [new collection reference](#new-collection-reference).
2222
2323
@[template](/_contentTemplates/common/observable-data.md#observable-data)
2424

components/drawer/refresh-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In this article:
1818

1919
## Observable Data
2020

21-
>note The Drawer will receive this feature in a future release. You can currently refresh its Data by creating a [New collection reference](#new-collection-reference).
21+
>note The Drawer does not support binding to observable data. You can currently refresh the component by creating a [new collection reference](#new-collection-reference).
2222
2323
@[template](/_contentTemplates/common/observable-data.md#observable-data)
2424

components/dropdownlist/grouping.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,6 @@ The group headers can stick to the top of the dropdown during scrolling. In othe
6969
* One level of grouping is supported.
7070
* The `DefaultText` (e.g. "Select item...") is always rendered above the sticky group header in the dropdown.
7171
* A grouped DropDownList will provide a `Groups` property with a single [`GroupDescriptor`](/blazor-ui/api/Telerik.DataSource.GroupDescriptor) in the [`DataSourceRequest`](/blazor-ui/api/Telerik.DataSource.DataSourceRequest) argument of its [OnRead event]({%slug components/dropdownlist/events%}#onread). This will allow the developer to apply grouping with [manual data operations]({%slug components/grid/manual-operations%}).
72-
* `GroupHeaderTemplate` and `GroupItemTemplate` will be introduced in a future version. Currently there is a bug in the Blazor framework that prevents us from supporting them.
73-
* Virtual scrolling with grouping will be supported in a future version.
7472

7573
## See Also
7674

components/gantt/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ The Blazor Gantt component exposes templates for customizing the [Timeline]({%sl
184184

185185
## Toolbar
186186

187-
The Blazor Gantt component has a dedicated toolbar for defining user actions. For the moment, they are mostly custom actions, but in future versions you will be able to add features like exporting there.
187+
The Blazor Gantt component has a dedicated toolbar for defining user actions.
188188

189189
## Scrolling
190190

components/grid/export/pdf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ The following sample projects show two ways to implement a PDF export
1919
* <a href="https://github.com/telerik/blazor-ui/tree/master/common/pdf-jpg-export-js" target="_blank">PDF and JPG Export in the Browser with JS</a> - uses Kendo JS libraries to generate the PDF file from the current DOM in the browser.
2020

2121

22-
In the future, there will be a built-in feature in the grid for this so you don't have to generate the file on your own. You can Follow it <a href="https://feedback.telerik.com/blazor/1434269-export-grid-to-pdf" target="_blank">here</a>. At the moment, the WebAssembly scenario is too slow for us to release it, mainly due to the missing <a href="https://github.com/dotnet/aspnetcore/issues/17730" target="_blank">multithreading</a> and <a href="https://github.com/dotnet/aspnetcore/issues/5466" target="_blank">AoT support</a> for Blazor, and <a href="https://github.com/mono/mono/issues/10222" target="_blank">full AoT for Mono</a>.
22+
You can also follow the feature request for <a href="https://feedback.telerik.com/blazor/1434269-export-grid-to-pdf" target="_blank">built-in Grid export to PDF</a>.

components/grid/filter/checkboxlist.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,7 @@ depending on how you filter the data so you may never be able to get back all va
198198
});
199199
}
200200
201-
// get custom filters data. In a future version you will be able to call these methods
202-
// from the template initialization instead of here (or in OnRead) so that they fetch data
203-
// only when the user actually needs filter values, instead of always - that could improve server performance
201+
// Get custom filters data.
204202
await GetTeamOptions();
205203
await GetNameOptions();
206204
}

components/listview/paging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The ListView exposes three relevant events. You can find related examples in the
6464
>tip You can optimize database queries in two ways:
6565
>
6666
> * Use an `IQueryable<MyModel>` collection for the listview `Data`. The listview will build a LINQ expression internally that will be resolved only when needed. This can be useful when the `Data` comes from something like an EntityFramework context.
67-
> * Implement [manual data source operations]({%slug listview-manual-operations%}) and implement the desired query yourself. In a future version, the `DataSourceRequest` object will become serializable so you can send it directly over HTTP to a controller and use the LINQ queries it will build for you.
67+
> * Bind the ListView with an [`OnRead` handler]({%slug common-features-data-binding-onread%}) and implement [manual data source operations]({%slug listview-manual-operations%}).
6868
6969
## Pager Settings
7070

components/menu/refresh-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In this article:
1818

1919
## Observable Data
2020

21-
>note The Menu will receive this feature in a future release. You can currently refresh its Data by creating a [New collection reference](#new-collection-reference).
21+
>note The Menu does not support binding to observable data. You can currently refresh the component by creating a [new collection reference](#new-collection-reference).
2222
2323
@[template](/_contentTemplates/common/observable-data.md#observable-data)
2424

components/multicolumncombobox/grouping.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,6 @@ The group headers stick to the top of the dropdown during scrolling. In other wo
7979
* One level of grouping is supported.
8080
* The `Placeholder` (e.g. "Select item...") is always rendered above the sticky group header in the dropdown.
8181
* A grouped MultiColumnComboBox will provide a `Groups` property with a single [`GroupDescriptor`](/blazor-ui/api/Telerik.DataSource.GroupDescriptor) in the [`DataSourceRequest`](/blazor-ui/api/Telerik.DataSource.DataSourceRequest) argument of its [OnRead event]({%slug multicolumncombobox-events%}#onread). This will allow the developer to apply grouping with [manual data operations]({%slug common-features-data-binding-onread%}).
82-
* `GroupHeaderTemplate` and `GroupItemTemplate` will be introduced in a future version. Currently there is a bug in the Blazor framework that prevents us from supporting them.
83-
* Virtual scrolling with grouping will be supported in a future version.
8482

8583
## See Also
8684

components/multiselect/grouping.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ The group headers can stick to the top of the dropdown during scrolling. In othe
6868

6969
* One level of grouping is supported.
7070
* A grouped MultiSelect will provide a `Groups` property with a single [`GroupDescriptor`](/blazor-ui/api/Telerik.DataSource.GroupDescriptor) in the [`DataSourceRequest`](/blazor-ui/api/Telerik.DataSource.DataSourceRequest) argument of its [OnRead event]({%slug multiselect-events%}#onread). This will allow the developer to apply grouping with [manual data operations]({%slug components/grid/manual-operations%}).
71-
* `GroupHeaderTemplate` and `GroupItemTemplate` will be introduced in a future version. Currently there is a bug in the Blazor framework that prevents us from supporting them.
72-
* Virtual scrolling with grouping will be supported in a future version.
7371

7472
## See Also
7573

components/scheduler/refresh-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ You can refresh the Scheduler data by using the Rebind method exposed to the ref
135135

136136
## Observable Data
137137

138-
>note The Scheduler will receive this feature in a future release. You can currently refresh its Data by creating a [New collection reference](#new-collection-reference).
138+
>note Refresh the Scheduler data by creating a [New collection reference](#new-collection-reference).
139139
140140
@[template](/_contentTemplates/common/observable-data.md#observable-data)
141141

components/textarea/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The Blazor TextArea provides various parameters to configure the component:
5555
| ----------- | ----------- | ----------- |
5656
| `AutoCapitalize` | `string` | A `string` that maps to the [`autocapitalize`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize) attribute of the HTML element. It's applicable only for touch devices and virtual keyboards. |
5757
| `AutoComplete` | `bool` | Maps to the autocomplete attribute of the HTML `<textarea>`. |
58-
| `AutoSize` | `bool` | Specifies if the TextArea will adjust its height based on the user input. You can [use CSS to limit the resizing up to a max height]({%slug textarea-kb-autosize-max-height%}). This parameter will be deprecated in a future version. Use `ResizeMode` with `Auto` value instead. |
58+
| `AutoSize` <br /> (deprecated) | `bool` | Specifies if the TextArea will adjust its height based on the user input. You can [use CSS to limit the resizing up to a max height]({%slug textarea-kb-autosize-max-height%}). This parameter is deprecated. Use `ResizeMode` with `Auto` value instead. |
5959
| `ResizeMode` | `TextAreaResizeMode?` | Specifies the TextArea's resize behavior. Default behavior is the one set by the browser. |
6060
| `Class` | `string` | The custom CSS class to be rendered on the `<span class="k-textarea">` element. |
6161
| `Cols` | `int?` | Maps to the `cols` attribute of the HTML `<textarea>` element. Do not use together with `Width`.

components/treelist/filter/checkboxlist.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,7 @@ In this sample the Team column lets you filter only by the CEO Team settings, or
176176
{
177177
Data = await GetTreeListData();
178178
179-
// get custom filters data. In a future version you will be able to call these methods
180-
// from the template initialization instead of here so that they fetch data
181-
// only when the user actually needs filter values, instead of always - that could improve server performance
179+
// Get custom filters data.
182180
await GetTeamNameOptions();
183181
}
184182

knowledge-base/animationcontainer-close-on-outside-click.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,11 @@ To achieve the desired scenario:
106106

107107
* If the AnimationContainer is opened as a result of a button click, consider this in the opening and closing logic. The above example uses a `bool` flag for the AnimatioContainer state.
108108
* All Telerik Blazor popup and drop-down components are rendered at the root of the app, and not at the place of declaration. For example, if the AnimationContainer contains a ComboBox, its drop-down will render outside the AnimationContainer. This behavior affects the check in [step 3](#solution) above. To distinguish it, use [another Class for the nested popup]({%slug components/combobox/overview%}#popup-settings).
109-
* The AnimationContainer must reside outside elements with an `overflow` style. Otherwise, it may be clipped or overlapped by other scrollable containers. This limitation will not exist for the [future Popup component](https://feedback.telerik.com/blazor/1506370-dropdown-container-popup-component-tied-to-an-anchor-for-positioning).
109+
* The AnimationContainer must reside outside elements with an `overflow` style. Otherwise, it may be clipped or overlapped by other scrollable containers. This limitation does not exist in the [Popup component]({%slug popup-overview%}).
110110

111111

112112
## See Also
113113

114114
* [AnimationContainer Documentation]({%slug components/animationcontainer/overview%})
115-
* [Telerik UI for Blazor Popup Feature Request Tracking](https://feedback.telerik.com/blazor/1506370-dropdown-container-popup-component-tied-to-an-anchor-for-positioning)
115+
* [Popup Documentation]({%slug popup-overview%})
116+
* [Comparison between All Popup Components]({%slug common-kb-popup-component-comparison%})

knowledge-base/common-animations-decrease.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,4 @@ You can also wrap the custom CSS in a `@media` query to capture users who have c
105105

106106
## Notes
107107

108-
A setting might be exposed at component level for this in the future. You can track its status at [Modify default values of animations](https://feedback.telerik.com/blazor/1469662-way-to-modify-default-values-of-animations-such-as-duration-and-delay-for-a-component-such-as-combobox).
108+
A setting might be exposed at component level for this. Follow the feature request about [setting animation speed on popups](https://feedback.telerik.com/blazor/1586639-set-default-animation-speed-on-popups).

knowledge-base/common-theme-customization-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Generally, there are **four** ways to customize the appearance of the Telerik Bl
5656

5757
To change the sizing and layout of most or all our components, go for manual theme build. For minor adjustments here and there, consider overrides only.
5858

59-
The final decision depends on what and how much you need to customize and what future requirements may appear.
59+
The final decision depends on what and how much you need to customize and what other requirements may appear.
6060

6161
[**Figma UI Kits**](https://www.telerik.com/figma-kits) allow designers to include visual representations of the Telerik components in their application designs. Custom kits still [require you to create a custom theme afterwards]({%slug ui-kits/themes%}#choosing-how-to-use-the-ui-kits).
6262

0 commit comments

Comments
 (0)