From 892a66c9b06d320b27ed7f6465b16f6f47d684f9 Mon Sep 17 00:00:00 2001 From: mrustaa Date: Wed, 10 Jun 2020 01:44:49 +0300 Subject: [PATCH] release 1.0.3 update readme.md --- ContainerControllerSwift.podspec | 5 +- README.md | 431 ++++++++++++++++++++++++++++++- 2 files changed, 424 insertions(+), 12 deletions(-) diff --git a/ContainerControllerSwift.podspec b/ContainerControllerSwift.podspec index 8928851..7401eaf 100644 --- a/ContainerControllerSwift.podspec +++ b/ContainerControllerSwift.podspec @@ -8,7 +8,7 @@ Pod::Spec.new do |s| s.name = 'ContainerControllerSwift' - s.version = '1.0.2' + s.version = '1.0.3' s.summary = 'This is a swipe-panel from application: https://www.apple.com/ios/maps/' # This description is used to generate tags and improve search results. @@ -33,7 +33,8 @@ TODO: Add long description of the pod here. s.ios.deployment_target = '13.0' s.source_files = 'ContainerControllerSwift/*.{swift}' - s.source_files = 'ContainerControllerSwift/**/*.{swift}' + s.source_files = 'ContainerControllerSwift/ContainerTable/*.{swift}' + s.source_files = 'ContainerControllerSwift/ContainerCollection/*.{swift}' # s.resource_bundles = { # 'ContainerControllerSwift' => ['ContainerControllerSwift/Assets/*.png'] diff --git a/README.md b/README.md index 2136582..e16f9af 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,43 @@ -# ContainerControllerSwift - -[![CI Status](https://img.shields.io/travis/rustamburger@gmail.com/ContainerControllerSwift.svg?style=flat)](https://travis-ci.org/rustamburger@gmail.com/ContainerControllerSwift) +[![CI Status](https://img.shields.io/travis/rustamburger@gmail.com/ContainerControllerSwift.svg?style=flat)](https://travis-ci.org/github/mrustaa/ContainerController) [![Version](https://img.shields.io/cocoapods/v/ContainerControllerSwift.svg?style=flat)](https://cocoapods.org/pods/ContainerControllerSwift) [![License](https://img.shields.io/cocoapods/l/ContainerControllerSwift.svg?style=flat)](https://cocoapods.org/pods/ContainerControllerSwift) [![Platform](https://img.shields.io/cocoapods/p/ContainerControllerSwift.svg?style=flat)](https://cocoapods.org/pods/ContainerControllerSwift) +[![Swift 5.0](https://img.shields.io/badge/Swift-5.0-orange.svg?style=flat)](https://swift.org/) +[![Swift 5.1](https://img.shields.io/badge/Swift-5.1-orange.svg?style=flat)](https://swift.org/) -## Example +# ContainerController -To run the example project, clone the repo, and run `pod install` from the Example directory first. +This is a swipe-panel from application: https://www.apple.com/ios/maps/ -## Requirements + -## Installation +- [Getting Started](#getting-started) +- [Delegate ScrollView to self](#delegate-scrollview-to-self) +- [Action](#action) + - [Move position with an animation](#move-position-with-an-animation) +- [Adding custom views in ContainerController](#adding-custom-views-in-containercontroller) + - [Add `ScrollView`](#add-scrollview) + - [Add `HeaderView`](#add-headerview) + - [Add `FooterView`](#add-footerview) +- [Settings](#settings) + - [Layout](#layout) + - [Customize the layout with create subclass ContainerLayout on initialization](#customize-the-layout-with-create-subclass-containerlayout-on-initialization) + - [Or create object ContainerLayout](#or-create-object-containerlayout) + - [Change settings right away](#change-settings-right-away) + - [ContainerView](#containerview) + - [Use a ready-made solution](#use-a-ready-made-solution) + - [Add your changes](#add-your-changes) + - [More details](#more-details) + - [Change positions on screen Top Middle Bottom](#change-positions-on-screen-top-middle-bottom) + - [Customize indentations for View](#customize-indentations-for-view) + - [Customize for landscape orientation](#customize-for-landscape-orientation) + - [Parameters for control footerView](#parameters-for-control-footerview) +- [ContainerControllerDelegate](#containercontrollerdelegate) +- [License](#license) + + + +## Installation CocoaPods ContainerControllerSwift is available through [CocoaPods](https://cocoapods.org). To install it, simply add the following line to your Podfile: @@ -20,10 +46,395 @@ it, simply add the following line to your Podfile: pod 'ContainerControllerSwift' ``` -## Author +## Getting Started -rustamburger@gmail.com, rustamburger@gmail.com +```swift +import UIKit + +class ViewController: UIViewController, ContainerControllerDelegate { + + var container: ContainerController! + + override func viewDidLoad() { + super.viewDidLoad() + + // Create ContainerController Layout object + let layout = ContainerLayout() + layout.startPosition = .hide + layout.backgroundShadowShow = true + layout.positions = ContainerPosition(top: 70, middle: 250, bottom: 70) + + // Create ContainerController object, along with the container.view + // Pass the current UIViewController + container = ContainerController(addTo: self, layout: layout) + container.view.cornerRadius = 15 + container.view.addShadow() + + // Create subclass scrollView + let tableView = UITableView() + tableView.register(UITableViewCell.self, forCellReuseIdentifier: "cell") + tableView.delegate = self + tableView.dataSource = self + + // Add scrollView to container + container.add(scrollView: tableView) + + // Finishing settings ContainerController, + // Animated move position Top + container.move(type: .top) + } + + override func viewDidDisappear(_ animated: Bool) { + super.viewDidDisappear(animated) + + // Remove the subviews ContainerController + container.remove() + container = nil + } +} +``` + +## Delegate ScrollView to self +#### ☝️ If you implement delegate ScrollView (TableView, CollectionView, TextView) to `self`, then you need to call 4 functions in ContainerController + +```swift +extension ViewController: UIScrollViewDelegate { + + func scrollViewDidScroll(_ scrollView: UIScrollView) { + container.scrollViewDidScroll(scrollView) + } + + func scrollViewWillBeginDragging(_ scrollView: UIScrollView) { + container.scrollViewWillBeginDragging(scrollView) + } + + func scrollViewDidEndDecelerating(_ scrollView: UIScrollView) { + container.scrollViewDidEndDecelerating(scrollView) + } + + func scrollViewDidEndDragging(_ scrollView: UIScrollView, willDecelerate decelerate: Bool) { + container.scrollViewDidEndDragging(scrollView, willDecelerate: decelerate) + } +} + +extension ViewController: UITableViewDelegate { + ... +} + +extension ViewController: UITableViewDataSource { + ... +} + +``` + +## Action + +### Move position with an animation + +```swift + +container.move(type: .top) +container.move(type: .middle) +container.move(type: .bottom) + +``` + +## Adding custom views in ContainerController + +### Add `ScrollView` + +```swift + +let tableView = UITableView() +tableView.register(UITableViewCell.self, forCellReuseIdentifier: "cell") +tableView.backgroundColor = .clear +tableView.tableFooterView = UIView() +tableView.delegate = self +tableView.dataSource = self + +// Add scrollView to container +container.add(scrollView: tableView) + +``` + +### Add `HeaderView` + +```swift + +let headerView = ExampleHeaderGripView() +headerView.height = 20 + +container.add(headerView: headerView) + +``` + +### Add `FooterView` + +```swift + +let tabBarView = HeaderTabBarView() +tabBarView.height = 49.0 + +container.add(footerView: tabBarView) + +``` + +## Settings + +### Layout + +#### Customize the layout with create subclass `ContainerLayout` on initialization + +```swift + +class NewContainerLayout: ContainerLayout { + + override init() { + super.init() + + // Initialization start position. + startPosition = .hide + + // Disables any moving with gestures. + movingEnabled = true + + // Sets the new value for positions of animated movement (top, middle, bottom). + positions = ContainerPosition(top: 70, middle: 250, bottom: 70) + + // Sets insets container.view (left, right). + insets = ContainerInsets(right: 20, left: 20) + } +} + +class ViewController: UIViewController { + + var container: ContainerController! + + override func viewDidLoad() { + super.viewDidLoad() + + container = ContainerController(addTo: self, layout: NewContainerLayout()) + container.move(type: .top) + } +} + +``` + +#### Or create object `ContainerLayout` + +```swift + +override func viewDidLoad() { + super.viewDidLoad() + + // Create ContainerController Layout object + let layout = ContainerLayout() + layout.startPosition = .hide + layout.backgroundShadowShow = true + layout.positions = ContainerPosition(top: 70, middle: 250, bottom: 70) + + container = ContainerController(addTo: self, layout: layout) +} + +``` + +### Change settings right away + + +```swift + +// Properties +container.set(movingEnabled: true) +container.set(trackingPosition: false) +container.set(footerPadding: 100) + +// Add ScrollInsets Top/Bottom +container.set(scrollIndicatorTop: 5) // ↓ +container.set(scrollIndicatorBottom: 5) // ↑ + +// Positions +container.set(top: 70) // ↓ +container.set(middle: 250) // ↑ +container.set(bottom: 80) // ↑ + +// Middle Enable/Disable +container.set(middle: 250) +container.set(middle: nil) + +// Background Shadow +container.set(backgroundShadowShow: true) + +// Insets View +container.set(left: 5) // → +container.set(right: 5) // ← + +// Landscape params +container.setLandscape(top: 30) +container.setLandscape(middle: 150) +container.setLandscape(bottom: 70) +container.setLandscape(middle: nil) + +container.setLandscape(backgroundShadowShow: false) + +container.setLandscape(left: 10) +container.setLandscape(right: 100) + +``` + +## ContainerView + +ContainerView is generated automatically when you create ContainerController +Use a ready-made solution to change the radius, add shadow, and blur. + +### Use a ready-made solution + +```swift + +// Change cornerRadius global for all subviews +container.view.cornerRadius = 15 + +// Add layer shadow +container.view.addShadow(opacity: 0.1) + +// Add background blur UIVisualEffectView +container.view.addBlur(style: .dark) + +``` +#### Add your changes + +```swift + +// Add custom shadow +let layer = container.view.layer +layer.shadowOpacity = 0.5 +layer.shadowColor = UIColor.red.cgColor +layer.shadowOffset = CGSize(width: 1, height: 4) +layer.shadowRadius = 5 + +// Add view in container.view +let viewRed = UIView(frame: CGRect(x: 50, y: 50, width: 50, height: 50)) +viewRed.backgroundColor = .systemRed +container.view.addSubview(viewRed) + +// Add view under scrollView container.view +let viewGreen = UIView(frame: CGRect(x: 25, y: 25, width: 50, height: 50)) +viewGreen.backgroundColor = .systemGreen +container.view.insertSubview(viewGreen, at: 0) + +``` + +### More details + +#### Change positions on screen Top Middle Bottom + +```swift + +// These parameters set the new position value. +container.layout.positions = ContainerPosition(top: 70, middle: 250, bottom: 70) + +// Change settings right away +container.set(top: 70) // ↓ +container.set(middle: 250) // ↑ +container.set(bottom: 80) // ↑ + +``` + +#### Customize indentations for View + +```swift + +// Sets insets container.view (left, right). +container.layout.insets = ContainerInsets(right: 20, left: 20) + +container.layout.landscapeInsets = ContainerInsets(right: 20, left: 100) + + +// Change settings right away +container.set(left: 5) // → +container.set(right: 5) // ← + +container.setLandscape(left: 10) +container.setLandscape(right: 100) + +``` + +#### Customize for landscape orientation + +```swift + +// Sets the background shadow under container. (Default: backgroundShadowShow). +container.layout.landscapeBackgroundShadowShow = false + +// Sets the new value for positions of animated movement (top, middle, bottom). (Default: positions). +container.layout.landscapePositions = ContainerPosition(top: 20, middle: 150, bottom: 70) + +// Sets insets container.view (left, right). (Default: insets). +container.layout.landscapeInsets = ContainerInsets(right: 20, left: 100) + + +// Change settings right away + +container.setLandscape(top: 30) +container.setLandscape(middle: 150) +container.setLandscape(bottom: 70) +container.setLandscape(middle: nil) + +container.setLandscape(backgroundShadowShow: false) + +container.setLandscape(left: 10) +container.setLandscape(right: 100) + +``` + +#### Parameters for control footerView + +```swift + +// Padding-top from container.view, if headerView is added, then its + height is summed. +container.layout.footerPadding = 100 + +// Tracking position container.view during animated movement. +container.layout.trackingPosition = false + +// Change settings right away + +container.set(footerPadding: 100) +container.set(trackingPosition: false) + +``` + +## ContainerControllerDelegate + +```swift + +class ViewController: UIViewController, ContainerControllerDelegate { + + override func viewDidLoad() { + super.viewDidLoad() + + let container = ContainerController(addTo: self, layout: layout) + container.delegate = self + } +} + +/// Reports rotation and orientation changes +func containerControllerRotation(_ containerController: ContainerController) { + ... +} + +/// Reports a click on the background shadow +func containerControllerShadowClick(_ containerController: ContainerController) { + ... +} + +/// Reports the changes current position of the container, after its use +func containerControllerMove(_ containerController: ContainerController, position: CGFloat, type: ContainerMoveType, animation: Bool) { + ... +} + +``` ## License -ContainerControllerSwift is available under the MIT license. See the LICENSE file for more info. +ContainerController is available under the MIT license. See the LICENSE file for more info. +