Skip to content

Commit

Permalink
Updated README & docs with Frame to Border changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
DashTheDev committed Jun 20, 2024
1 parent e68c8fd commit 57d1918
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,12 @@ Indicators styling:
``` xml
<ContentPage.Resources>
<ResourceDictionary>
<Style x:Key="ActiveIndicator" TargetType="Frame">
<Style x:Key="ActiveIndicator" TargetType="Border">
<Setter Property="BackgroundColor" Value="Red" />
</Style>
<Style x:Key="InactiveIndicator" TargetType="Frame">
<Style x:Key="InactiveIndicator" TargetType="Border">
<Setter Property="BackgroundColor" Value="Transparent" />
<Setter Property="OutlineColor" Value="Red" />
<Setter Property="Stroke" Value="Red" />
</Style>
</ResourceDictionary>
</ContentPage.Resources>
Expand Down Expand Up @@ -197,7 +197,7 @@ if you want to achieve scale or opacity changing effects for side views (**Scale
-> If you want to customize indicators, you need set *SelectedIndicatorStyle* and/or *UnselectedIndicatorStyle*, or you are able to extend this class and override several methods.
Also you can customize position of indicators (You need to set Rotation / Layout Options, Bounds etc.)

This class is describing default indicators styles (each default indicator item is Frame)
This class is describing default indicators styles (each default indicator item is a Border)
https://github.com/AndreiMisiukevich/CardView.MAUI/blob/main/PanCardView/Common/Styles/DefaultIndicatorItemStyles.cs


Expand Down
9 changes: 4 additions & 5 deletions docs/IndicatorItemView.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ The default Indicator template this has the following properties:
```csharp
VerticalOptions = LayoutOptions.Center;
HorizontalOptions = LayoutOptions.Center;
HasShadow = false;
Padding = 0;
HeightRequest = 10;
WidthRequest = 10;
CornerRadius = 5;
StrokeShape = new Ellipse();
HeightRequest = 25;
WidthRequest = 25;
Size = 25;
```
6 changes: 3 additions & 3 deletions docs/IndicatorsControl.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If the IndicatorsControl is nested in a [CarouselView](CarouselView.md) or [Card

### Custom Indicator

The default indicator is a `Frame` control that is a 10px by 10px circle. This can be change by setting the `ItemTemplate` then setting the `SelectedIndicatorStyle` and `UnselectedIndicatorStyle` styles.
The default indicator is a `Border` control that is a 25px by 25px circle. This can be change by setting the `ItemTemplate` then setting the `SelectedIndicatorStyle` and `UnselectedIndicatorStyle` styles.

### Properties

Expand All @@ -23,8 +23,8 @@ Property | Type | Default | Description
--- | --- | --- | ---
SelectedIndex | `int` | 0 | The currently selected index this will disaplyed with the `SelectedIndicatorStyle`
ItemsCount | `int` | 0 | The number of items the indicator should display.
SelectedIndicatorStyle | `Style` | DefaultSelectedIndicatorItemStyle - Frame style that sets `Background` to White with .8 Alpha | The style used when the indicator is selected.
UnselectedIndicatorStyle | `Style` | DefaultUnselectedIndicatorItemStyle - Frame style that sets `Background` to Transparent and `OutlineColor` to White with .8 Alpha | The style used when the indicator is not selected.
SelectedIndicatorStyle | `Style` | DefaultSelectedIndicatorItemStyle - Border style that sets `Background` to White with .8 Alpha | The style used when the indicator is selected.
UnselectedIndicatorStyle | `Style` | DefaultUnselectedIndicatorItemStyle - Border style that sets `Background` to Transparent and `Stroke` to White with .8 Alpha | The style used when the indicator is not selected.
IsUserInteractionRunning | `bool` | true | Is used when `ToFadeDuration` is greater than 0 to show and hide the IndicatorControl.
IsAutoInteractionRunning | `bool` | true | Is used when `ToFadeDuration` is greater than 0 to show and hide the IndicatorControl.
HidesForSingleIndicator | `bool` | tru | Determines if we should hide indicators in case 1 element.
Expand Down

0 comments on commit 57d1918

Please sign in to comment.