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

Commit 92e5a90

Browse files
mrerammreram
authored
Update README.md
1 parent bab8533 commit 92e5a90

File tree

1 file changed

+71
-67
lines changed

1 file changed

+71
-67
lines changed

‎README.md‎

Lines changed: 71 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414

1515
## How to use:question:
1616

17-
Sample usage in your activity:
18-
19-
new GuideView.Builder(this)
20-
.setTitle("Guide Title Text")
21-
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
22-
.setGravity(Gravity.auto) //optional
23-
.setDismissType(DismissType.anywhere) //optional - default DismissType.targetView
24-
.setTargetView(view)
25-
.setContentTextSize(12)//optional
26-
.setTitleTextSize(14)//optional
27-
.build()
28-
.show();
29-
17+
Sample usage in your activity
18+
```java
19+
new GuideView.Builder(this)
20+
.setTitle("Guide Title Text")
21+
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
22+
.setGravity(Gravity.auto) //optional
23+
.setDismissType(DismissType.anywhere) //optional - default DismissType.targetView
24+
.setTargetView(view)
25+
.setContentTextSize(12)//optional
26+
.setTitleTextSize(14)//optional
27+
.build()
28+
.show();
29+
```
3030
<img src="./screenshots/sample1.gif" width="300">
3131

3232
## Installation
@@ -65,68 +65,72 @@ allprojects {
6565
implementation 'com.github.mreram:showcaseview:1.1'
6666
```
6767
## Change type face
68+
```java
69+
new GuideView.Builder(this)
70+
.setTitle("Guide Title Text")
71+
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
72+
.setTargetView(view)
73+
.setContentTypeFace(Typeface)//optional
74+
.setTitleTypeFace(Typeface)//optional
75+
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
76+
.build()
77+
.show();
78+
```
6879

69-
new GuideView.Builder(this)
70-
.setTitle("Guide Title Text")
71-
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
72-
.setTargetView(view)
73-
.setContentTypeFace(Typeface)//optional
74-
.setTitleTypeFace(Typeface)//optional
75-
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
76-
.build()
77-
.show();
78-
7980
## Change title and Content text size
8081

81-
new GuideView.Builder(this)
82-
.setTitle("Guide Title Text")
83-
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
84-
.setTargetView(view)
85-
.setContentTextSize(12)//optional
86-
.setTitleTextSize(14)//optional
87-
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
88-
.build()
89-
.show();
90-
82+
```java
83+
new GuideView.Builder(this)
84+
.setTitle("Guide Title Text")
85+
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
86+
.setTargetView(view)
87+
.setContentTextSize(12)//optional
88+
.setTitleTextSize(14)//optional
89+
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
90+
.build()
91+
.show();
92+
```
9193
## Change Gravity
9294

93-
new GuideView.Builder(this)
94-
.setTitle("Guide Title Text")
95-
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
96-
.setGravity(Gravity.CENTER)//optional
97-
.setTargetView(view)
98-
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
99-
.build()
100-
.show();
101-
95+
```java
96+
new GuideView.Builder(this)
97+
.setTitle("Guide Title Text")
98+
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
99+
.setGravity(Gravity.CENTER)//optional
100+
.setTargetView(view)
101+
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
102+
.build()
103+
.show();
104+
```
102105
103106
## use Spannable for Content
104-
105-
new GuideView.Builder(this)
106-
.setTitle("Guide Title Text")
107-
.setTargetView(view)
108-
.setContentSpan((Spannable) Html.fromHtml("<font color='red'>testing spannable</p>"))
109-
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
110-
.build()
111-
.show();
112-
113-
## Set Listener
114-
115-
new GuideView.Builder(MainActivity.this)
116-
.setTitle("Guide Title Text")
117-
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
118-
.setGravity(Gravity.CENTER)
119-
.setTargetView(view1)
120-
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
121-
.setGuideListener(new GuideListener() {
122-
@Override
123-
public void onDismiss(View view) {
124-
//TODO ...
125-
}
126-
})
127-
.build()
128-
.show();
107+
```java
108+
new GuideView.Builder(this)
109+
.setTitle("Guide Title Text")
110+
.setTargetView(view)
111+
.setContentSpan((Spannable) Html.fromHtml("<font color='red'>testing spannable</p>"))
112+
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
113+
.build()
114+
.show();
115+
```
129116

117+
## Set Listener
118+
```java
119+
new GuideView.Builder(MainActivity.this)
120+
.setTitle("Guide Title Text")
121+
.setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")
122+
.setGravity(Gravity.CENTER)
123+
.setTargetView(view1)
124+
.setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
125+
.setGuideListener(new GuideListener() {
126+
@Override
127+
public void onDismiss(View view) {
128+
//TODO ...
129+
}
130+
})
131+
.build()
132+
.show();
133+
```
130134

131135
### DismissType Attribute
132136

0 commit comments

Comments
 (0)