Skip to content
This repository was archived by the owner on Nov 17, 2022. It is now read-only.

Commit 4860f15

Browse files
authored
Merge pull request #1584 from NativeScript/tgpetrov/pro-ui-enums-update
style: pro ui enums usage update
2 parents feaf501 + eb6bb75 commit 4860f15

File tree

83 files changed

+663
-622
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+663
-622
lines changed

docs/ui/professional-ui-components/AutoCompleteTextView/autocomplete-completion-modes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ publish: true
1212

1313
**RadAutoCompleteTextView** has two modes for filtering suggestions.
1414

15-
- {% typedoc_link enums:CompletionMode,member:StartsWith %}
16-
- {% typedoc_link enums:CompletionMode,member:Contains %}
15+
- {% typedoc_link enums:AutoCompleteCompletionMode,member:StartsWith %}
16+
- {% typedoc_link enums:AutoCompleteCompletionMode,member:Contains %}
1717

18-
The completion mode can be changed with the `completionMode` property of the RadAutoCompleteTextView. The default value is `StartsWith`.
18+
The completion mode can be changed with the {% typedoc_link classes:RadAutoCompleteTextView,member:completionMode %} property of the RadAutoCompleteTextView. The default value is {% typedoc_link enums:AutoCompleteCompletionMode,member:StartsWith %}.
1919

2020
<snippet id='autocomplete-completion-mode'/>
2121

@@ -24,9 +24,9 @@ The completion mode can be changed with the `completionMode` property of the Rad
2424
In `StartsWith` mode the autocomplete shows only suggestions that start with the typed phrase.
2525

2626
## Contains Mode
27-
In `Contains` mode the autocomplete shows only suggestions that contain the typed phrase.
28-
`Contains` mode is not intended to work with the `Append` and `SuggestAppend` modes.
29-
Since both these modes append the rest of the suggestion to the typed text, the combination between them and `Contains` won't be helpful but rather confusing.
27+
In `Contains` mode the autocomplete shows the suggestions that contain the typed phrase, but not necessarily in the beginning.
28+
The completion mode `Contains` is not intended to work with the `Append` and `SuggestAppend` suggest modes.
29+
Since these suggest modes append the rest of the suggestion to the typed text, the combination between them and `Contains` won't be helpful but rather confusing.
3030

3131
## References
3232
Want to see more examples using **RadAutoCompleteTextView**?
@@ -37,4 +37,4 @@ Check our SDK examples repository on GitHub. You will find this and a lot more p
3737
Related articles you might find useful:
3838

3939
* [**Display Modes**]({% slug autocomplete-display-modes %})
40-
* [**Suggest Modes**]({% slug autocomplete-suggest-modes %})
40+
* [**Suggest Modes**]({% slug autocomplete-suggest-modes %})

docs/ui/professional-ui-components/AutoCompleteTextView/autocomplete-display-modes.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,34 @@ publish: true
1212

1313
**RadAutoCompleteTextView** has two predefined display modes.
1414

15-
- {% typedoc_link enums:DisplayMode,member:Plain %}
16-
- {% typedoc_link enums:DisplayMode,member:Tokens %}
15+
- {% typedoc_link enums:AutoCompleteDisplayMode,member:Plain %}
16+
- {% typedoc_link enums:AutoCompleteDisplayMode,member:Tokens %}
1717

18-
Display mode can be changed with the `displayMode` property of the **RadAutoCompleteTextView**. The default value is `Plain`.
18+
Display mode can be changed with the {% typedoc_link classes:RadAutoCompleteTextView,member:displayMode %} property of the **RadAutoCompleteTextView**. The default value is {% typedoc_link enums:AutoCompleteDisplayMode,member:Plain %}.
1919

2020
<snippet id='autocomplete-display-mode'/>
2121

2222
## Plain Mode
23-
In plain mode **RadAutoCompleteTextView** displays chosen item as plain text. When this mode only one item can be chosen.
23+
In plain mode **RadAutoCompleteTextView** displays chosen item as plain text. With this mode only one item can be chosen.
2424

2525
## Tokens Mode
2626
Tokens mode allows multiple choice of items. Chosen items are displayed as tokens which can be modified or completely changed with custom ones.
2727

