Document custom overlay. Fixes #156

JanGorman · Jan 13, 2020 · 03a4769 · 03a4769
1 parent 50d821d
commit 03a4769
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/Example/Agrume Example/CloseButtonViewController.swift b/Example/Agrume Example/CloseButtonViewController.swift
@@ -7,8 +7,7 @@ import Agrume
 
 final class CloseButtonViewController: UIViewController {
 
-  private lazy var agrume = Agrume(image: #imageLiteral(resourceName: "MapleBacon"), background: .blurred(.regular),
-                                   dismissal: .withButton(nil))
+  private lazy var agrume = Agrume(image: #imageLiteral(resourceName: "MapleBacon"), background: .blurred(.regular), dismissal: .withButton(nil))
 
   @IBAction private func showImage() {
     agrume.show(from: self)

diff --git a/Example/Agrume Example/OverlayView.swift b/Example/Agrume Example/OverlayView.swift
@@ -10,7 +10,7 @@ protocol OverlayViewDelegate: AnyObject {
 }
 
 /// Example custom image overlay
-class OverlayView: AgrumeOverlayView {
+final class OverlayView: AgrumeOverlayView {
   lazy var toolbar: UIToolbar = {
     let toolbar = UIToolbar()
     toolbar.translatesAutoresizingMaskIntoConstraints = false

diff --git a/README.md b/README.md
@@ -205,6 +205,10 @@ let helper = makeHelper()
 agrume.onLongPress = helper.makeSaveToLibraryLongPressGesture
 ```
 
+### Custom Overlay View
+
+You can customise the look and functionality of the image views. To do so, you need create a class that inherits from `AgrumeOverlayView: UIView`. As this is nothing more than a regular `UIView` you can do anything you want with it like add a custom toolbar or buttons to it. The example app shows a detailed example of how this can be achieved.
+
 ### Lifecycle
 
 `Agrume` offers the following lifecycle closures that you can optionally set: