Skip to content

Commit 51148a0

Browse files
taljacobsontaljacobson
committed
format ReadME
1 parent 71fdd9c commit 51148a0

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

‎README.md‎

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
<div align="center"><img src="https://github.com/aagarwal1012/IntroViews-Flutter/blob/master/display/header.png?raw=true"/></div>
22
<br/>
33

4-
5-
6-
74
IntroViews is inspired by [Paper Onboarding](https://github.com/Ramotion/paper-onboarding-android) and developed with `love` from scratch. I decided to rewrite almost all the features in order to make it available to the `flutter` developers and extensible as possible.
85

9-
[![pub package](https://img.shields.io/pub/v/intro_views_flutter.svg)](https://pub.dartlang.org/packages/intro_views_flutter)
6+
[![pub package](https://img.shields.io/pub/v/intro_views_flutter.svg)](https://pub.dartlang.org/packages/intro_views_flutter)
107

118
<img src="https://github.com/aagarwal1012/IntroViews-Flutter/blob/master/display/output.gif?raw=true" align = "right" height = "550px">
129

13-
# Features
10+
# Features
1411

1512
- Easy addition of pages.
1613

@@ -81,47 +78,48 @@ You should then run `flutter packages get` in your terminal so as to get the pac
8178
},
8279
showSkipButton: true,
8380
pageButtonTextStyles: new TextStyle(
84-
color: Colors.white,
81+
color: Colors.white,
8582
fontSize: 18.0,
8683
fontFamily: "Regular",
8784
),
8885
);
8986
```
87+
9088
For further usage refer the [`example`](https://github.com/aagarwal1012/IntroViews-Flutter/tree/master/example/lib) available.
9189

9290
For `Landscape` preview click the [link](https://github.com/aagarwal1012/IntroViews-Flutter/blob/master/display/landscape2.png?raw=true).
9391

94-
***Note :*** If you added more than four pages in the list then there might be overlapping between `page icons` and `skip button`, so my suggestion is just make the `showSkipButton: false`.
92+
**_Note :_** If you added more than four pages in the list then there might be overlapping between `page icons` and `skip button`, so my suggestion is just make the `showSkipButton: false`.
9593

9694
# Documentation
9795

9896
### PageViewModel Class
9997

100-
| Dart attribute | Datatype | Description | Default Value |
101-
| :---------------- | :------------------------------ | :----------------------------------------------------------- | :-----------: |
102-
| pageColor | Color | Set color of the page. | Null |
103-
| mainImage | Image | Set the main image of the page. | Null |
104-
| title | Text | Set the title text of the page. | Null |
105-
| body | Text | Set the body text of the page. | Null |
106-
| iconImageAssetPath | String | Set the icon image asset path that would be displayed in page bubble. | Null |
107-
| iconColor | Color | Set the page bubble icon color. | Null |
108-
| bubbleBackgroundColor | Color | Set the page bubble background color. | Colors.white |
109-
| textStyle | TextStyle | Set TextStyle for both title and body | title: `color: Colors.white , fontSize: 50.0` <br> body: `color: Colors.white , fontSize: 24.0` |
98+
| Dart attribute | Datatype | Description | Default Value |
99+
| :-------------------- | :-------- | :-------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------: |
100+
| pageColor | Color | Set color of the page. | Null |
101+
| mainImage | Image | Set the main image of the page. | Null |
102+
| title | Text | Set the title text of the page. | Null |
103+
| body | Text | Set the body text of the page. | Null |
104+
| iconImageAssetPath | String | Set the icon image asset path that would be displayed in page bubble. | Null |
105+
| iconColor | Color | Set the page bubble icon color. | Null |
106+
| bubbleBackgroundColor | Color | Set the page bubble background color. | Colors.white |
107+
| textStyle | TextStyle | Set TextStyle for both title and body | title: `color: Colors.white , fontSize: 50.0` <br> body: `color: Colors.white , fontSize: 24.0` |
110108

111109
### IntroViewFlutter Class
112110

113-
| Dart attribute | Datatype | Description | Default Value |
114-
| :---------------- | :------------------------------ | :----------------------------------------------------------- | :-----------: |
115-
| pages | List<PageViewModel> | Set the pages of the intro screen. | Null |
116-
| onTapDoneButton | VoidCallback | Method executes on tapping done button. | Null |
117-
| showSkipButton | Bool | Show the skip button at the bottom of page. | true |
118-
| pageButtonTextSize | Double | Set the button text size. | 18.0 |
119-
| pageButtonFontFamily | String | Set the font of button text. | Default |
120-
| onTapSkipButton | VoidCallback | Method executes on tapping skip button. | null |
121-
| pageButtonTextStyles | TextStyle | Configure TextStyle for skip, done buttons, overrides pageButtonFontFamily, pageButtonsColor, pageButtonTextSize. | fontSize: `18.0`, color: `Colors.white` |
122-
| skipText | Text | Override Skip Button Text and styles. | Text('SKIP') |
123-
| doneText | Text | Override Done Button Text and styles. | Text('DONE') |
124-
| doneButtonPersist | Bool | Show done Button throughout pages | false |
111+
| Dart attribute | Datatype | Description | Default Value |
112+
| :------------------- | :------------------ | :---------------------------------------------------------------------------------------------------------------- | :-------------------------------------: |
113+
| pages | List<PageViewModel> | Set the pages of the intro screen. | Null |
114+
| onTapDoneButton | VoidCallback | Method executes on tapping done button. | Null |
115+
| showSkipButton | Bool | Show the skip button at the bottom of page. | true |
116+
| pageButtonTextSize | Double | Set the button text size. | 18.0 |
117+
| pageButtonFontFamily | String | Set the font of button text. | Default |
118+
| onTapSkipButton | VoidCallback | Method executes on tapping skip button. | null |
119+
| pageButtonTextStyles | TextStyle | Configure TextStyle for skip, done buttons, overrides pageButtonFontFamily, pageButtonsColor, pageButtonTextSize. | fontSize: `18.0`, color: `Colors.white` |
120+
| skipText | Text | Override Skip Button Text and styles. | Text('SKIP') |
121+
| doneText | Text | Override Done Button Text and styles. | Text('DONE') |
122+
| doneButtonPersist | Bool | Show done Button throughout pages | false |
125123

126124
For help on editing package code, view the [flutter documentation](https://flutter.io/developing-packages/).
127125

@@ -131,4 +129,5 @@ This is the well `documented` package. I have documented each and every method t
131129
Feel free to [open an issue](https://github.com/aagarwal1012/IntroViews-Flutter/issues).
132130

133131
# License
132+
134133
**IntroViews-Flutter** is licensed under `MIT license`.

0 commit comments

Comments
 (0)