28-
When **RadAutoCompleteTextView** is working in DisplayMode.Tokens mode, you can apply two different behaviors for token arrangement.
28+
When **RadAutoCompleteTextView**'s `displayMode` is `Tokens`, you can apply two different behaviors for token arrangement.
2929

30-
- {% typedoc_link enums:LayoutMode,member:Horizontal %}
31-
- {% typedoc_link enums:LayoutMode,member:Wrap %}
30+
- {% typedoc_link enums:AutoCompleteLayoutMode,member:Horizontal %}
31+
- {% typedoc_link enums:AutoCompleteLayoutMode,member:Wrap %}
3232

33-
The layout mode of the tokens can be changed with the `layoutMode` property of the **RadAutoCompleteTextView**.
34-
The default value is `Wrap`.
33+
The layout mode of the tokens can be changed with the {% typedoc_link enums:RadAutoCompleteTextView,member:layoutMode %} property.
34+
The default value of this property is {% typedoc_link enums:AutoCompleteLayoutMode,member:Wrap %}.
3535

3636
<snippet id='autocomplete-layout-mode'/>
3737

3838
## Wrap Layout
3939
In wrap mode tokens are arranged on multiple lines. Every time a new line is started the **RadAutoCompleteTextView** is expanding in order to show all tokens.
4040

4141
## Horizontal Layout
42-
In horizontal layout tokens are displayed on single line which can be scrolled horizontally in order to display all tokens.
42+
In horizontal mode tokens are displayed on single line which can be scrolled horizontally in order to display all tokens.
4343

4444
## References
4545
Want to see more examples using **RadAutoCompleteTextView**?
@@ -50,4 +50,4 @@ Check our SDK examples repository on GitHub. You will find this and a lot more p
5050
Related articles you might find useful:
5151

5252
* [**Completion Modes**]({% slug autocomplete-completion-modes %})
53-
* [**Suggest Modes**]({% slug autocomplete-suggest-modes %})
53+
* [**Suggest Modes**]({% slug autocomplete-suggest-modes %})

docs/ui/professional-ui-components/AutoCompleteTextView/autocomplete-suggest-modes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ publish: true
1212

1313
**RadAutoCompleteTextView** has three different modes for providing suggestions.
1414

15-
- {% typedoc_link enums:SuggestMode,member:Suggest %}
16-
- {% typedoc_link enums:SuggestMode,member:Append %}
17-
- {% typedoc_link enums:SuggestMode,member:SuggestAppend %}
15+
- {% typedoc_link enums:AutoCompleteSuggestMode,member:Suggest %}
16+
- {% typedoc_link enums:AutoCompleteSuggestMode,member:Append %}
17+
- {% typedoc_link enums:AutoCompleteSuggestMode,member:SuggestAppend %}
1818

19-
The suggest mode can be changed with the `suggestionMode` property of the TKAutoCompleteTextView. The default value is `Suggest`.
19+
The suggest mode can be changed with the {% typedoc_link classes:RadAutoCompleteTextView,member:suggestionMode %} property of the RadAutoCompleteTextView. The default value is {% typedoc_link enums:AutoCompleteSuggestMode,member:Suggest %}.
2020

2121
<snippet id='autocomplete-suggest-mode'/>
2222

@@ -39,4 +39,4 @@ Check our SDK examples repository on GitHub. You will find this and a lot more p
3939
Related articles you might find useful:
4040

4141
* [**Display Modes**]({% slug autocomplete-display-modes %})
42-
* [**Completion Modes**]({% slug autocomplete-completion-modes %})
42+
* [**Completion Modes**]({% slug autocomplete-completion-modes %})

