Browse Source

Update docs and other stuff

Aidan Follestad 4 years ago
parent
commit
ff91342bcb

+ 0 - 2
.github/FUNDING.yml

@@ -1,2 +0,0 @@
-github: afollestad
-ko_fi: afollestad

+ 1 - 1
.github/ISSUE_TEMPLATE/Bug_report.md

@@ -5,7 +5,7 @@ labels: bug
 
 ---
 
-*Please consider making a Pull Request if you are capable of doing so.*
+*Please consider making a Pull Request if you are capable of doing so. Note that versions before 2.0.0 are no longer supported.*
 
 **Library Version:**
 

+ 1 - 1
.github/ISSUE_TEMPLATE/Feature_request.md

@@ -5,7 +5,7 @@ labels: improvement
 
 ---
 
-*Please consider making a Pull Request if you are capable of doing so.*
+*Please consider making a Pull Request if you are capable of doing so. Note that versions before 2.0.0 are no longer supported.*
 
 **What module does this apply to?**
 

+ 8 - 9
README.md

@@ -8,15 +8,14 @@
 
 ---
 
-![Showcase](https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/showcase4.png)
+![Showcase](https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/showcase4.png)
 
 # Modules
 
 The core module is the fundamental module that you need in order to use this library. The others 
 are extensions to core.
 
-Please note that since Material Dialogs v2, this library only supports Kotlin.
-The latest Java version is `0.9.6.0` and can be found [here](README_OLD.md).
+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.
 
 ## Core
 
