From 7e3af0c216ccebc9147c6af262a80fb84f0691f0 Mon Sep 17 00:00:00 2001
From: Sanku-Yogesh <72017713+Sanku-Yogesh@users.noreply.github.com>
Date: Wed, 28 Jul 2021 19:10:08 +0530
Subject: [PATCH 1/5] Update Readme
---
README.md | 89 +++++++++++++++++++++++++++----------------------------
1 file changed, 43 insertions(+), 46 deletions(-)
diff --git a/README.md b/README.md
index 0b873cd..d332ca7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# ArcPageIndicator [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=applibgroup_ArcPageIndicator&metric=alert_status)](https://sonarcloud.io/dashboard?id=applibgroup_ArcPageIndicator) [![Build](https://github.com/applibgroup/ArcPageIndicator/actions/workflows/main.yml/badge.svg)](https://github.com/applibgroup/ArcPageIndicator/actions/workflows/main.yml)
Bored of the usual small points or stressed by the space occupied by a tab bar?
Try this elevator-like elegant and original page indicator!
-A fully customizable super-easy Page Indicator, with stunning animations and very original and discreet graphics, for Android. Needs a very small screen, perfect when many pages need to be shown and reached in a small time.
+A fully customizable super-easy Page Indicator, with stunning animations and very original and discreet graphics, for HarmonyOS. Needs a very small screen, perfect when many pages need to be shown and reached in a small time.
@@ -42,57 +42,58 @@ An old elevator that inspired this project.
```
### Minimal usage
-Layout for bottom 180° ellipse:
-
- ...
- xmlns:app="http://schemas.android.com/apk/res-auto"
- ...
+Layout for left 180° ellipse:
+```xml
General | |
---|---|
apiViewPager | The ViewPager associated to the Indicator |
pageSliderId | The pageSlider Id associated to the Indicator |
Arc appearance | |
apiArcOrientation | Orientation of the "belly" of the arc. This parameter also affects if the arc will be 90° (corner arc) or 180° (edge arc) |
arcOrientation | Orientation of the "belly" of the arc. This parameter also affects if the arc will be 90° (corner arc) or 180° (edge arc) |
Spot appearance | |
apiSpotsColor | Color of the spots |
apiSelectedSpotColor | Color of the selected spot |
apiSpotsRadius | Size of the spots |
apiSpotsShape | Shape of the spots: Circle, RoundedSquare or Square |
spotsColor | Color of the spots |
selectedSpotColor | Color of the selected spot |
spotsRadius | Size of the spots |
spotsShape | Shape of the spots: Circle, RoundedSquare or Square |
Spots distribution and movement | |
apiIntervalMeasure | How spots are distributed on the circumference: constant angle or constant arc length. With constant angle, the spots will not be distributed evenly, because of ellipse's eccentricity. Normally constant arc length is used: being a non-finite math problem, here an approximation function is used, as explained later on. |
apiInvertDirection | If spots will be selected in inverted direction |
apiAnimationType | See below to detailed explanation of animation types |
intervalMeasure | How spots are distributed on the circumference: constant angle or constant arc length. With constant angle, the spots will not be distributed evenly, because of ellipse's eccentricity. Normally constant arc length is used: being a non-finite math problem, here an approximation function is used, as explained later on. |
invertDirection | If spots will be selected in inverted direction |
animationType | See below to detailed explanation of animation types |
Hand appearance | |
apiHandEnabled | If hand is drawn |
apiHandColor | Hand's color |
apiHandWidth | Hand's width |
apiHandRelativeLength | Hand's relative length starting from center to edges (1 = full length) |
handEnabled | If hand is drawn |
handColor | Hand's color |
handWidth | Hand's width |
handRelativeLength | Hand's relative length starting from center to edges (1 = full length) |