docs/ui/professional-ui-components/Calendar/Styling/month-view.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ There are some properties that change the month view :
2020
- `showTitle` - determines if title should be shown
2121
- `showWeekNumbers` - determines if week numbers should be shown
2222
- `showDayNames` - determines if day names should be shown
23-
- {% typedoc_link classes:CalendarMonthViewStyle,member:selectionShape %} - defines the decoration shape drawn in the center of a selected cell within the month view. Accepts values from the {% typedoc_link modules:SelectionShape %} module
24-
- {% typedoc_link classes:CalendarMonthViewStyle,member:selectionShapeSize %} - defines the size of the decoration shape drawn in the center of a selected cell within the month view. In case the shape is {% typedoc_link modules:SelectionShape,member:Square %} the property determines the side of the square draw. If the shape is {% typedoc_link modules:SelectionShape,member:Round %} the size determines the radius of the circle drawn
23+
- {% typedoc_link classes:CalendarMonthViewStyle,member:selectionShape %} - defines the decoration shape drawn in the center of a selected cell within the month view. Accepts values from the {% typedoc_link enums:CalendarSelectionShape %} enumeration
24+
- {% typedoc_link classes:CalendarMonthViewStyle,member:selectionShapeSize %} - defines the size of the decoration shape drawn in the center of a selected cell within the month view. In case the shape is {% typedoc_link enums:CalendarSelectionShape,member:Square %} the property determines the side of the square draw. If the shape is {% typedoc_link enums:CalendarSelectionShape,member:Round %} the size determines the radius of the circle drawn
2525
- {% typedoc_link classes:CalendarMonthViewStyle,member:selectionShapeColor %} - determines the color of the selection shape
2626

2727
In order to style any type of the available cell in calendar you need to initialize the corresponding style property of `CalendarMonthViewStyle` class, that is used for this view mode:

docs/ui/professional-ui-components/Calendar/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ publish: true
2121
### View modes
2222
{% typedoc_link classes:RadCalendar %} supports four different view modes that are suitable for different application scenarios:
2323

24-
- {% typedoc_link modules:CalendarViewMode,member:Week %} - displays the dates within one week
25-
- {% typedoc_link modules:CalendarViewMode,member:Month %} - displays the dates within one month
26-
- {% typedoc_link modules:CalendarViewMode,member:MonthNames %} - displays the months within a year
27-
- {% typedoc_link modules:CalendarViewMode,member:Year %} - displays a whole year
28-
- {% typedoc_link modules:CalendarViewMode,member:Day %} - displays a timeline for a day with its events
24+
- {% typedoc_link enums:CalendarViewMode,member:Week %} - displays the dates within one week
25+
- {% typedoc_link enums:CalendarViewMode,member:Month %} - displays the dates within one month
26+
- {% typedoc_link enums:CalendarViewMode,member:MonthNames %} - displays the months within a year
27+
- {% typedoc_link enums:CalendarViewMode,member:Year %} - displays a whole year
28+
- {% typedoc_link enums:CalendarViewMode,member:Day %} - displays a timeline for a day with its events
2929

3030
For more information about View Modes take a look at the dedicated article: [Calendar view modes]({% slug calendar-view-modes %} "Read more about view modes of RadCalendar").
3131

docs/ui/professional-ui-components/Calendar/populating-with-data.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ Running the application, the following is shown on iOS and Android:
4141
## Event View Modes
4242
By default, events for each date cell are shown as dots (iOS) or squares with a summary (Android). You can customize this behavior by choosing one of the following event view modes:
4343

44-
- {% typedoc_link modules:CalendarEventsViewMode,member:None %} - the default option
45-
- {% typedoc_link modules:CalendarEventsViewMode,member:Inline %} - event details are displayed in a list that appears in the calendar
46-
- {% typedoc_link modules:CalendarEventsViewMode,member:Popover %} - event details are displayed in a popup over the calendar
44+
- {% typedoc_link enums:CalendarEventsViewMode,member:None %} - the default option
45+
- {% typedoc_link enums:CalendarEventsViewMode,member:Inline %} - event details are displayed in a list that appears in the calendar
46+
- {% typedoc_link enums:CalendarEventsViewMode,member:Popover %} - event details are displayed in a popup over the calendar
4747

4848
> All of these values are exposed by the {% typedoc_link enums:CalendarEventsViewMode %} enum defined in the calendar module.
4949

docs/ui/professional-ui-components/Calendar/selection-modes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ publish: true
1111
# RadCalendar Selection Modes
1212
{% typedoc_link classes:RadCalendar %} supports the following selection modes exposed by the {% typedoc_link enums:CalendarSelectionMode %} enum:
1313

14-
- {% typedoc_link modules:CalendarViewMode,member:None %} - disables the selection in {% typedoc_link classes:RadCalendar %}
15-
- {% typedoc_link modules:CalendarViewMode,member:Single %} - allows selection of single date
16-
- {% typedoc_link modules:CalendarViewMode,member:Multiple %} - allows selection of several dates
17-
- {% typedoc_link modules:CalendarViewMode,member:Range %} - allows selection of a date range
14+
- {% typedoc_link enums:CalendarSelectionMode,member:None %} - disables the selection in {% typedoc_link classes:RadCalendar %}
15+
- {% typedoc_link enums:CalendarSelectionMode,member:Single %} - allows selection of single date
16+
- {% typedoc_link enums:CalendarSelectionMode,member:Multiple %} - allows selection of several dates
17+
- {% typedoc_link enums:CalendarSelectionMode,member:Range %} - allows selection of a date range
1818

