ScrollView

public class ScrollView : View

Wrapper of UIScrollView

  • the node behind the ScrollView

    Declaration

    Swift

    public var node: ArgoKitNode? { get }

  • Undocumented

    Declaration

    Swift

    required public init()

  • init the ScrollView

    Declaration

    Swift

    public convenience init(@ArgoKitListBuilder content: @escaping () -> View)

    Parameters

    builder

    view builder used for ScrollView ArgoKitListBuilder

  • Called when the adjusted content insets of the scroll view change.

    Declaration

    Swift

    @available(iOS 11.0, *)
@discardableResult
public func adjustedContentInsetDidChange() -> Self

    Return Value

    self

  • Call the flashScrollIndicators of the UIScrollView behind the wrapper.

    Displays the scroll indicators momentarily.

    Declaration

    Swift

    @discardableResult
public func flashScrollIndicators() -> Self

    Return Value

    self

  • Set the callback called when the user scrolls the content view within the receiver.

    Declaration

    Swift

    @discardableResult
public func didScroll(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    the callback

    Return Value

    self

  • Set the callback called when the user scrolls the content view within the receiver.

    Declaration

    Swift

    public func didScroll(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    the callback with UIScrollView

    Return Value

    self

  • Set the callback called when the scroll view’s zoom factor changed.

    Declaration

    Swift

    @discardableResult
public func didZoom(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when the scroll view’s zoom factor changed.

    Declaration

    Swift

    @discardableResult
public func didZoom(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called when the scroll view is about to start scrolling the content.

    Declaration

    Swift

    @discardableResult
public func willBeginDragging(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when the scroll view is about to start scrolling the content.

    Declaration

    Swift

    @discardableResult
public func willBeginDragging(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called when the user finishes scrolling the content.

    Declaration

    Swift

    @discardableResult
public func willEndDragging(_ action: @escaping (_ velocity: CGPoint, _ targetContentOffset: UnsafeMutablePointer<CGPoint>) -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when dragging ended in the scroll view.

    Declaration

    Swift

    @discardableResult
public func didEndDragging(_ action: @escaping (_ decelerate: Bool) -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when the scroll view is starting to decelerate the scrolling movement.

    Declaration

    Swift

    @discardableResult
public func willBeginDecelerating(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when the scroll view is starting to decelerate the scrolling movement.

    Declaration

    Swift

    @discardableResult
public func willBeginDecelerating(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the calback called when the scroll view has ended decelerating the scrolling movement.

    Declaration

    Swift

    @discardableResult
public func didEndDecelerating(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the calback called when the scroll view has ended decelerating the scrolling movement.

    Declaration

    Swift

    @discardableResult
public func didEndDecelerating(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called when a scrolling animation in the scroll view concludes.

    Declaration

    Swift

    @discardableResult
@objc
public func didEndScrollingAnimation(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when a scrolling animation in the scroll view concludes.

    Declaration

    Swift

    @discardableResult
public func didEndScrollingAnimation(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called for the view to scale when zooming is about to occur in the scroll view.

    Declaration

    Swift

    @discardableResult
public func viewForZooming(_ action: @escaping () -> UIView?) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called for the view to scale when zooming is about to occur in the scroll view.

    Declaration

    Swift

    @discardableResult
public func viewForZooming(_ action: @escaping (UIScrollView?) -> UIView?) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called when zooming of the content in the scroll view is about to commence.

    Declaration

    Swift

    @discardableResult
public func willBeginZooming(_ action: @escaping (_ view: UIView?) -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when zooming of the content in the scroll view completed.

    Declaration

    Swift

    @discardableResult
public func didEndZooming(_ action: @escaping (_ view: UIView?, _ atScale: Float) -> Void?) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the calback that returns the Boolean value. to determine if the scroll view should scroll to the top of the content.

    Declaration

    Swift

    @discardableResult
public func shouldScrollToTop(_ action: @escaping () -> Bool) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the calback that returns the Boolean value. to determine if the scroll view should scroll to the top of the content.

    Declaration

    Swift

    @discardableResult
public func shouldScrollToTop(_ action: @escaping (UIScrollView?) -> Bool) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called when the scroll view scrolled to the top of the content.

    Declaration

    Swift

    @discardableResult
public func didScrollToTop(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when the scroll view scrolled to the top of the content.

    Declaration

    Swift

    @discardableResult
public func didScrollToTop(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Set the callback called when the scroll view’s inset values changed.

    Declaration

    Swift

    @available(iOS 11.0, *)
@discardableResult
public func didChangeAdjustedContentInset(_ action: @escaping () -> Void) -> Self

    Parameters

    action

    callback

    Return Value

    self

  • Set the callback called when the scroll view’s inset values changed.

    Declaration

    Swift

    @available(iOS 11.0, *)
@discardableResult
public func didChangeAdjustedContentInset(_ action: @escaping (UIScrollView?) -> Void) -> Self

    Parameters

    action

    callback with UIScrollView

    Return Value

    self

  • Returns whether the user has touched the content to initiate scrolling.

    Declaration

    Swift

    public func isTracking() -> Bool

    Return Value

    YES if user has touched. may not yet have started dragging

  • A Boolean value that indicates whether the user has begun scrolling the content.

    Declaration

    Swift

    public func isDragging() -> Bool

    Return Value

    YES if user has started scrolling. this may require some time and or distance to move to initiate dragging

  • Returns whether the content is moving in the scroll view after the user lifted their finger.

    Declaration

    Swift

    public func isDecelerating() -> Bool

    Return Value

    YES if user isn’t dragging (touch up) but scroll view is still moving