Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Migrate to simpler slug syntax #2757

Merged
merged 1 commit into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 5 additions & 5 deletions _contentTemplates/chart/chart-tooltip-context-templates.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
#context-parameter-information
* `FormattedValue` - maps to the default rendering of the tooltip, formatted as a string.
* Use this when the chart's data is bound by [Independent Series Binding](slug://components/chart/databind#independent-series-binding). You can parse this to a numerical value (`int`, `double`, etc.) in order to apply formatting. Otherwise, use the `DataItem` to get the value of the point.
* Use this when the chart's data is bound by [Independent Series Binding](slug:components/chart/databind#independent-series-binding). You can parse this to a numerical value (`int`, `double`, etc.) in order to apply formatting. Otherwise, use the `DataItem` to get the value of the point.

* `DataItem` - provides the data model of the current series item. You need to cast it to the type from your datasource, which needs to be serializable.

* If you are using a [Date Axis](slug://components/chart/date-axis), the `DataItem` will contain the only the aggregated value in the corresponding y-value field, because it is a collection of more than one items. See the `Category` below for details.
* If you are using a [Date Axis](slug:components/chart/date-axis), the `DataItem` will contain the only the aggregated value in the corresponding y-value field, because it is a collection of more than one items. See the `Category` below for details.

* `Category` - provides information on the category the data point is located in. You need to cast it to the type in your data source, for example `DateTime`, `string`, `int` or another type. The `Category` parameter is applicable to [Categorical Charts](slug://components/chart/databind#series-types).
* `Category` - provides information on the category the data point is located in. You need to cast it to the type in your data source, for example `DateTime`, `string`, `int` or another type. The `Category` parameter is applicable to [Categorical Charts](slug:components/chart/databind#series-types).

* When using a [Date Axis](slug://components/chart/date-axis), you can use it, together with the `BaseUnit` value of the axis, to filter the data source and obtain the actual data items from the data source in case you want to provide extra information about them.
* When using a [Date Axis](slug:components/chart/date-axis), you can use it, together with the `BaseUnit` value of the axis, to filter the data source and obtain the actual data items from the data source in case you want to provide extra information about them.

* `Percentage` - applicable to [Donut](slug://components/chart/types/donut), [Pie](slug://components/chart/types/pie) and [Stacked 100%](slug://components/chart/stack#stack-100) Charts - the percentage value of the current data point from the whole.
* `Percentage` - applicable to [Donut](slug:components/chart/types/donut), [Pie](slug:components/chart/types/pie) and [Stacked 100%](slug:components/chart/stack#stack-100) Charts - the percentage value of the current data point from the whole.

* `SeriesIndex` - provides the index of the `<ChartSeries>` the data point belongs to.

Expand Down
12 changes: 6 additions & 6 deletions _contentTemplates/chart/link-to-basics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#understand-basics-and-databinding-first
This article assumes you are familiar with the [chart basics](slug://components/chart/overview) and [data binding](slug://components/chart/databind).
This article assumes you are familiar with the [chart basics](slug:components/chart/overview) and [data binding](slug:components/chart/databind).
#end

#color-field-bar-column
Expand Down Expand Up @@ -109,9 +109,9 @@ You can render the lines between the points with different styles. The supported

* `Normal`—This is the default style. It produces a straight line between data points.

* `Step`—The style renders the connection between data points through vertical and horizontal lines. It is suitable for indicating that the value is constant between the changes. Supported for [categorical](slug://components/chart/databind#series-types) types of [Line](slug://components/chart/types/line) charts only, but not for scatter charts.
* `Step`—The style renders the connection between data points through vertical and horizontal lines. It is suitable for indicating that the value is constant between the changes. Supported for [categorical](slug:components/chart/databind#series-types) types of [Line](slug:components/chart/types/line) charts only, but not for scatter charts.

* `Smooth`—This style causes the Chart to display a fitted curve through data points. It is suitable when the data requires to be displayed with a curve, or when you wish to connect the points with smooth instead of straight lines. Not supported with [stacked](slug://components/chart/stack) series with missing values.
* `Smooth`—This style causes the Chart to display a fitted curve through data points. It is suitable when the data requires to be displayed with a curve, or when you wish to connect the points with smooth instead of straight lines. Not supported with [stacked](slug:components/chart/stack) series with missing values.

#end

Expand Down Expand Up @@ -150,7 +150,7 @@ When configuring nested properties and child elements in your chart, the inner t

#configurable-nested-chart-settings-categorical

An example of this is the rotation the Labels of a [categorical](slug://components/chart/databind#series-types) chart. You can use the
An example of this is the rotation the Labels of a [categorical](slug:components/chart/databind#series-types) chart. You can use the

`ChartCategoryAxes` > `ChartCategoryAxis` > `ChartCategoryAxisLabels` > `ChartCategoryAxisLabelsRotation` tag

Expand All @@ -162,7 +162,7 @@ This approach is not limited only to the Labels - it can be used with all tags t

#configurable-nested-chart-settings-numerical

For example, for [numerical](slug://components/chart/databind#series-types) charts you can rotate the Labels for `ChartXAxes` or `ChartYAxes` depending on your application design needs and layout. This can be done through the
For example, for [numerical](slug:components/chart/databind#series-types) charts you can rotate the Labels for `ChartXAxes` or `ChartYAxes` depending on your application design needs and layout. This can be done through the

`ChartXAxes` > `ChartXAxis` > `ChartXAxisLabelsRotation` tag

Expand All @@ -174,7 +174,7 @@ This approach is not limited only to the Labels - it can be used with to all tag

#configurable-nested-chart-settings-axis-free

For example, for [axis-free](slug://components/chart/databind#series-types) charts you can rotate their Labels, Title, Legend and others. Example for doing so is customizing the Chart Series Labels by using the parameters in the
For example, for [axis-free](slug:components/chart/databind#series-types) charts you can rotate their Labels, Title, Legend and others. Example for doing so is customizing the Chart Series Labels by using the parameters in the

`ChartSeriesItems` > `ChartSeries` > `ChartSeriesLabels` tag and its child tags.

Expand Down
2 changes: 1 addition & 1 deletion _contentTemplates/common/click-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The `OnRowContextMenu` event fires when the user:
* Right-clicks or taps-and-holds a data row;
* Hits the context menu keyboard button while the row has focus. This scenario requires enabled keyboard navigation (`Navigable="true"`).

Use `OnRowContextMenu` to [integrate the Context menu](slug://contextmenu-integration#context-menu-for-a-grid-row) with the table rows.
Use `OnRowContextMenu` to [integrate the Context menu](slug:contextmenu-integration#context-menu-for-a-grid-row) with the table rows.

#end

Expand Down
2 changes: 1 addition & 1 deletion _contentTemplates/common/dropdowns-virtualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section will explain the parameters and behaviors that are related to the v
>caption To enable UI virtualization, you need to set the following parameters of the component:

* `ScrollMode` - `Telerik.Blazor.DropDownScrollMode` - set it to `DropDownScrollMode.Virtual`. It defaults to the "regular" scrolling.
* `Height` - `string` - [set the height](slug://common-features/dimensions) in the nested **popup settings** tag of the component. It must **not** be a `null/empty` string.
* `Height` - `string` - [set the height](slug:common-features/dimensions) in the nested **popup settings** tag of the component. It must **not** be a `null/empty` string.
* `ItemHeight` - `decimal` - set it to the height each individual item will have in the dropdown. Make sure to accommodate the content your items will have and any item template.
* `PageSize` - `int` - defines how many items will actually be rendered and reused. The value determines how many items are loaded on each scroll. The number of items must be large enough according to the `ItemHeight` and popup `Height`, so that there are more items than the dropdown so there is a scrollbar.

Expand Down
8 changes: 4 additions & 4 deletions _contentTemplates/common/filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

| Parameter | Type and Default Value | Description |
| --- | --- | --- |
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator in the column it is declared for. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type. Check the supported options in the [Filter Operators](slug://common-features-filter-operators) article.
| `FilterOperators` | `List<FilterListOperator>` | Specifies the available operators. Must contain only [supported filter operators](slug://common-features-filter-operators) for the specific data type. If not defined, the component will use a default list of available operators based on the field type.
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator in the column it is declared for. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type. Check the supported options in the [Filter Operators](slug:common-features-filter-operators) article.
| `FilterOperators` | `List<FilterListOperator>` | Specifies the available operators. Must contain only [supported filter operators](slug:common-features-filter-operators) for the specific data type. If not defined, the component will use a default list of available operators based on the field type.
| `ShowFilterCellButtons` | `bool` <br/> (`true`) | controls the visibility of the filter buttons
#end

Expand All @@ -15,8 +15,8 @@

| Parameter | Type and Default Value | Description
| ----------- | ----------- | -----------|
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator in the column it is declared for. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type Check the supported options in the [Filter Operators](slug://common-features-filter-operators) article. The provided default filter operator will be applied for both filters in the menu.
| `FilterOperators` | `List<FilterListOperator>` | Specifies the available operators. Must contain only [supported filter operators](slug://common-features-filter-operators) for the specific data type. If not defined, the component will use a default list of available operators based on the field type.
| `DefaultFilterOperator` | `FilterOperator` | Sets the default filter operator in the column it is declared for. Accepts a member of the `FilterOperator` enum. The selected operator must be applicable for the specific data type Check the supported options in the [Filter Operators](slug:common-features-filter-operators) article. The provided default filter operator will be applied for both filters in the menu.
| `FilterOperators` | `List<FilterListOperator>` | Specifies the available operators. Must contain only [supported filter operators](slug:common-features-filter-operators) for the specific data type. If not defined, the component will use a default list of available operators based on the field type.
#end

#filter-debounce-delay-customization
Expand Down
2 changes: 1 addition & 1 deletion _contentTemplates/common/form-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ The Telerik Blazor validation tools let you match the style of your validation m
#end

#note-editcontext-formitem-template
> When using the [Form `EditContext` parameter](slug://form-overview#creating-blazor-form) together with [validation components](slug://validation-tools-overview) or [Form item `<Template>`s](slug://form-formitems-template), make sure to create the `EditContext` from the model instance, which is used by the validation components and inside the Form item templates. Otherwise, the Form will not update the correct object instance and validation will not work as expected.
> When using the [Form `EditContext` parameter](slug:form-overview#creating-blazor-form) together with [validation components](slug:validation-tools-overview) or [Form item `<Template>`s](slug:form-formitems-template), make sure to create the `EditContext` from the model instance, which is used by the validation components and inside the Form item templates. Otherwise, the Form will not update the correct object instance and validation will not work as expected.
#end
Loading
Loading