1919
To change the selection mode of {% typedoc_link classes:RadCalendar %} you should use the {% typedoc_link classes:RadCalendar,member:selectionMode %} property and set it to one of the aforementioned values.
2020

docs/ui/professional-ui-components/Calendar/transition-modes.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ publish: true
1212
- {% typedoc_link classes:RadCalendar %} supports different animations when switching between months, weeks or years. These are also called *transitions*. Defining a transition is done by setting the - {% typedoc_link classes:RadCalendar,member:transitionMode %} property to one of the values enlisted by the `CalendarTransitionModes` enum.
1313

1414
## Available Transition Modes
15-
- {% typedoc_link modules:CalendarTransitionMode,member:None %} - Transitions with gestures are disabled and no animation is applied when transitioning programmatically. Available in iOS and Android.
16-
- {% typedoc_link modules:CalendarTransitionMode,member:Slide %} - Slide animation is applied when transitioning between views in *RadCalendar*. Available in iOS and Android.
17-
- {% typedoc_link modules:CalendarTransitionMode,member:Stack %} - Stack animation is applied when transitioning between views in *RadCalendar*. Available in iOS and Android.
18-
- {% typedoc_link modules:CalendarTransitionMode,member:Flip %} - Flip animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
19-
- {% typedoc_link modules:CalendarTransitionMode,member:Fold %} - Fold animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
20-
- {% typedoc_link modules:CalendarTransitionMode,member:Float %} - Float animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
21-
- {% typedoc_link modules:CalendarTransitionMode,member:Rotate %} - Rotate animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
22-
- {% typedoc_link modules:CalendarTransitionMode,member:Plain %} - Allows non inertial scrolling between views in *RadCalendar*. Available only in Android.
23-
- {% typedoc_link modules:CalendarTransitionMode,member:Free %} - Allows inertial scrolling between views in *RadCalendar*. Available only in Android.
24-
- {% typedoc_link modules:CalendarTransitionMode,member:Combo %} - Applies inertial slide animation when transitioning between views in *RadCalendar*. Available only in Android.
25-
- {% typedoc_link modules:CalendarTransitionMode,member:Overlap %} - Views overlap when transitioning in *RadCalendar*. Available only in Android.
15+
- {% typedoc_link enums:CalendarTransitionMode,member:None %} - Transitions with gestures are disabled and no animation is applied when transitioning programmatically. Available in iOS and Android.
16+
- {% typedoc_link enums:CalendarTransitionMode,member:Slide %} - Slide animation is applied when transitioning between views in *RadCalendar*. Available in iOS and Android.
17+
- {% typedoc_link enums:CalendarTransitionMode,member:Stack %} - Stack animation is applied when transitioning between views in *RadCalendar*. Available in iOS and Android.
18+
- {% typedoc_link enums:CalendarTransitionMode,member:Flip %} - Flip animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
19+
- {% typedoc_link enums:CalendarTransitionMode,member:Fold %} - Fold animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
20+
- {% typedoc_link enums:CalendarTransitionMode,member:Float %} - Float animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
21+
- {% typedoc_link enums:CalendarTransitionMode,member:Rotate %} - Rotate animation is applied when transitioning between views in *RadCalendar*. Available only in iOS.
22+
- {% typedoc_link enums:CalendarTransitionMode,member:Plain %} - Allows non inertial scrolling between views in *RadCalendar*. Available only in Android.
23+
- {% typedoc_link enums:CalendarTransitionMode,member:Free %} - Allows inertial scrolling between views in *RadCalendar*. Available only in Android.
24+
- {% typedoc_link enums:CalendarTransitionMode,member:Combo %} - Applies inertial slide animation when transitioning between views in *RadCalendar*. Available only in Android.
25+
- {% typedoc_link enums:CalendarTransitionMode,member:Overlap %} - Views overlap when transitioning in *RadCalendar*. Available only in Android.
2626

