Documentation for avoid keyboard modifier

apptekstudios · web-flow · commit a920d02fb157 · 2020-12-15T11:09:29.000+10:00
diff --git a/Sources/ASCollectionView/ASCollectionView+Modifiers.swift b/Sources/ASCollectionView/ASCollectionView+Modifiers.swift
@@ -133,7 +133,8 @@ public extension ASCollectionView
 		return this
 	}
     
-    /// Set whether the ASCollectionView should dodge the system keyboard
+    /// Set whether the ASCollectionView should scroll the collection view in order to keep the current input field visible when the system keyboard appears.
+    /// The default value is `true`
     func shouldAvoidKeyboard(_ avoidKeyboard: Bool = true) -> Self {
         var this = self
         this.dodgeKeyboard = avoidKeyboard

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,8 @@ public extension ASCollectionView`
`133`	`133`	`return this`
`134`	`134`	`}`
`135`	`135`
`136`		`- /// Set whether the ASCollectionView should dodge the system keyboard`
	`136`	`+ /// Set whether the ASCollectionView should scroll the collection view in order to keep the current input field visible when the system keyboard appears.`
	`137`	+ /// The default value is `true`
`137`	`138`	`func shouldAvoidKeyboard(_ avoidKeyboard: Bool = true) -> Self {`
`138`	`139`	`var this = self`
`139`	`140`	`this.dodgeKeyboard = avoidKeyboard`