Skip to content

Commit

Permalink
Split descriptions in two parts for updated site (#27490)
Browse files Browse the repository at this point in the history
Co-authored-by: Vlada Skorokhodova <[email protected]>
  • Loading branch information
ivanblinov2k17 and vladaskorohodova authored May 30, 2024
1 parent 99c9971 commit d51e5ac
Show file tree
Hide file tree
Showing 538 changed files with 806 additions and 316 deletions.
1 change: 1 addition & 0 deletions apps/demos/Demos/Accordion/Overview/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The Accordion component contains several panels displayed one under another. Users can expand or collapse these panels, which makes this component useful to present information in a limited amount of space.
<--split-->

## Bind Accordion to Data

Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/ActionSheet/Basics/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The ActionSheet component is a pop-up sheet that contains a set of buttons. These buttons allow users to perform custom actions related to a single task (call, send a message, delete, or edit a selected contact). This demo shows how to create a simple ActionSheet and handle button clicks.
<--split-->

## Specify Buttons and Title

Expand Down
3 changes: 2 additions & 1 deletion apps/demos/Demos/ActionSheet/PopoverMode/description.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
ActionSheet can appear at the bottom of the page or over a certain element. Enable the [usePopover](/Documentation/ApiReference/UI_Components/dxActionSheet/Configuration/#usePopover) property to display ActionSheet over a certain element on the page and use the [target](/Documentation/ApiReference/UI_Components/dxActionSheet/Configuration/#target) property to specify this element. In this demo, ActionSheet is integrated with the List component and appears when you click a list item.
ActionSheet can appear at the bottom of the page or over a certain element. Enable the [usePopover](/Documentation/ApiReference/UI_Components/dxActionSheet/Configuration/#usePopover) property to display ActionSheet over a certain element on the page and use the [target](/Documentation/ApiReference/UI_Components/dxActionSheet/Configuration/#target) property to specify this element. In this demo, ActionSheet is integrated with the List component and appears when you click a list item.
<--split-->
1 change: 1 addition & 0 deletions apps/demos/Demos/Autocomplete/Overview/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Autocomplete is a text box that displays suggestions while a user types. This demo shows how to customize the Autocomplete component and handle value changes.
<--split-->

## Bind Autocomplete to Data

Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/Box/Overview/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The Box component allows you to create layouts of any complexity. You can arrange multiple blocks (items) horizontally or vertically, specify relative or absolute block sizes, and nest layouts within each other.
<--split-->

Set the Box's [width](/Documentation/ApiReference/UI_Components/dxBox/Configuration/#width) and [height](/Documentation/ApiReference/UI_Components/dxBox/Configuration/#height) properties to specify the layout's overall dimensions. To add blocks, use the [items](/Documentation/ApiReference/UI_Components/dxBox/Configuration/items/) array, the [dataSource](/Documentation/ApiReference/UI_Components/dxBox/Configuration/#dataSource) property, or specify dxItems in the markup.

Expand Down
3 changes: 2 additions & 1 deletion apps/demos/Demos/Button/Icons/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
To add an icon to a Button, set the **icon** property. This demo shows how you can use this property:
To add an icon to a Button, set the **icon** property. This demo shows how you can use this property.
<--split-->

- **Built-in icons**
DevExtreme ships with its own [icon library](/Documentation/Guide/Themes_and_Styles/Icons/#Built-In_Icon_Library). Pick any icon and assign its name to the **icon** property.
Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/Button/PredefinedTypes/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The Button component supports several predefined color schemes. To apply a schem
- *"success"*
- *"default"*
- *"danger"*
<--split-->

To further customize the Button, use the [stylingMode](/Documentation/ApiReference/UI_Widgets/dxButton/Configuration/#stylingMode) property. This property affects the fill and borders, and accepts the following values:

Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/ButtonGroup/Overview/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ ButtonGroup displays a set of two-state buttons and allows users to select one o
- Enable or disable multiple selection.

- Customize the ButtonGroup appearance.
<--split-->

## Bind ButtonGroup to Data

Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/Calendar/MultipleSelection/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
This demo applies different selection modes and date availability options to the Calendar component.
<--split-->

## Selection Modes

Expand Down
45 changes: 0 additions & 45 deletions apps/demos/Demos/Calendar/Overview/Angular/description.md

This file was deleted.

45 changes: 0 additions & 45 deletions apps/demos/Demos/Calendar/Overview/Vue/description.md

This file was deleted.

5 changes: 3 additions & 2 deletions apps/demos/Demos/Calendar/Overview/description.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
This demo shows how to use additional properties to customize your Calendar. You can toggle the checkboxes on the right to change the Calendar in real time.
<--split-->

When you add a Calendar to an application, you need to specify its [value](/Documentation/ApiReference/UI_Components/dxCalendar/Configuration/#value) in one of the following formats:

- Date
Expand All @@ -17,8 +20,6 @@ Specifies the date with a string value. The UI component supports the following
- Array of the formats mentioned before
Available only for *'multiple'* and *'range'* [selection modes](/Documentation/ApiReference/UI_Components/dxCalendar/Configuration/#selectionMode). The array includes all selected dates.

This demo shows how to use additional properties to customize your Calendar. You can toggle the checkboxes on the right to change the Calendar in real time.

## Specify First Day of Week and Display Week Numbers

To specify the first day of the week, assign its index (0 - for Sunday, 1 - for Monday, and so on) to the [firstDayOfWeek](/Documentation/ApiReference/UI_Components/dxCalendar/Configuration/#firstDayOfWeek) property. You can also display a column with week numbers. For this, enable the [showWeekNumbers](/Documentation/ApiReference/UI_Components/dxCalendar/Configuration/#showWeekNumbers) property.
Expand Down
3 changes: 2 additions & 1 deletion apps/demos/Demos/Charts/APIDisplayATooltip/description.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
This demo illustrates how to&nbsp;show and hide the point&rsquo;s tooltip with the API. To&nbsp;test this feature, select a&nbsp;continent from the drop-down menu under the PieChart or&nbsp;click a&nbsp;point directly in&nbsp;the PieChart.
This demo illustrates how to&nbsp;show and hide the point&rsquo;s tooltip with the API. To&nbsp;test this feature, select a&nbsp;continent from the drop-down menu under the PieChart or&nbsp;click a&nbsp;point directly in&nbsp;the PieChart.
<--split-->
3 changes: 2 additions & 1 deletion apps/demos/Demos/Charts/APISelectAPoint/description.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
This demo shows how easily you can access a&nbsp;necessary chart series and select a&nbsp;specific point in&nbsp;it&nbsp;using the API.
This demo shows how easily you can access a&nbsp;necessary chart series and select a&nbsp;specific point in&nbsp;it&nbsp;using the API.
<--split-->
1 change: 1 addition & 0 deletions apps/demos/Demos/Charts/AjaxRequest/description.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
If your server stores data in JSON format, you do not need to make AJAX requests to get the data. Instead, assign the URL of your data storage to the Chart's [dataSource](/Documentation/ApiReference/UI_Components/dxChart/Configuration/#dataSource) property. To configure how the component displays data, specify the [series](Documentation/ApiReference/UI_Components/dxChart/Configuration/series/) type and its nested options: [argumentField](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#argumentField) and [valueField](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#valueField), so the component can determine the object fields that indicate Chart arguments and values in JSON.
<--split-->

Note that you can also use a JSONP callback parameter supported by <a href="http://api.jquery.com/jQuery.ajax/" target="_blank">jQuery.ajax()</a> in the [dataSource](/Documentation/ApiReference/UI_Components/dxChart/Configuration/#dataSource).
1 change: 1 addition & 0 deletions apps/demos/Demos/Charts/Annotation/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Annotations are containers for images, text blocks, and custom content that display additional information about the visualized data.
<--split-->

To create annotations, populate the Chart's [annotations](/Documentation/ApiReference/UI_Components/dxChart/Configuration/annotations/) array. Each object in the array configures an individual annotation. To specify properties for all annotations, use the [commonAnnotationSettings](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonAnnotationSettings/) object. Individual settings take precedence over common settings.

Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/Charts/Area/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
This demo shows different Area [series types](/Documentation/ApiReference/UI_Components/dxChart/Configuration/series/#type). Use the drop-down editor below the Chart to select the type.
<--split-->

- *area*
The Area series draws the line between neighboring data points and fills the area under that line. If the Chart contains multiple area series, they overlap each other.
Expand Down
3 changes: 2 additions & 1 deletion apps/demos/Demos/Charts/AreaSparklines/description.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
In&nbsp;this demo, a&nbsp;set of&nbsp;area-like sparklines is&nbsp;placed into a&nbsp;table. Although these sparklines look similar, they have different series types. The first table column contains sparklines of&nbsp;the _area_ series type. In&nbsp;the second table column, _spline area_ sparklines are placed. The third table column displays sparklines of&nbsp;the _step area_ series type.
In&nbsp;this demo, a&nbsp;set of&nbsp;area-like sparklines is&nbsp;placed into a&nbsp;table. Although these sparklines look similar, they have different series types. The first table column contains sparklines of&nbsp;the _area_ series type. In&nbsp;the second table column, _spline area_ sparklines are placed. The third table column displays sparklines of&nbsp;the _step area_ series type.
<--split-->
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
This demo illustrates a common issue in multi-series charts. Individual [series](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/BarSeries/) can skip values for certain arguments or include zero values. In such cases, arguments can display a different number of bars and cause uneven gaps between data.
<--split-->

The [ignoreEmptyPoints](/Documentation/ApiReference/UI_Components/dxChart/Series_Types/BarSeries/#ignoreEmptyPoints) property allows you to change this behavior. If you set it to **true**, bars increase their width to fill the gaps. In this demo, you can see how the property affects the following arguments: `Iran`, `Canada`, `Saudi Arabia`, and `Mexico`.
1 change: 1 addition & 0 deletions apps/demos/Demos/Charts/AxisCustomPosition/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
The Chart component initially displays axes along pane borders. Several other predefined axis layout properties are available. In this demo, the [customPosition](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/#customPosition) property is used to move each axis, so that it is displayed on the specified value of another axis. When you position the [argument axis](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/), use values from the [value axis](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/) (in the same type and format) and vice versa.
<--split-->

Regardless of which automatic axis layout type you use, the Chart Control allows you to apply manual offsets. Specify the [offset](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/#offset) property in pixels to keep the axis position unchanged when users scroll or zoom the Chart data. The **offset** property shifts the axis from the specified position as follows:

Expand Down
5 changes: 4 additions & 1 deletion apps/demos/Demos/Charts/AxisLabelsOverlapping/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
In this demo, argument axis labels overlap due to their length. To specify the overlapping behavior, you can use one of the following [label](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/label/).[overlappingBehavior](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/label/#overlappingBehavior) modes:
In this demo, argument axis labels overlap due to their length.
<--split-->

To specify the overlapping behavior, you can use one of the following [label](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/label/).[overlappingBehavior](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/label/#overlappingBehavior) modes:

- `none`
Leaves axis labels overlapped.
Expand Down
1 change: 1 addition & 0 deletions apps/demos/Demos/Charts/AxisLabelsTemplates/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Axis labels display values for [major axis ticks](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonAxisSettings/tick/).
<--split-->

To configure labels for individual axes, specify label settings in the **valueAxis**.[label](/Documentation/ApiReference/UI_Components/dxChart/Configuration/valueAxis/label/) and **argumentAxis**.[label](/Documentation/ApiReference/UI_Components/dxChart/Configuration/argumentAxis/label/) objects. To configure labels for all axes, use the **commonAxisSettings**.[label](/Documentation/ApiReference/UI_Components/dxChart/Configuration/commonAxisSettings/label/) object. Individual settings take precedence over common settings.

Expand Down
3 changes: 2 additions & 1 deletion apps/demos/Demos/Charts/BarSparklines/description.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
This demo illustrates the sparklines of&nbsp;the _bar_ type. A&nbsp;number of&nbsp;properties for each sparkline is&nbsp;changed. Most of&nbsp;these properties define the appearance of&nbsp;specific sparkline elements. Note that in&nbsp;this demo, the Sparkline component obtains data using the **DataSource** object. You can change filtering conditions for the data using the drop-down menu under the table.
This demo illustrates the sparklines of&nbsp;the _bar_ type. A&nbsp;number of&nbsp;properties for each sparkline is&nbsp;changed. Most of&nbsp;these properties define the appearance of&nbsp;specific sparkline elements. Note that in&nbsp;this demo, the Sparkline component obtains data using the **DataSource** object. You can change filtering conditions for the data using the drop-down menu under the table.
<--split-->
3 changes: 2 additions & 1 deletion apps/demos/Demos/Charts/BiDirectionalBarChart/description.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
To create a bi-directional bar chart, follow the steps below:
To create a bi-directional bar chart, follow the steps below.
<--split-->

1. Convert half of the data source values from positive to negative. In this demo, the `male` percentages are negative, while the `female` are positive.

Expand Down
Loading

0 comments on commit d51e5ac

Please sign in to comment.