2727
## References
2828
Want to see this scenario in action?

docs/ui/professional-ui-components/Calendar/view-modes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ publish: true
99
---
1010

1111
# RadCalendar View Modes
12-
{% typedoc_link classes:RadCalendar %} supports four view mode types that are useful in different application scenarios. Setting a view mode is done via the {% typedoc_link classes:RadCalendar,member:viewMode %} property. This property accepts values defined in the {% typedoc_link modules:CalendarViewMode %} enum. The following view modes are available:
12+
{% typedoc_link classes:RadCalendar %} supports view mode types that can be useful in different application scenarios. Setting a view mode is done via the {% typedoc_link classes:RadCalendar,member:viewMode %} property. This property accepts values defined in the {% typedoc_link enums:CalendarViewMode %} enum. The following view modes are available:
1313

14-
- {% typedoc_link modules:CalendarViewMode,member:Week %} - displays the dates within one week
15-
- {% typedoc_link modules:CalendarViewMode,member:Month %} - displays the dates within one month
16-
- {% typedoc_link modules:CalendarViewMode,member:MonthNames %} - displays the months within a year
17-
- {% typedoc_link modules:CalendarViewMode,member:Year %} - displays a whole year
18-
- {% typedoc_link modules:CalendarViewMode,member:Day %} - displays a timeline for a day with its events
14+
- {% typedoc_link enums:CalendarViewMode,member:Week %} - displays the dates within one week
15+
- {% typedoc_link enums:CalendarViewMode,member:Month %} - displays the dates within one month
16+
- {% typedoc_link enums:CalendarViewMode,member:MonthNames %} - displays the months within a year
17+
- {% typedoc_link enums:CalendarViewMode,member:Year %} - displays a whole year
18+
- {% typedoc_link enums:CalendarViewMode,member:Day %} - displays a timeline for a day with its events
1919

2020
#### Figure 1: RadCalendar when its viewMode is set to Day on Android (left) and iOS (right)
2121

docs/ui/professional-ui-components/Chart/Axes/categorical.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ When [RadCartesianChart]({% slug chart-types-cartesian %} "Read more about RadCa
2020

2121
The {% typedoc_link classes:CategoricalAxis %} allows you to define how exactly the axis will be plotted on the viewport of the chart. The possible values are:
2222

23-
* {% typedoc_link modules:AxisPlotMode,member:BetweenTicks%}: Points are plotted in the middle of the range, defined between each two ticks.
24-
* {% typedoc_link modules:AxisPlotMode,member:OnTicks%}: Points are plotted over each tick.
23+
* {% typedoc_link enums:ChartAxisPlotMode,member:BetweenTicks%}: Points are plotted in the middle of the range, defined between each two ticks.
24+
* {% typedoc_link enums:ChartAxisPlotMode,member:OnTicks%}: Points are plotted over each tick.
2525

2626
You can get and set the current value with the {% typedoc_link classes:CategoricalAxis,member:plotMode%} property.
2727

docs/ui/professional-ui-components/Chart/Axes/datetimecategorical.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The {% typedoc_link classes:DateTimeCategoricalAxis %} extends {% typedoc_link c
2020

2121
### Date Time Component
2222

23-
Defines the component of each Calendar structure that participates in the grouping process. The possible values: Second, Minute, Hour, Day, Week, Month, Year. To get or set the component use the {% typedoc_link classes:DateTimeCategoricalAxis,member:dateTimeComponent%} property.
23+
Defines the component of each Calendar structure that participates in the grouping process. The possible values are from the {% typedoc_link enums:ChartAxisDateTimeComponent %} enumeration. To get or set the component use the {% typedoc_link classes:DateTimeCategoricalAxis,member:dateTimeComponent%} property.
2424

2525
### Date Time Format
2626

@@ -38,4 +38,4 @@ Related articles you might find useful:
3838
* [**Logarithmic Axis**]({% slug chart-features-logarithmic %})
3939
* [**Negative Values Axis**]({% slug chart-features-negative-value %})
4040
* [**Categorical Axis**]({% slug chart-features-categorical %})
41-
* [**DateTime Continuous Axis**]({% slug chart-features-datetimecontinuous %})
41+
* [**DateTime Continuous Axis**]({% slug chart-features-datetimecontinuous %})

0 commit comments

Comments
 (0)