Skip to content
This repository was archived by the owner on Sep 3, 2023. It is now read-only.

Commit ff91342

Browse files
committed
Update docs and other stuff
1 parent cb13039 commit ff91342

File tree

10 files changed

+38
-41
lines changed

10 files changed

+38
-41
lines changed

.github/FUNDING.yml

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: bug
55

66
---
77

8-
*Please consider making a Pull Request if you are capable of doing so.*
8+
*Please consider making a Pull Request if you are capable of doing so. Note that versions before 2.0.0 are no longer supported.*
99

1010
**Library Version:**
1111

.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: improvement
55

66
---
77

8-
*Please consider making a Pull Request if you are capable of doing so.*
8+
*Please consider making a Pull Request if you are capable of doing so. Note that versions before 2.0.0 are no longer supported.*
99

1010
**What module does this apply to?**
1111

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,14 @@
88

99
---
1010

11-
![Showcase](https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/showcase4.png)
11+
![Showcase](https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/showcase4.png)
1212

1313
# Modules
1414

1515
The core module is the fundamental module that you need in order to use this library. The others
1616
are extensions to core.
1717

18-
Please note that since Material Dialogs v2, this library only supports Kotlin.
19-
The latest Java version is `0.9.6.0` and can be found [here](README_OLD.md).
18+
Please note that since Material Dialogs 2.x.x, this library only supports Kotlin. The latest Java version is `0.9.6.0` and can be found [here](README_OLD.md). Note that 0.9.6.0 is unsupported, bugs & improvements will not be made to that version.
2019

2120
## Core
2221

@@ -27,7 +26,7 @@ The latest Java version is `0.9.6.0` and can be found [here](README_OLD.md).
2726
The `core` module contains everything you need to get started with the library. It contains all
2827
core and normal-use functionality.
2928

30-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic_with_buttons.png" width="250px" />
29+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic_with_buttons.png" width="250px" />
3130

