Bk/improve overlay documentation (#264)

* Fix example project * Update overlay documentation
airbnb · Sep 5, 2023 · 1e42185 · 1e42185
1 parent 937f2a9
commit 1e42185
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/Example/HorizonCalendarExample/HorizonCalendarExample/TooltipView.swift b/Example/HorizonCalendarExample/HorizonCalendarExample/TooltipView.swift
@@ -37,6 +37,7 @@ final class TooltipView: UIView {
 
     super.init(frame: .zero)
 
+    isUserInteractionEnabled = false
     addSubview(backgroundView)
     addSubview(label)
   }

diff --git a/README.md b/README.md
@@ -437,6 +437,8 @@ final class TooltipView: UIView {
 
   init(backgroundColor: UIColor, borderColor: UIColor, font: UIFont, textColor: UIColor) {
     super.init(frame: .zero)
+
+    isUserInteractionEnabled = false
 
     backgroundView.backgroundColor = backgroundColor
     backgroundView.layer.borderColor = borderColor
@@ -515,6 +517,8 @@ final class TooltipView: UIView {
 }
 ```
 
+Note: An overlay view will have a size that closely matches the `bounds.size` of the calendar. To prevent your overlay view from intercepting touches, set `isUserInteractionEnabled` to `false`.
+
 Next, we need a type that conforms to `CalendarItemViewRepresentable` that knows how to create and update instances of `TooltipView`. To make things easy, we can just make our view conform to this protocol:
 ```swift
 import HorizonCalendar