@@ -27,7 +26,7 @@ The latest Java version is `0.9.6.0` and can be found [here](README_OLD.md).
 The `core` module contains everything you need to get started with the library. It contains all
 core and normal-use functionality.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic_with_buttons.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic_with_buttons.png" width="250px" />
 
 ```gradle
 dependencies {
@@ -44,7 +43,7 @@ dependencies {
  
 The `input` module contains extensions to the core module, such as a text input dialog.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/input.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/input.png" width="250px" />
 
 ```gradle
 dependencies {
@@ -61,7 +60,7 @@ dependencies {
 
 The `files` module contains extensions to the core module, such as a file and folder chooser.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_chooser.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_chooser.png" width="250px" />
 
 ```gradle
 dependencies {
@@ -78,7 +77,7 @@ dependencies {
 
 The `color` module contains extensions to the core module, such as a color chooser.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/color_chooser.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/color_chooser.png" width="250px" />
 
 ```gradle
 dependencies {
@@ -95,7 +94,7 @@ dependencies {
 
 The `datetime` module contains extensions to make date, time, and date-time picker dialogs.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/datetimepicker.png" width="500px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/datetimepicker.png" width="500px" />
 
 ```gradle
 dependencies {
@@ -114,7 +113,7 @@ The `bottomsheets` module contains extensions to turn modal dialogs into bottom
 other functionality like showing a grid of items. Be sure to checkout the sample project for this,
 too!
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/bottomsheet_customview.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/bottomsheet_customview.png" width="250px" />
 
 ```gradle
 dependencies {

+ 1 - 1
documentation/BOTTOMSHEETS.md

@@ -65,7 +65,7 @@ If you've used Android bottom sheets before, peek height should be a familiar co
 height is the height of the bottom sheet when it's not fully expanded. It's a point between 
 expanded and hidden.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/bottomsheet_peekheight.gif" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/bottomsheet_peekheight.gif" width="250px" />
 
 The default peek height is 60% of the screen height. You can set a custom peek height if you wish: 
 

+ 4 - 4
documentation/COLOR.md

@@ -26,7 +26,7 @@ dependencies {
 
 Color choosers show a simple grid of colors.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/color_chooser.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/color_chooser.png" width="250px" />
 
 ```kotlin
 val colors = intArrayOf(RED, GREEN, BLUE)
@@ -59,7 +59,7 @@ MaterialDialog(this).show {
 You can specify sub-colors, which are a level down from each top level color. The size of the top 
 level array must match the size of the sub-colors array.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/color_chooser_sub.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/color_chooser_sub.png" width="250px" />
 
 ```kotlin
 val colors = intArrayOf(RED, GREEN, BLUE) // size = 3
@@ -81,7 +81,7 @@ MaterialDialog(this).show {
 
 ### ARGB Selection
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/custom_argb.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/custom_argb.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -98,4 +98,4 @@ MaterialDialog(this).show {
 }
 ```
 
-Omitting `showAlphaSelector` will hide the alpha (transparency) selector.
+Omitting `showAlphaSelector` will hide the alpha (transparency) selector.

+ 12 - 12
documentation/CORE.md

@@ -44,7 +44,7 @@ dependencies {
 
 Here's a very basic example of creating and showing a dialog:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -99,7 +99,7 @@ MaterialDialog(this).show {
 
 There are simple methods for adding action buttons:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic_with_buttons.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic_with_buttons.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -135,13 +135,13 @@ MaterialDialog(this).show {
 If action buttons together are too long to fit in the dialog's width, they will be automatically
 stacked:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/stacked_buttons.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/stacked_buttons.png" width="250px" />
 
 ## Adding an Icon
 
 You can display an icon to the left of the title:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/icon.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/icon.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -198,7 +198,7 @@ MaterialDialog(this).show {
 
 You can show lists using the `listItems` extension on `MaterialDialog`:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/basic_list.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/basic_list.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -231,7 +231,7 @@ MaterialDialog(this).show {
 You can show single choice (radio button) lists using the `listItemsSingleChoice` extension 
 on `MaterialDialog`:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/single_choice_list.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/single_choice_list.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -314,7 +314,7 @@ val checked: Boolean = dialog.isItemChecked(index)
 
 You can show multiple choice (checkbox) lists using the `listItemsMultiChoice` extension on `MaterialDialog`:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/multi_choice_list.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/multi_choice_list.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -437,7 +437,7 @@ val recyclerView: RecyclerView = dialog.getRecyclerView()
 Checkbox prompts can be used together with any other dialog type, it gets shown in the same view
 which shows the action buttons.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/checkbox_prompt.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/checkbox_prompt.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -482,7 +482,7 @@ MaterialDialog(this).show {
 A lot of the included extensions use custom views, such as the color chooser dialog. There's also 
 a simple example in the sample project.
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/custom_view.png" width="250px" /> 
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/custom_view.png" width="250px" /> 
 
 ```kotlin
 MaterialDialog(this).show {
@@ -543,7 +543,7 @@ change fonts, corner rounding, etc.
 Light and dark theming is automatic based on your app's theme (basically whether `android:textColorPrimary` 
 is more light or more dark):
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/lightanddarkthemes.png" width="500px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/lightanddarkthemes.png" width="500px" />
 
 ### Background Color
 
@@ -561,7 +561,7 @@ theme for the ripple color of list items, buttons, etc. by default. You can over
 
 Corner radius is the rounding of dialog corners:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/customtheme.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/customtheme.png" width="250px" />
 
 it can be changed with an attribute in your app theme. It defaults to 4dp:
 
@@ -618,4 +618,4 @@ using attributes in your app's theme.
 
 See the "Custom Theme" example in the sample project (open the overflow menu for the theme switcher).
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/customtheme.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/customtheme.png" width="250px" />

+ 3 - 3
documentation/DATETIME.md

@@ -22,7 +22,7 @@ dependencies {
 
 ## Date
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/datepicker.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/datepicker.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -37,7 +37,7 @@ You can optionally provide `minDate`, `maxDate` and `currentDate` parameters as
 
 ## Time
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/timepicker.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/timepicker.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -52,7 +52,7 @@ You can optionally provide `currentTime` and `show24HoursView` parameters as wel
 
 ## DateTime
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/datetimepicker.png" width="400px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/datetimepicker.png" width="400px" />
 
 ```kotlin
 MaterialDialog(this).show {

+ 6 - 6
documentation/FILES.md

@@ -36,7 +36,7 @@ directory listings will come back empty.
 
 You create file choosers using the `fileChooser` extension on `MaterialDialog`:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_chooser.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_chooser.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -83,7 +83,7 @@ MaterialDialog(this).show {
 
 Empty text is shown when a folder has no contents. You can configure the empty text label:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_emptytext.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_emptytext.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -95,7 +95,7 @@ MaterialDialog(this).show {
 
 ### Folder Creation
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_folder_creation.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_folder_creation.png" width="250px" />
 
 You can allow your users to create folders. 
 
@@ -151,7 +151,7 @@ MaterialDialog(this).show {
 
 Empty text is shown when a folder has no contents. You can configure the empty text label:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_emptytext.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_emptytext.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -163,7 +163,7 @@ MaterialDialog(this).show {
 
 ### Folder Creation
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/file_folder_creation.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/file_folder_creation.png" width="250px" />
 
 You can allow your users to create folders. 
 
@@ -178,4 +178,4 @@ MaterialDialog(this).show {
 }
 ```
 
-This "New Folder" option is only show in directories which are writable.
+This "New Folder" option is only show in directories which are writable.

+ 2 - 2
documentation/INPUT.md

@@ -29,7 +29,7 @@ dependencies {
 
 You can setup an input dialog using the `input` extension on `MaterialDialog`:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/input.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/input.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {
@@ -138,7 +138,7 @@ MaterialDialog(this).show {
 You can set a max length which makes a character counter visible, and disables the positive action 
 button if the input length goes over that:
 
-<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/master/art/input_max_length.png" width="250px" />
+<img src="https://raw.githubusercontent.com/afollestad/material-dialogs/main/art/input_max_length.png" width="250px" />
 
 ```kotlin
 MaterialDialog(this).show {