3231
```gradle
3332
dependencies {
@@ -44,7 +43,7 @@ dependencies {
4443

4544
The `input` module contains extensions to the core module, such as a text input dialog.
4645

47-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/input.png" width="250px" />
46+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/input.png" width="250px" />
4847

4948
```gradle
5049
dependencies {
@@ -61,7 +60,7 @@ dependencies {
6160

6261
The `files` module contains extensions to the core module, such as a file and folder chooser.
6362

64-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_chooser.png" width="250px" />
63+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_chooser.png" width="250px" />
6564

6665
```gradle
6766
dependencies {
@@ -78,7 +77,7 @@ dependencies {
7877

7978
The `color` module contains extensions to the core module, such as a color chooser.
8079

81-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/color_chooser.png" width="250px" />
80+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/color_chooser.png" width="250px" />
8281

8382
```gradle
8483
dependencies {
@@ -95,7 +94,7 @@ dependencies {
9594

9695
The `datetime` module contains extensions to make date, time, and date-time picker dialogs.
9796

98-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/datetimepicker.png" width="500px" />
97+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/datetimepicker.png" width="500px" />
9998

10099
```gradle
101100
dependencies {
@@ -114,7 +113,7 @@ The `bottomsheets` module contains extensions to turn modal dialogs into bottom
114113
other functionality like showing a grid of items. Be sure to checkout the sample project for this,
115114
too!
116115

117-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/bottomsheet_customview.png" width="250px" />
116+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/bottomsheet_customview.png" width="250px" />
118117

119118
```gradle
120119
dependencies {

documentation/BOTTOMSHEETS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If you've used Android bottom sheets before, peek height should be a familiar co
6565
height is the height of the bottom sheet when it's not fully expanded. It's a point between
6666
expanded and hidden.
6767

68-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/bottomsheet_peekheight.gif" width="250px" />
68+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/bottomsheet_peekheight.gif" width="250px" />
6969

7070
The default peek height is 60% of the screen height. You can set a custom peek height if you wish:
7171

documentation/COLOR.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ dependencies {
2626

2727
Color choosers show a simple grid of colors.
2828

29-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/color_chooser.png" width="250px" />
29+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/color_chooser.png" width="250px" />
3030

3131
```kotlin
3232
val colors = intArrayOf(RED, GREEN, BLUE)
@@ -59,7 +59,7 @@ MaterialDialog(this).show {
5959
You can specify sub-colors, which are a level down from each top level color. The size of the top
6060
level array must match the size of the sub-colors array.
6161

62-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/color_chooser_sub.png" width="250px" />
62+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/color_chooser_sub.png" width="250px" />
6363

6464
```kotlin
6565
val colors = intArrayOf(RED, GREEN, BLUE) // size = 3
@@ -81,7 +81,7 @@ MaterialDialog(this).show {
8181

8282
### ARGB Selection
8383

84-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/custom_argb.png" width="250px" />
84+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/custom_argb.png" width="250px" />
8585

8686
```kotlin
8787
MaterialDialog(this).show {
@@ -98,4 +98,4 @@ MaterialDialog(this).show {
9898
}
9999
```
100100

101-
Omitting `showAlphaSelector` will hide the alpha (transparency) selector.
101+
Omitting `showAlphaSelector` will hide the alpha (transparency) selector.

documentation/CORE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ dependencies {
4444

4545
Here's a very basic example of creating and showing a dialog:
4646

47-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic.png" width="250px" />
47+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic.png" width="250px" />
4848

4949
```kotlin
5050
MaterialDialog(this).show {
@@ -99,7 +99,7 @@ MaterialDialog(this).show {
9999

100100
There are simple methods for adding action buttons:
101101

102-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic_with_buttons.png" width="250px" />
102+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic_with_buttons.png" width="250px" />
103103

104104
```kotlin
105105
MaterialDialog(this).show {
@@ -135,13 +135,13 @@ MaterialDialog(this).show {
135135
If action buttons together are too long to fit in the dialog's width, they will be automatically
136136
stacked:
137137

138-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/stacked_buttons.png" width="250px" />
138+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/stacked_buttons.png" width="250px" />
139139

140140
## Adding an Icon
141141

142142
You can display an icon to the left of the title:
143143

144-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/icon.png" width="250px" />
144+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/icon.png" width="250px" />
145145

146146
```kotlin
147147
MaterialDialog(this).show {
@@ -198,7 +198,7 @@ MaterialDialog(this).show {
198198

199199
You can show lists using the `listItems` extension on `MaterialDialog`:
200200

201-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic_list.png" width="250px" />
201+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic_list.png" width="250px" />
202202

203203
```kotlin
204204
MaterialDialog(this).show {
@@ -231,7 +231,7 @@ MaterialDialog(this).show {
231231
You can show single choice (radio button) lists using the `listItemsSingleChoice` extension
232232
on `MaterialDialog`:
233233

234-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/single_choice_list.png" width="250px" />
234+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/single_choice_list.png" width="250px" />
235235

236236
```kotlin
237237
MaterialDialog(this).show {
@@ -314,7 +314,7 @@ val checked: Boolean = dialog.isItemChecked(index)
314314

315315
You can show multiple choice (checkbox) lists using the `listItemsMultiChoice` extension on `MaterialDialog`:
316316

317-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/multi_choice_list.png" width="250px" />
317+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/multi_choice_list.png" width="250px" />
318318

319319
```kotlin
320320
MaterialDialog(this).show {
@@ -437,7 +437,7 @@ val recyclerView: RecyclerView = dialog.getRecyclerView()
437437
Checkbox prompts can be used together with any other dialog type, it gets shown in the same view
438438
which shows the action buttons.
439439

440-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/checkbox_prompt.png" width="250px" />
440+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/checkbox_prompt.png" width="250px" />
441441

442442
```kotlin
443443
MaterialDialog(this).show {
@@ -482,7 +482,7 @@ MaterialDialog(this).show {
482482
A lot of the included extensions use custom views, such as the color chooser dialog. There's also
483483
a simple example in the sample project.
484484

485-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/custom_view.png" width="250px" />
485+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/custom_view.png" width="250px" />
486486

487487
```kotlin
488488
MaterialDialog(this).show {
@@ -543,7 +543,7 @@ change fonts, corner rounding, etc.
543543
Light and dark theming is automatic based on your app's theme (basically whether `android:textColorPrimary`
544544
is more light or more dark):
545545

546-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/lightanddarkthemes.png" width="500px" />
546+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/lightanddarkthemes.png" width="500px" />
547547

548548
### Background Color
549549

@@ -561,7 +561,7 @@ theme for the ripple color of list items, buttons, etc. by default. You can over
561561

562562
Corner radius is the rounding of dialog corners:
563563

564-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/customtheme.png" width="250px" />
564+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/customtheme.png" width="250px" />
565565

566566
it can be changed with an attribute in your app theme. It defaults to 4dp:
567567

@@ -618,4 +618,4 @@ using attributes in your app's theme.
618618

619619
See the "Custom Theme" example in the sample project (open the overflow menu for the theme switcher).
620620

621-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/customtheme.png" width="250px" />
621+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/customtheme.png" width="250px" />

documentation/DATETIME.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ dependencies {
2222

2323
## Date
2424

25-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/datepicker.png" width="250px" />
25+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/datepicker.png" width="250px" />
2626

2727
```kotlin
2828
MaterialDialog(this).show {
@@ -37,7 +37,7 @@ You can optionally provide `minDate`, `maxDate` and `currentDate` parameters as
3737

3838
## Time
3939

40-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/timepicker.png" width="250px" />
40+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/timepicker.png" width="250px" />
4141

4242
```kotlin
4343
MaterialDialog(this).show {
@@ -52,7 +52,7 @@ You can optionally provide `currentTime` and `show24HoursView` parameters as wel
5252

5353
## DateTime
5454

55-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/datetimepicker.png" width="400px" />
55+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/datetimepicker.png" width="400px" />
5656

5757
```kotlin
5858
MaterialDialog(this).show {

documentation/FILES.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ directory listings will come back empty.
3636

3737
You create file choosers using the `fileChooser` extension on `MaterialDialog`:
3838

39-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_chooser.png" width="250px" />
39+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_chooser.png" width="250px" />
4040

4141
```kotlin
4242
MaterialDialog(this).show {
@@ -83,7 +83,7 @@ MaterialDialog(this).show {
8383

8484
Empty text is shown when a folder has no contents. You can configure the empty text label:
8585

86-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_emptytext.png" width="250px" />
86+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_emptytext.png" width="250px" />
8787

8888
```kotlin
8989
MaterialDialog(this).show {
@@ -95,7 +95,7 @@ MaterialDialog(this).show {
9595

9696
### Folder Creation
9797

98-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_folder_creation.png" width="250px" />
98+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_folder_creation.png" width="250px" />
9999

100100
You can allow your users to create folders.
101101

@@ -151,7 +151,7 @@ MaterialDialog(this).show {
151151

152152
Empty text is shown when a folder has no contents. You can configure the empty text label:
153153

154-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_emptytext.png" width="250px" />
154+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_emptytext.png" width="250px" />
155155

156156
```kotlin
157157
MaterialDialog(this).show {
@@ -163,7 +163,7 @@ MaterialDialog(this).show {
163163

164164
### Folder Creation
165165

166-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_folder_creation.png" width="250px" />
166+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_folder_creation.png" width="250px" />
167167

168168
You can allow your users to create folders.
169169

@@ -178,4 +178,4 @@ MaterialDialog(this).show {
178178
}
179179
```
180180

181-
This "New Folder" option is only show in directories which are writable.
181+
This "New Folder" option is only show in directories which are writable.

documentation/INPUT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ dependencies {
2929

3030
You can setup an input dialog using the `input` extension on `MaterialDialog`:
3131

32-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/input.png" width="250px" />
32+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/input.png" width="250px" />
3333

3434
```kotlin
3535
MaterialDialog(this).show {
@@ -138,7 +138,7 @@ MaterialDialog(this).show {
138138
You can set a max length which makes a character counter visible, and disables the positive action
139139
button if the input length goes over that:
140140

141-
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/input_max_length.png" width="250px" />
141+
<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/input_max_length.png" width="250px" />
142142

143143
```kotlin
144144
MaterialDialog(this).show {

0 commit comments

Comments
 (0)