From c85fa3935d4aaf0beb66811ec5bd7f1cf4bf093d Mon Sep 17 00:00:00 2001 From: Vladimir Raupov Date: Thu, 15 Jun 2023 20:50:22 +0300 Subject: [PATCH 1/3] Add links to README files --- corbind-activity/README.md | 4 +- corbind-appcompat/README.md | 22 ++-- corbind-core/README.md | 4 +- corbind-drawerlayout/README.md | 4 +- corbind-fragment/README.md | 4 +- corbind-leanback/README.md | 10 +- corbind-lifecycle/README.md | 4 +- corbind-material/README.md | 133 +++++++++++++------- corbind-navigation/README.md | 7 +- corbind-recyclerview/README.md | 16 ++- corbind-slidingpanelayout/README.md | 7 +- corbind-swiperefreshlayout/README.md | 4 +- corbind-viewpager/README.md | 10 +- corbind-viewpager2/README.md | 10 +- corbind/README.md | 181 ++++++++++++++++++--------- 15 files changed, 288 insertions(+), 132 deletions(-) diff --git a/corbind-activity/README.md b/corbind-activity/README.md index 4cd82dc7..358ee811 100644 --- a/corbind-activity/README.md +++ b/corbind-activity/README.md @@ -13,7 +13,7 @@ dependencies { Component | Extension | Description --|---|-- -**OnBackPressedDispatcher** | `backPresses` | Called when OnBackPressedDispatcher.onBackPressed triggered. +**OnBackPressedDispatcher** | [`backPresses`][OnBackPressedDispatcher_backPresses] | Called when OnBackPressedDispatcher.onBackPressed triggered. ## Simple examples @@ -26,3 +26,5 @@ onBackPressedDispatcher.backPresses(lifecycleOwner = this) // Flow ``` More examples in source code + +[OnBackPressedDispatcher_backPresses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-activity/src/main/kotlin/ru/ldralighieri/corbind/activity/OnBackPressedDispatcherBackPresses.kt diff --git a/corbind-appcompat/README.md b/corbind-appcompat/README.md index f211fe81..0377ef6b 100644 --- a/corbind-appcompat/README.md +++ b/corbind-appcompat/README.md @@ -13,13 +13,13 @@ dependencies { Component | Extension | Description --|---|-- -**ActionMenuView** | `itemClicks` | Called when a menu item is clicked if the item itself did not already handle the event. -**PopupMenu** | `dismisses` | Called when the associated menu has been dismissed. -  | `itemClicks` | Called when a menu item is clicked if the item itself did not already handle the event. -**SearchView** | `queryTextChanges` | Called when the query text is changed by the user. -  | `queryTextChangeEvents` | A more advanced version of the `queryTextChanges`. -**Toolbar** | `itemClicks` | Called when a menu item is clicked if the item itself did not already handle the event. -  | `navigationClicks` | Called whenever the user clicks the navigation button at the start of the toolbar. +**ActionMenuView** | [`itemClicks`][ActionMenuView_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event. +**PopupMenu** | [`dismisses`][PopupMenu_dismisses] | Called when the associated menu has been dismissed. +  | [`itemClicks`][PopupMenu_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event. +**SearchView** | [`queryTextChanges`][SearchView_queryTextChanges] | Called when the query text is changed by the user. +  | [`queryTextChangeEvents`][SearchView_queryTextChangeEvents] | A more advanced version of the `queryTextChanges`. +**Toolbar** | [`itemClicks`][Toolbar_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event. +  | [`navigationClicks`][Toolbar_navigationClicks] | Called whenever the user clicks the navigation button at the start of the toolbar. ## Example @@ -32,3 +32,11 @@ toolbar.itemClicks() // Flow ``` More examples in source code + +[ActionMenuView_itemClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/ActionMenuViewItemClicks.kt +[PopupMenu_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/PopupMenuDismisses.kt +[PopupMenu_itemClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/PopupMenuItemClicks.kt +[SearchView_queryTextChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/SearchViewQueryTextChanges.kt +[SearchView_queryTextChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/SearchViewQueryTextChangeEvents.kt +[Toolbar_itemClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/ToolbarItemClicks.kt +[Toolbar_navigationClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-appcompat/src/main/kotlin/ru/ldralighieri/corbind/appcompat/ToolbarNavigationClicks.kt diff --git a/corbind-core/README.md b/corbind-core/README.md index 7defaeee..c28f9e48 100644 --- a/corbind-core/README.md +++ b/corbind-core/README.md @@ -13,7 +13,7 @@ dependencies { Component | Extension | Description --|---|-- -**NestedScrollView** | `scrollChangeEvents` | Called when the scroll position of a view changes. +**NestedScrollView** | [`scrollChangeEvents`][NestedScrollView_scrollChangeEvents] | Called when the scroll position of a view changes. ## Example @@ -26,3 +26,5 @@ scrollView.scrollChangeEvents() // Flow ``` More examples in source code + +[NestedScrollView_scrollChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-core/src/main/kotlin/ru/ldralighieri/corbind/core/NestedScrollViewScrollChangeEvents.kt diff --git a/corbind-drawerlayout/README.md b/corbind-drawerlayout/README.md index 09287b70..d587f94e 100644 --- a/corbind-drawerlayout/README.md +++ b/corbind-drawerlayout/README.md @@ -13,7 +13,7 @@ dependencies { Component | Extension | Description --|---|-- -**DrawerLayout** | `drawerOpens` | Called when a drawer has settled in a completely open or close state. +**DrawerLayout** | [`drawerOpens`][DrawerLayout_drawerOpens] | Called when a drawer has settled in a completely open or close state. ## Example @@ -28,3 +28,5 @@ drawer.drawerOpens() // Flow ``` More examples in source code + +[DrawerLayout_drawerOpens]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-drawerlayout/src/main/kotlin/ru/ldralighieri/corbind/drawerlayout/DrawerLayoutDrawerOpen.kt diff --git a/corbind-fragment/README.md b/corbind-fragment/README.md index dbd0fb43..c39b5ab0 100644 --- a/corbind-fragment/README.md +++ b/corbind-fragment/README.md @@ -13,7 +13,7 @@ dependencies { Component | Extension | Description --|---|-- -**FragmentManager** | `resultEvents` | Called when any results set by setFragmentResult using the same requestKey. +**FragmentManager** | [`resultEvents`][FragmentManager_resultEvents] | Called when any results set by setFragmentResult using the same requestKey. ## Simple examples @@ -30,3 +30,5 @@ lifecycleScope.launchWhenStarted { ``` More examples in source code + +[FragmentManager_resultEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-fragment/src/main/kotlin/ru/ldralighieri/corbind/fragment/FragmentManagerResultEvents.kt diff --git a/corbind-leanback/README.md b/corbind-leanback/README.md index 61bef54a..6dd70804 100644 --- a/corbind-leanback/README.md +++ b/corbind-leanback/README.md @@ -13,9 +13,9 @@ dependencies { Component | Extension | Description --|---|-- -**SearchBar** | `searchQueryChanges` | Called when the search bar detects a change in the query. -  | `searchQueryChangeEvents` | A more advanced version of the `searchQueryChanges`. -**SearchEditText** | `keyboardDismisses` | Called when the keyboard is dismissed. +**SearchBar** | [`searchQueryChanges`][SearchBar_searchQueryChanges] | Called when the search bar detects a change in the query. +  | [`searchQueryChangeEvents`][SearchBar_searchQueryChangeEvents] | A more advanced version of the `searchQueryChanges`. +**SearchEditText** | [`keyboardDismisses`][SearchEditText_keyboardDismisses] | Called when the keyboard is dismissed. ## Example @@ -29,3 +29,7 @@ search.searchQueryChanges() // Flow ``` More examples in source code + +[SearchBar_searchQueryChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-leanback/src/main/kotlin/ru/ldralighieri/corbind/leanback/SearchBarSearchQueryChanges.kt +[SearchBar_searchQueryChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-leanback/src/main/kotlin/ru/ldralighieri/corbind/leanback/SearchBarSearchQueryChangeEvents.kt +[SearchEditText_keyboardDismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-leanback/src/main/kotlin/ru/ldralighieri/corbind/leanback/SearchEditTextKeyboardDismisses.kt diff --git a/corbind-lifecycle/README.md b/corbind-lifecycle/README.md index 249c1948..ce48032d 100644 --- a/corbind-lifecycle/README.md +++ b/corbind-lifecycle/README.md @@ -13,7 +13,7 @@ dependencies { Component | Extension | Description --|---|-- -**Lifecycle** | `events` | Called when any lifecycle event change. +**Lifecycle** | [`events`][Lifecycle_events] | Called when any lifecycle event change. ## Simple examples @@ -27,3 +27,5 @@ lifecycle.events() // Flow ``` More examples in source code + +[Lifecycle_events]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-lifecycle/src/main/kotlin/ru/ldralighieri/corbind/lifecycle/LifecycleEvents.kt diff --git a/corbind-material/README.md b/corbind-material/README.md index d760abcd..bf9971a7 100644 --- a/corbind-material/README.md +++ b/corbind-material/README.md @@ -13,50 +13,50 @@ dependencies { Component | Extension | Description --|---|-- -**AppBarLayout** | `offsetChanges` | Called when the AppBarLayout's layout offset has been changed -**View**
(BottomSheetBehavior) | `slides` | Called when the bottom sheet is being dragged. -  | `stateChanges` | Called when the bottom sheet changes its state. -**Chip** | `closeIconClicks` | Called when the chip’s close icon is clicked. -**ChipGroup** | `checkedChanges` | Called when the checked chips are changed. -**View**
(HideBottomViewOnScrollBehavior) | `bottomViewScrollStateChanges` | Called when the bottom view changes its scrolled state. -**MaskableFrameLayout** | `maskChanges` | Called when changes in a mask's RectF occur. -**MaterialButton** | `checkedChanges` | Called when the checked state of a MaterialButton has changed. -**MaterialButtonToggleGroup** | `buttonCheckedChangeEvents` | Called when a `MaterialButton` in this group is checked or unchecked (only *not* in single selection mode). -  | `buttonCheckedChanges` | Called when a `MaterialButton` in this group is checked (only in single selection mode). -**MaterialCardView** | `checkedChanges` | Called when the card checked state changes. -**MaterialDatePicker** | `cancels` | Called when the user cancels the date picker via back button or a touch outside the view. It is not called when the user clicks the cancel button. To add a listener for use when the user clicks the cancel button, use `negativeClicks` extension. -  | `dismisses` | Called whenever the date picker is dismissed, no matter how it is dismissed. -  | `negativeClicks` | Called when the user clicks the date picker cancel button. -  | `positiveClicks` | Called when the user confirms a valid selection of the date. -**MaterialTimePicker** | `cancels` | Called when the user cancels the time picker via back button or a touch outside the view. It is not called when the user clicks the cancel button. To add a listener for use when the user clicks the cancel button, use `negativeClicks` extension. -  | `dismisses` | Called whenever the time picker is dismissed, no matter how it is dismissed. -  | `negativeClicks` | Called when the user clicks the time picker cancel button. -  | `positiveClicks` | Called when the user confirms a valid selection of the time. -**NavigationBarView** | `itemReselections` | Called when the currently selected navigation item is reselected. -  | `itemSelections`| Called when a navigation item is selected. -**NavigationView** | `itemSelections` | Called when an item in the navigation menu is selected. -**RangeSlider** | `touches` | Called when a range slider's touch event is being started/stopped. -  | `valuesChanges` | Called a range slider's value is changed. This is called for all existing values to check all the current values use. -  | `valuesChangeEvents` | A more advanced version of the `valuesChanges`. -**SearchBar** | `navigationClicks` | Called whenever the user clicks the navigation button at the start of the searchbar. -**SearchView** | `transitionStateChanges` | Called when the given `SearchView's` transition state has changed. -  | `transitionStateChangeEvents` | A more advanced version of the `transitionStateChanges`. -**View**
(SideSheetBehavior) | `sideSheetSlides` | Called when the side sheet is being dragged. -  | `sideSheetStateChanges` | Called when the side sheet changes its state. -**Slider** | `touches` | Called when a slider's touch event is being started/stopped. -  | `valueChanges` | Called a slider's value is changed. -  | `valueChangeEvents` | A more advanced version of the `valueChanges`. -**Snackbar** | `dismisses` | Called when the given Snackbar has been dismissed, either through a time-out, having been manually dismissed, or an action being clicked. -  | `shown` | Called when the given Snackbar is visible. -**View**
(SwipeDismissBehavior) | `dismisses` | Called when view has been dismissed via swiping. -  | `dragStateChanges` | Called when the drag state has changed. -**TabLayout** | `selections` | Called when a tab enters the selected state. -  | `selectionEvents` | A more advanced version of the `selections`. -**TextInputLayout** | `endIconChanges` | Called when the end icon changes. -  | `endIconClicks` | Called when the end icon is clicked. -  | `endIconLongClicks` | Called when the end icon is long clicked. -  | `startIconClicks` | Called when the start icon is clicked. -  | `startIconLongClicks` | Called when the start icon is long clicked. +**AppBarLayout** | [`offsetChanges`][AppBarLayout_offsetChanges] | Called when the AppBarLayout's layout offset has been changed +**View**
(BottomSheetBehavior) | [`slides`][BottomSheetBehavior_slides] | Called when the bottom sheet is being dragged. +  | [`stateChanges`][BottomSheetBehavior_stateChanges] | Called when the bottom sheet changes its state. +**Chip** | [`closeIconClicks`][Chip_closeIconClicks] | Called when the chip’s close icon is clicked. +**ChipGroup** | [`checkedChanges`][ChipGroup_checkedChanges] | Called when the checked chips are changed. +**View**
(HideBottomViewOnScrollBehavior) | [`bottomViewScrollStateChanges`][HideBottomViewOnScrollBehavior_bottomViewScrollStateChanges] | Called when the bottom view changes its scrolled state. +**MaskableFrameLayout** | [`maskChanges`][MaskableFrameLayout_maskChanges] | Called when changes in a mask's RectF occur. +**MaterialButton** | [`checkedChanges`][MaterialButton_checkedChanges] | Called when the checked state of a MaterialButton has changed. +**MaterialButtonToggleGroup** | [`buttonCheckedChangeEvents`][MaterialButtonToggleGroup_buttonCheckedChangeEvents] | Called when a `MaterialButton` in this group is checked or unchecked (only *not* in single selection mode). +  | [`buttonCheckedChanges`][MaterialButtonToggleGroup_buttonCheckedChanges] | Called when a `MaterialButton` in this group is checked (only in single selection mode). +**MaterialCardView** | [`checkedChanges`][MaterialCardView_checkedChanges] | Called when the card checked state changes. +**MaterialDatePicker** | [`cancels`][MaterialDatePicker_cancels] | Called when the user cancels the date picker via back button or a touch outside the view. It is not called when the user clicks the cancel button. To add a listener for use when the user clicks the cancel button, use `negativeClicks` extension. +  | [`dismisses`][MaterialDatePicker_dismisses] | Called whenever the date picker is dismissed, no matter how it is dismissed. +  | [`negativeClicks`][MaterialDatePicker_negativeClicks] | Called when the user clicks the date picker cancel button. +  | [`positiveClicks`][MaterialDatePicker_positiveClicks] | Called when the user confirms a valid selection of the date. +**MaterialTimePicker** | [`cancels`][MaterialTimePicker_cancels] | Called when the user cancels the time picker via back button or a touch outside the view. It is not called when the user clicks the cancel button. To add a listener for use when the user clicks the cancel button, use `negativeClicks` extension. +  | [`dismisses`][MaterialTimePicker_dismisses] | Called whenever the time picker is dismissed, no matter how it is dismissed. +  | [`negativeClicks`][MaterialTimePicker_negativeClicks] | Called when the user clicks the time picker cancel button. +  | [`positiveClicks`][MaterialTimePicker_positiveClicks] | Called when the user confirms a valid selection of the time. +**NavigationBarView** | [`itemReselections`][NavigationBarView_itemReselections] | Called when the currently selected navigation item is reselected. +  | [`itemSelections`][NavigationBarView_itemSelections] | Called when a navigation item is selected. +**NavigationView** | [`itemSelections`][NavigationView_itemSelections] | Called when an item in the navigation menu is selected. +**RangeSlider** | [`touches`][RangeSlider_touches] | Called when a range slider's touch event is being started/stopped. +  | [`valuesChanges`][RangeSlider_valuesChanges] | Called a range slider's value is changed. This is called for all existing values to check all the current values use. +  | [`valuesChangeEvents`][RangeSlider_valuesChangeEvents] | A more advanced version of the `valuesChanges`. +**SearchBar** | [`navigationClicks`][SearchBar_navigationClicks] | Called whenever the user clicks the navigation button at the start of the searchbar. +**SearchView** | [`transitionStateChanges`][SearchView_transitionStateChanges] | Called when the given `SearchView's` transition state has changed. +  | [`transitionStateChangeEvents`][SearchView_transitionStateChangeEvents] | A more advanced version of the `transitionStateChanges`. +**View**
(SideSheetBehavior) | [`sideSheetSlides`][SideSheetBehavior_sideSheetSlides] | Called when the side sheet is being dragged. +  | [`sideSheetStateChanges`][SideSheetBehavior_sideSheetStateChanges] | Called when the side sheet changes its state. +**Slider** | [`touches`][Slider_touches] | Called when a slider's touch event is being started/stopped. +  | [`valueChanges`][Slider_valueChanges] | Called a slider's value is changed. +  | [`valueChangeEvents`][Slider_valueChangeEvents] | A more advanced version of the `valueChanges`. +**Snackbar** | [`dismisses`][Snackbar_dismisses] | Called when the given Snackbar has been dismissed, either through a time-out, having been manually dismissed, or an action being clicked. +  | [`shown`][Snackbar_shown] | Called when the given Snackbar is visible. +**View**
(SwipeDismissBehavior) | [`dismisses`][SwipeDismissBehavior_dismisses] | Called when view has been dismissed via swiping. +  | [`dragStateChanges`][SwipeDismissBehavior_dragStateChanges] | Called when the drag state has changed. +**TabLayout** | [`selections`][TabLayout_selections] | Called when a tab enters the selected state. +  | [`selectionEvents`][TabLayout_selectionEvents] | A more advanced version of the `selections`. +**TextInputLayout** | [`endIconChanges`][TextInputLayout_endIconChanges] | Called when the end icon changes. +  | [`endIconClicks`][TextInputLayout_endIconClicks] | Called when the end icon is clicked. +  | [`endIconLongClicks`][TextInputLayout_endIconLongClicks] | Called when the end icon is long clicked. +  | [`startIconClicks`][TextInputLayout_startIconClicks] | Called when the start icon is clicked. +  | [`startIconLongClicks`][TextInputLayout_startIconLongClicks] | Called when the start icon is long clicked. ## Example @@ -69,3 +69,48 @@ chipGroup.checkedChanges() // Flow ``` More examples in source code + +[AppBarLayout_offsetChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/AppBarLayoutOffsetChanges.kt +[BottomSheetBehavior_slides]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/BottomSheetBehaviorSlides.kt +[BottomSheetBehavior_stateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/BottomSheetBehaviorStateChanges.kt +[Chip_closeIconClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/ChipCloseIconClicks.kt +[ChipGroup_checkedChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/ChipGroupCheckedChanges.kt +[HideBottomViewOnScrollBehavior_bottomViewScrollStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/HideBottomViewOnScrollBehaviorScrollStateChanges.kt +[MaskableFrameLayout_maskChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaskableFrameLayoutMaskChanges.kt +[MaterialButton_checkedChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialButtonCheckedChanges.kt +[MaterialButtonToggleGroup_buttonCheckedChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialButtonToggleGroupCheckedChangeEvents.kt +[MaterialButtonToggleGroup_buttonCheckedChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialButtonToggleGroupCheckedChanges.kt +[MaterialCardView_checkedChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialCardViewCheckedChanges.kt +[MaterialDatePicker_cancels]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialDatePickerCancels.kt +[MaterialDatePicker_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialDatePickerDismisses.kt +[MaterialDatePicker_negativeClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialDatePickerNegativeClicks.kt +[MaterialDatePicker_positiveClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialDatePickerPositiveClicks.kt +[MaterialTimePicker_cancels]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialTimePickerCancels.kt +[MaterialTimePicker_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialTimePickerDismisses.kt +[MaterialTimePicker_negativeClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialTimePickerNegativeClicks.kt +[MaterialTimePicker_positiveClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/MaterialTimePickerPositiveClicks.kt +[NavigationBarView_itemReselections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/NavigationBarViewItemReselections.kt +[NavigationBarView_itemSelections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/NavigationBarViewItemSelections.kt +[NavigationView_itemSelections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/NavigationViewItemSelections.kt +[RangeSlider_touches]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/RangeSliderTouches.kt +[RangeSlider_valuesChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/RangeSliderValuesChanges.kt +[RangeSlider_valuesChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/RangeSliderValuesChangeEvents.kt +[SearchBar_navigationClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SearchBarNavigationClicks.kt +[SearchView_transitionStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SearchViewTransitionStateChanges.kt +[SearchView_transitionStateChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SearchViewTransitionStateChangeEvents.kt +[SideSheetBehavior_sideSheetSlides]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SideSheetBehaviorSlides.kt +[SideSheetBehavior_sideSheetStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SideSheetBehaviorStateChanges.kt +[Slider_touches]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SliderTouches.kt +[Slider_valueChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SliderValueChanges.kt +[Slider_valueChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SliderValueChangeEvents.kt +[Snackbar_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SnackbarDismisses.kt +[Snackbar_shown]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SnackbarShown.kt +[SwipeDismissBehavior_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SwipeDismissBehaviorDesmisses.kt +[SwipeDismissBehavior_dragStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/SwipeDismissBehaviorDragStateChanges.kt +[TabLayout_selections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TabLayoutSelections.kt +[TabLayout_selectionEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TabLayoutSelectionEvents.kt +[TextInputLayout_endIconChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TextInputLayoutEndIconChanges.kt +[TextInputLayout_endIconClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TextInputLayoutEndIconClicks.kt +[TextInputLayout_endIconLongClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TextInputLayoutEndIconLongClicks.kt +[TextInputLayout_startIconClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TextInputLayoutStartIconClicks.kt +[TextInputLayout_startIconLongClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-material/src/main/kotlin/ru/ldralighieri/corbind/material/TextInputLayoutStartIconLongClicks.kt diff --git a/corbind-navigation/README.md b/corbind-navigation/README.md index 08e07edf..d05e476e 100644 --- a/corbind-navigation/README.md +++ b/corbind-navigation/README.md @@ -13,8 +13,8 @@ dependencies { Component | Extension | Description --|---|-- -**NavController** | `destinationChanges` | Called when the `NavController` destination or its arguments change. -  | `destinationChangeEvents` | A more advanced version of the `destinationChanges`. +**NavController** | [`destinationChanges`][NavController_destinationChanges] | Called when the `NavController` destination or its arguments change. +  | [`destinationChangeEvents`][NavController_destinationChangeEvents] | A more advanced version of the `destinationChanges`. ## Simple examples @@ -31,3 +31,6 @@ navController.destinationChanges() // Flow ``` More examples in source code + +[NavController_destinationChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-navigation/src/main/kotlin/ru/ldralighieri/corbind/navigation/NavControllerOnDestinationChanges.kt +[NavController_destinationChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-navigation/src/main/kotlin/ru/ldralighieri/corbind/navigation/NavControllerOnDestinationChangeEvents.kt diff --git a/corbind-recyclerview/README.md b/corbind-recyclerview/README.md index 96cd1f40..4983218f 100644 --- a/corbind-recyclerview/README.md +++ b/corbind-recyclerview/README.md @@ -13,11 +13,11 @@ dependencies { Component | Extension | Description --|---|-- -**RecyclerView** | `childAttachStateChangeEvents` | Called when a view is attached to or detached from the RecyclerView. -  | `flingEvents` | Handle a fling given the velocities in both x and y directions -  | `scrollEvents` | Called when a scrolling event has occurred on that RecyclerView. -  | `scrollStateChanges` | Called when RecyclerView's scroll state changes. -**RecyclerView.Adapter** | `dataChanges` | Called when the RecyclerView's adapter data has been changed | | +**RecyclerView.Adapter** | [`dataChanges`][RecyclerView_Adapte_dataChanges] | Called when the RecyclerView's adapter data has been changed +**RecyclerView** | [`childAttachStateChangeEvents`][RecyclerView_childAttachStateChangeEvents] | Called when a view is attached to or detached from the RecyclerView. +  | [`flingEvents`][RecyclerView_flingEvents] | Handle a fling given the velocities in both x and y directions +  | [`scrollEvents`][RecyclerView_scrollEvents] | Called when a scrolling event has occurred on that RecyclerView. +  | [`scrollStateChanges`][RecyclerView_scrollStateChanges] | Called when RecyclerView's scroll state changes. ## Example @@ -30,3 +30,9 @@ rv.scrollStateChanges() // Flow ``` More examples in source code + +[RecyclerView_Adapte_dataChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-recyclerview/src/main/kotlin/ru/ldralighieri/corbind/recyclerview/RecyclerAdapterDataChanges.kt +[RecyclerView_childAttachStateChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-recyclerview/src/main/kotlin/ru/ldralighieri/corbind/recyclerview/RecyclerViewChildAttachStateChangeEvents.kt +[RecyclerView_flingEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-recyclerview/src/main/kotlin/ru/ldralighieri/corbind/recyclerview/RecyclerViewFlingEvents.kt +[RecyclerView_scrollEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-recyclerview/src/main/kotlin/ru/ldralighieri/corbind/recyclerview/RecyclerViewScrollEvents.kt +[RecyclerView_scrollStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-recyclerview/src/main/kotlin/ru/ldralighieri/corbind/recyclerview/RecyclerViewScrollStateChanges.kt diff --git a/corbind-slidingpanelayout/README.md b/corbind-slidingpanelayout/README.md index a7ba7443..e90611d9 100644 --- a/corbind-slidingpanelayout/README.md +++ b/corbind-slidingpanelayout/README.md @@ -13,8 +13,8 @@ dependencies { Component | Extension | Description --|---|-- -**SlidingPaneLayoutr** | `panelOpens` | Called when a sliding pane becomes slid completely open or closed. -  | `panelSlides` | Called when a sliding pane's position changes. +**SlidingPaneLayout** | [`panelOpens`][SlidingPaneLayout_panelOpens] | Called when a sliding pane becomes slid completely open or closed. +  | [`panelSlides`][SlidingPaneLayout_panelSlides] | Called when a sliding pane's position changes. ## Example @@ -29,3 +29,6 @@ slider.panelOpens() // Flow ``` More examples in source code + +[SlidingPaneLayout_panelOpens]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-slidingpanelayout/src/main/kotlin/ru/ldralighieri/corbind/slidingpanelayout/SlidingPaneLayoutPaneOpens.kt +[SlidingPaneLayout_panelSlides]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-slidingpanelayout/src/main/kotlin/ru/ldralighieri/corbind/slidingpanelayout/SlidingPaneLayoutSlides.kt diff --git a/corbind-swiperefreshlayout/README.md b/corbind-swiperefreshlayout/README.md index 70458ba8..358edb87 100644 --- a/corbind-swiperefreshlayout/README.md +++ b/corbind-swiperefreshlayout/README.md @@ -13,7 +13,7 @@ dependencies { Component | Extension | Description --|---|-- -**SwipeRefreshLayout** | `refreshes` | Called when a swipe gesture triggers a refresh. open or closed. +**SwipeRefreshLayout** | [`refreshes`][SwipeRefreshLayout_refreshes] | Called when a swipe gesture triggers a refresh. open or closed. ## Example @@ -26,3 +26,5 @@ swipe.refreshes() // Flow ``` More examples in source code + +[SwipeRefreshLayout_refreshes]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-swiperefreshlayout/src/main/kotlin/ru/ldralighieri/corbind/swiperefreshlayout/SwipeRefreshLayoutRefreshes.kt diff --git a/corbind-viewpager/README.md b/corbind-viewpager/README.md index 707bbf2f..f64b40e1 100644 --- a/corbind-viewpager/README.md +++ b/corbind-viewpager/README.md @@ -13,9 +13,9 @@ dependencies { Component | Extension | Description --|---|-- -**ViewPager** | `pageScrollEvents` | Called when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll. -  | `pageScrollStateChanges` | Called when the scroll state changes. -  | `pageSelections` | Called when a new page becomes selected. +**ViewPager** | [`pageScrollEvents`][ViewPager_pageScrollEvents] | Called when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll. +  | [`pageScrollStateChanges`][ViewPager_pageScrollStateChanges] | Called when the scroll state changes. +  | [`pageSelections`][ViewPager_pageSelections] | Called when a new page becomes selected. ## Example @@ -28,3 +28,7 @@ vpSlides.pageSelections() // Flow ``` More examples in source code + +[ViewPager_pageScrollEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-viewpager/src/main/kotlin/ru/ldralighieri/corbind/viewpager/ViewPagerPageScrollEvents.kt +[ViewPager_pageScrollStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-viewpager/src/main/kotlin/ru/ldralighieri/corbind/viewpager/ViewPagerPageScrollStateChanges.kt +[ViewPager_pageSelections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-viewpager/src/main/kotlin/ru/ldralighieri/corbind/viewpager/ViewPagerPageSelections.kt diff --git a/corbind-viewpager2/README.md b/corbind-viewpager2/README.md index 0cc1e713..7f4b22a2 100644 --- a/corbind-viewpager2/README.md +++ b/corbind-viewpager2/README.md @@ -13,9 +13,9 @@ dependencies { Component | Extension | Description --|---|-- -**ViewPager2** | `pageScrollEvents` | Called when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll. -  | `pageScrollStateChanges` | Called when the scroll state changes. -  | `pageSelections` | Called when a new page becomes selected. +**ViewPager2** | [`pageScrollEvents`][ViewPager2_pageScrollEvents] | Called when the current page is scrolled, either as part of a programmatically initiated smooth scroll or a user initiated touch scroll. +  | [`pageScrollStateChanges`][ViewPager2_pageScrollStateChanges] | Called when the scroll state changes. +  | [`pageSelections`][ViewPager2_pageSelections] | Called when a new page becomes selected. ## Simple examples @@ -28,3 +28,7 @@ vpSlides.pageSelections() // Flow ``` More examples in source code + +[ViewPager2_pageScrollEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-viewpager2/src/main/kotlin/ru/ldralighieri/corbind/viewpager2/ViewPager2PageScrollEvents.kt +[ViewPager2_pageScrollStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-viewpager2/src/main/kotlin/ru/ldralighieri/corbind/viewpager2/ViewPager2PageScrollStateChanges.kt +[ViewPager2_pageSelections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind-viewpager2/src/main/kotlin/ru/ldralighieri/corbind/viewpager2/ViewPager2PageSelections.kt diff --git a/corbind/README.md b/corbind/README.md index fd2c7355..4d3547d2 100644 --- a/corbind/README.md +++ b/corbind/README.md @@ -14,77 +14,78 @@ dependencies { ### app Component | Extension | Description --|---|-- -**DatePickerDialog** | `dateSetEvents` | Called when the user sets the date +**DatePickerDialog** | [`dateSetEvents`][DatePickerDialog_dateSetEvents] | Called when the user sets the date ### content Component | Extension | Description --|---|-- -**Context** | `receivesBroadcast` | Called with any broadcast Intent that matches filter +**Context** | [`receivesBroadcast`][Context_receivesBroadcast] | Called with any broadcast Intent that matches filter ### view Component | Extension | Description --|---|-- -**View** | `attachEvents` | Called when the view is attached to a window. -  | `detaches` | Called when the view is detached from a window. -  | `clicks` | Called when a view has been clicked. -  | `drags` | Called when a drag event is dispatched to a view. -  | `focusChanges` | Called when the focus state of a view has changed. -  | `hovers` | Called when a hover event is dispatched to a view. -  | `keys` | Called when a hardware key is dispatched to a view. -  | `layoutChanges` | Called when the layout bounds of a view changes due to layout processing. -  | `layoutChangeEvents` | A more advanced version of the `layoutChanges`. -  | `longClicks` | Called when a view has been clicked and held. -  | `scrollChangeEvents` | Called when the scroll position of a view changes. -  | `systemUiVisibilityChanges` | Called when the status bar changes visibility because of a call to View#setSystemUiVisibility(int). `Deprecated, use windowInsetsApplyEvents`. -  | `touches` | Called when a touch event is dispatched to a view. -  | `draws` | Called when the view tree is about to be drawn. -  | `globalLayouts` | Called when the global layout state or the visibility of views within the view tree changes. -  | `preDraws` | Callback method to be invoked when the view tree is about to be drawn. -  | `windowInsetsApplyEvents` | Called when window insets applying on a view in a custom way. -**ViewGroup** | `changeEvents` | Called when the hierarchy within this view changed. The hierarchy changes whenever a child is added to or removed from this view. -**MenuItem** | `actionViewEvents` | Called when a menu item is collapsed or collapsed. -  | `clicks` | Called when a menu item has been invoked. +**View** | [`attachEvents`][View_attachEvents] | Called when the view is attached to a window. +  | [`attaches`][View_attaches] | Called when the view is attached to a window. +  | [`detaches`][View_detaches] | Called when the view is detached from a window. +  | [`clicks`][View_clicks] | Called when a view has been clicked. +  | [`drags`][View_drags] | Called when a drag event is dispatched to a view. +  | [`focusChanges`][View_focusChanges] | Called when the focus state of a view has changed. +  | [`hovers`][View_hovers] | Called when a hover event is dispatched to a view. +  | [`keys`][View_keys] | Called when a hardware key is dispatched to a view. +  | [`layoutChanges`][View_layoutChanges] | Called when the layout bounds of a view changes due to layout processing. +  | [`layoutChangeEvents`][View_layoutChangeEvents] | A more advanced version of the `layoutChanges`. +  | [`longClicks`][View_longClicks] | Called when a view has been clicked and held. +  | [`scrollChangeEvents`][View_scrollChangeEvents] | Called when the scroll position of a view changes. +  | [`systemUiVisibilityChanges`][View_systemUiVisibilityChanges] | Called when the status bar changes visibility because of a call to View#setSystemUiVisibility(int). `Deprecated, use windowInsetsApplyEvents`. +  | [`touches`][View_touches] | Called when a touch event is dispatched to a view. +  | [`draws`][View_draws] | Called when the view tree is about to be drawn. +  | [`globalLayouts`][View_globalLayouts] | Called when the global layout state or the visibility of views within the view tree changes. +  | [`preDraws`][View_preDraws] | Callback method to be invoked when the view tree is about to be drawn. +  | [`windowInsetsApplyEvents`][View_windowInsetsApplyEvents] | Called when window insets applying on a view in a custom way. +**ViewGroup** | [`changeEvents`][ViewGroup_changeEvents] | Called when the hierarchy within this view changed. The hierarchy changes whenever a child is added to or removed from this view. +**MenuItem** | [`actionViewEvents`][MenuItem_actionViewEvents] | Called when a menu item is collapsed or collapsed. +  | [`clicks`][MenuItem_clicks] | Called when a menu item has been invoked. ### widget Component | Extension | Description --|---|-- -**AbsListView** | `scrollEvents` | Called when the list or grid has been scrolled. -**Adapter** | `dataChanges` | Called when a data set has been changed -  | `itemClicks` | Called when an item in this AdapterView has been clicked. -  | `itemClickEvents` | A more advanced version of the `itemClicks`. -  | `itemLongClicks` | Called when an item in this view has been clicked and held. -  | `itemLongClickEvents` | A more advanced version of the `itemLongClicks`. -  | `itemSelections` | Called when an item in this view has been selected. -  | `selectionEvents` | A more advanced version of the `itemSelections`. -**AutoCompleteTextView** | `dismisses` | Called whenever the AutoCompleteTextView's list of completion options has been dismissed. -  | `itemClickEvents` | Called when an item in AdapterView has been clicked. -**CalendarView** | `dateChangeEvents` | Called upon change of the selected day. -**CompoundButton** | `checkedChanges` | Called when the checked state of a compound button has changed. -**DatePicker** | `dateChangeEvents` | Called upon a date change. -**NumberPicker** | `scrollStateChanges` | Called when number picker scroll state has changed. -  | `valueChangeEvents` | Called upon a change of the current value. -**PopupMenu** | `dismisses` | Called when the associated menu has been dismissed. -  | `itemClicks` | Called when a menu item is clicked if the item itself did not already handle the event. -**RadioGroup** | `checkedChanges` | Called when the checked radio button has changed. -**RatingBar** | `ratingChanges` | Called when the rating has changed. -  | `ratingChangeEvents` | A more advanced version of the `ratingChanges`. -**SearchView** | `queryTextChanges` | Called when the query text is changed. -  | `queryTextChangeEvents` | A more advanced version of the `queryTextChanges`. -**SeekBar** | `changes` | Called when the progress level has changed. -  | `userChanges` | Called when the progress level has changed by user. -  | `systemChanges` | Called when the progress level has changed by system. -  | `changeEvents` | A more advanced version of previous events. -**TextView** | `textChanges` | Called when the text has changed. -  | `textChangeEvents` | A more advanced version of the `textChanges`. -  | `afterTextChangeEvents` | Called after text has been changed. -  | `beforeTextChangeEvents` | Called before text has been changed. -  | `editorActions` | Called when an action is performed on the editor. -  | `editorActionEvents` | A more advanced version of the `editorActions`. -**TimePicker** | `timeChangeEvents` | Called when time has been adjusted. -**Toolbar** | `itemClicks` | Called when a menu item is clicked if the item itself did not already handle the event. -  | `navigationClicks` | Called whenever the user clicks the navigation button at the start of the toolbar. +**AbsListView** | [`scrollEvents`][AbsListView_scrollEvents] | Called when the list or grid has been scrolled. +**Adapter** | [`dataChanges`][Adapter_dataChanges] | Called when a data set has been changed +**AdapterView** | [`itemClicks`][AdapterView_itemClicks] | Called when an item in this AdapterView has been clicked. +  | [`itemClickEvents`][AdapterView_itemClickEvents] | A more advanced version of the `itemClicks`. +  | [`itemLongClicks`][AdapterView_itemLongClicks] | Called when an item in this view has been clicked and held. +  | [`itemLongClickEvents`][AdapterView_itemLongClickEvents] | A more advanced version of the `itemLongClicks`. +  | [`itemSelections`][AdapterView_itemSelections] | Called when an item in this view has been selected. +  | [`selectionEvents`][AdapterView_selectionEvents] | A more advanced version of the `itemSelections`. +**AutoCompleteTextView** | [`dismisses`][AutoCompleteTextView_dismisses] | Called whenever the AutoCompleteTextView's list of completion options has been dismissed. +  | [`itemClickEvents`][AutoCompleteTextView_itemClickEvents] | Called when an item in AdapterView has been clicked. +**CalendarView** | [`dateChangeEvents`][CalendarView_dateChangeEvents] | Called upon change of the selected day. +**CompoundButton** | [`checkedChanges`][CompoundButton_checkedChanges] | Called when the checked state of a compound button has changed. +**DatePicker** | [`dateChangeEvents`][DatePicker_dateChangeEvents] | Called upon a date change. +**NumberPicker** | [`scrollStateChanges`][NumberPicker_scrollStateChanges] | Called when number picker scroll state has changed. +  | [`valueChangeEvents`][NumberPicker_valueChangeEvents] | Called upon a change of the current value. +**PopupMenu** | [`dismisses`][PopupMenu_dismisses] | Called when the associated menu has been dismissed. +  | [`itemClicks`][PopupMenu_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event. +**RadioGroup** | [`checkedChanges`][RadioGroup_checkedChanges] | Called when the checked radio button has changed. +**RatingBar** | [`ratingChanges`][RatingBar_ratingChanges] | Called when the rating has changed. +  | [`ratingChangeEvents`][RatingBar_ratingChangeEvents] | A more advanced version of the `ratingChanges`. +**SearchView** | [`queryTextChanges`][SearchView_queryTextChanges] | Called when the query text is changed. +  | [`queryTextChangeEvents`][SearchView_queryTextChangeEvents] | A more advanced version of the `queryTextChanges`. +**SeekBar** | [`changes`][SeekBar_changes] | Called when the progress level has changed. +  | [`userChanges`][SeekBar_userChanges] | Called when the progress level has changed by user. +  | [`systemChanges`][SeekBar_systemChanges] | Called when the progress level has changed by system. +  | [`changeEvents`][SeekBar_changeEvents] | A more advanced version of previous events. +**TextView** | [`textChanges`][TextView_textChanges] | Called when the text has changed. +  | [`textChangeEvents`][TextView_textChangeEvents] | A more advanced version of the `textChanges`. +  | [`afterTextChangeEvents`][TextView_afterTextChangeEvents] | Called after text has been changed. +  | [`beforeTextChangeEvents`][TextView_beforeTextChangeEvents] | Called before text has been changed. +  | [`editorActions`][TextView_editorActions] | Called when an action is performed on the editor. +  | [`editorActionEvents`][TextView_editorActionEvents] | A more advanced version of the `editorActions`. +**TimePicker** | [`timeChangeEvents`][TimePicker_timeChangeEvents] | Called when time has been adjusted. +**Toolbar** | [`itemClicks`][Toolbar_itemClicks] | Called when a menu item is clicked if the item itself did not already handle the event. +  | [`navigationClicks`][Toolbar_navigationClicks] | Called whenever the user clicks the navigation button at the start of the toolbar. ## Examples @@ -147,3 +148,69 @@ window.decorView.windowInsetsApplyEvents() // Flow ``` More examples in source code + +[//]: # (app) +[DatePickerDialog_dateSetEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/app/DatePickerDialogDateSetEvents.kt + +[//]: # (content) +[Context_receivesBroadcast]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/content/ContextReceivesBroadcast.kt + +[//]: # (view) +[View_attachEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewAttachEvents.kt +[View_attaches]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewAttaches.kt#L40 +[View_detaches]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewAttaches.kt#L118 +[View_clicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewClicks.kt +[View_drags]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewDrags.kt +[View_focusChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewFocusChanges.kt +[View_hovers]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewHovers.kt +[View_keys]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewKeys.kt +[View_layoutChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewLayoutChanges.kt +[View_layoutChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewLayoutChangeEvents.kt +[View_longClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewLongClicks.kt +[View_scrollChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewScrollChangeEvents.kt +[View_systemUiVisibilityChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewSystemUiVisibilityChanges.kt +[View_touches]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewTouches.kt +[View_draws]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewTreeObserverDraws.kt +[View_globalLayouts]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewTreeObserverGlobalLayouts.kt +[View_preDraws]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewTreeObserverPreDraws.kt +[View_windowInsetsApplyEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewWindowInsetsApplyEvents.kt +[ViewGroup_changeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/ViewGroupHierarchyChangeEvents.kt +[MenuItem_actionViewEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/MenuItemActionViewEvents.kt +[MenuItem_clicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/view/MenuItemClicks.kt + +[//]: # (widget) +[AbsListView_scrollEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AbsListViewScrollEvents.kt +[Adapter_dataChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterDataChanges.kt +[AdapterView_itemClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterViewItemClicks.kt +[AdapterView_itemClickEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterViewItemClickEvents.kt +[AdapterView_itemLongClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterViewItemLongClicks.kt +[AdapterView_itemLongClickEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterViewItemLongClickEvents.kt +[AdapterView_itemSelections]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterViewItemSelections.kt +[AdapterView_selectionEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AdapterViewSelectionEvents.kt +[AutoCompleteTextView_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AutoCompleteTextViewDismisses.kt +[AutoCompleteTextView_itemClickEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/AutoCompleteTextViewItemClickEvents.kt +[CalendarView_dateChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/CalendarViewDateChangeEvents.kt +[CompoundButton_checkedChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/CompoundButtonCheckedChanges.kt +[DatePicker_dateChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/DatePickerChangedEvents.kt +[NumberPicker_scrollStateChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/NumberPickerScrollStateChanges.kt +[NumberPicker_valueChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/NumberPickerValueChangeEvents.kt +[PopupMenu_dismisses]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/PopupMenuDismisses.kt +[PopupMenu_itemClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/PopupMenuItemClicks.kt +[RadioGroup_checkedChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/RadioGroupCheckedChanges.kt +[RatingBar_ratingChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/RatingBarRatingChanges.kt +[RatingBar_ratingChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/RatingBarRatingChangeEvents.kt +[SearchView_queryTextChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/SearchViewQueryTextChanges.kt +[SearchView_queryTextChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/SearchViewQueryTextChangeEvents.kt +[SeekBar_changes]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/SeekBarChanges.kt#L34 +[SeekBar_userChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/SeekBarChanges.kt#L168 +[SeekBar_systemChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/SeekBarChanges.kt#L253 +[SeekBar_changeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/SeekBarChangeEvents.kt +[TextView_textChanges]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TextViewTextChanges.kt +[TextView_textChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TextViewTextChangeEvents.kt +[TextView_afterTextChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TextViewAfterTextChangeEvents.kt +[TextView_beforeTextChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TextViewBeforeTextChangeEvents.kt +[TextView_editorActions]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TextViewEditorActions.kt +[TextView_editorActionEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TextViewEditorActionEvents.kt +[TimePicker_timeChangeEvents]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/TimePickerChangedEvents.kt +[Toolbar_itemClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/ToolbarItemClicks.kt +[Toolbar_navigationClicks]: https://github.com/LDRAlighieri/Corbind/blob/master/corbind/src/main/kotlin/ru/ldralighieri/corbind/widget/ToolbarNavigationClicks.kt From 63a1a005e4fa759b5e3a0ffb7f2c6db4e1ab1e4c Mon Sep 17 00:00:00 2001 From: Vladimir Raupov Date: Thu, 15 Jun 2023 21:14:35 +0300 Subject: [PATCH 2/3] Add jvmToolchain --- .../corbind/Project+configureKotlinAndroid.kt | 18 ++++++--- build.gradle.kts | 40 ------------------- gradle/libs.versions.toml | 2 - 3 files changed, 12 insertions(+), 48 deletions(-) diff --git a/build-logic/convention/src/main/kotlin/ru/ldralighieri/corbind/Project+configureKotlinAndroid.kt b/build-logic/convention/src/main/kotlin/ru/ldralighieri/corbind/Project+configureKotlinAndroid.kt index 233aad71..30fbf613 100644 --- a/build-logic/convention/src/main/kotlin/ru/ldralighieri/corbind/Project+configureKotlinAndroid.kt +++ b/build-logic/convention/src/main/kotlin/ru/ldralighieri/corbind/Project+configureKotlinAndroid.kt @@ -22,7 +22,9 @@ import com.android.build.api.dsl.CommonExtension import org.gradle.api.JavaVersion import org.gradle.api.Project import org.gradle.api.plugins.ExtensionAware +import org.gradle.kotlin.dsl.configure import org.gradle.kotlin.dsl.provideDelegate +import org.jetbrains.kotlin.gradle.dsl.KotlinAndroidProjectExtension import org.jetbrains.kotlin.gradle.dsl.KotlinJvmOptions internal fun Project.configureKotlinAndroid( @@ -38,25 +40,29 @@ internal fun Project.configureKotlinAndroid( this.minSdk = minSdk.toInt() } + kotlin { + jvmToolchain(17) + } + + // Remove this after https://issuetracker.google.com/issues/260059413 is fixed + // https://kotlinlang.org/docs/gradle-configure-project.html#gradle-java-toolchains-support compileOptions { sourceCompatibility = JavaVersion.VERSION_17 targetCompatibility = JavaVersion.VERSION_17 } kotlinOptions { - jvmTarget = JavaVersion.VERSION_17.toString() - - // Treat all Kotlin warnings as errors allWarningsAsErrors = true - freeCompilerArgs = freeCompilerArgs + listOf( - "-opt-in=kotlinx.coroutines.ObsoleteCoroutinesApi", - "-opt-in=kotlinx.coroutines.ExperimentalCoroutinesApi" + "-opt-in=kotlinx.coroutines.ObsoleteCoroutinesApi" ) } } } +private fun Project.kotlin(action: KotlinAndroidProjectExtension.() -> Unit) = + extensions.configure(action) + private fun CommonExtension<*, *, *, *>.kotlinOptions(block: KotlinJvmOptions.() -> Unit) { (this as ExtensionAware).extensions.configure("kotlinOptions", block) } diff --git a/build.gradle.kts b/build.gradle.kts index d7945622..03d6bf0e 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -15,10 +15,7 @@ */ import com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask -import io.gitlab.arturbosch.detekt.Detekt -// https://youtrack.jetbrains.com/issue/KTIJ-19369 -@Suppress("DSL_SCOPE_VIOLATION") plugins { alias(libs.plugins.android.application) apply false alias(libs.plugins.android.library) apply false @@ -26,7 +23,6 @@ plugins { alias(libs.plugins.spotless) apply false alias(libs.plugins.maven.publish) apply false alias(libs.plugins.binary.compatibility.validator) - alias(libs.plugins.detekt) alias(libs.plugins.gver) } @@ -36,42 +32,6 @@ apiValidation { ignoredPackages.add("ru/ldralighieri/corbind/internal") } -// Detekt -detekt { - allRules = false - buildUponDefaultConfig = true - - config = files("default-detekt-config.yml") - source = files( - "corbind/src/main/kotlin", - "corbind-activity/src/main/kotlin", - "corbind-appcompat/src/main/kotlin", - "corbind-core/src/main/kotlin", - "corbind-drawerlayout/src/main/kotlin", - "corbind-fragment/src/main/kotlin", - "corbind-leanback/src/main/kotlin", - "corbind-lifecycle/src/main/kotlin", - "corbind-material/src/main/kotlin", - "corbind-navigation/src/main/kotlin", - "corbind-recyclerview/src/main/kotlin", - "corbind-slidingpanelayout/src/main/kotlin", - "corbind-swiperefreshlayout/src/main/kotlin", - "corbind-viewpager/src/main/kotlin", - "corbind-viewpager2/src/main/kotlin" - ) - parallel = true -} - -tasks.withType().configureEach { - jvmTarget = JavaVersion.VERSION_17.toString() - reports { - html.required.set(true) - xml.required.set(false) - txt.required.set(false) - sarif.required.set(false) - } -} - // Dependency updates fun isNonStable(version: String): Boolean { val stableKeyword = listOf("RELEASE", "FINAL").any { version.contains(it) } diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 3da9c02d..aed63b23 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -5,7 +5,6 @@ dokka = "1.8.10" spotless = "6.18.0" mavenPublish = "0.25.2" bcv = "0.13.1" -detekt = "1.22.0" gver = "0.46.0" # Kotlin @@ -75,5 +74,4 @@ kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" } spotless = { id = "com.diffplug.spotless", version.ref = "spotless" } maven-publish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" } binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "bcv" } -detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" } gver = { id = "com.github.ben-manes.versions", version.ref = "gver" } From b612aa93579247ecd059fd2d9f529e7a2f64288c Mon Sep 17 00:00:00 2001 From: Vladimir Raupov Date: Thu, 15 Jun 2023 21:18:07 +0300 Subject: [PATCH 3/3] Add "check spotless" step for github actions --- .github/workflows/build.yml | 3 +++ .github/workflows/publish.yml | 3 +++ 2 files changed, 6 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 780196f3..1211d0ae 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,5 +21,8 @@ jobs: - name: Setup Gradle uses: gradle/gradle-build-action@v2.4.2 + - name: Check spotless + run: ./gradlew spotlessCheck --no-configuration-cache + - name: Build the sample app to verify it works run: ./gradlew sample:assemble diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 2433e5a7..45cf350a 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -23,6 +23,9 @@ jobs: - name: Setup Gradle uses: gradle/gradle-build-action@v2.4.2 + - name: Check spotless + run: ./gradlew spotlessCheck --no-configuration-cache + - name: Build the sample app to verify it works run: ./gradlew sample:assemble