@fluentui-react-native/callout 0.19.2 → 0.19.6

package/CHANGELOG.json

@@ -2,7 +2,67 @@
   "name": "@fluentui-react-native/callout",
   "entries": [
     {
-      "date": "Fri, 17 Dec 2021 01:23:52 GMT",
+      "date": "Fri, 17 Dec 2021 22:42:02 GMT",
+      "tag": "@fluentui-react-native/callout_v0.19.6",
+      "version": "0.19.6",
+      "comments": {
+        "patch": [
+          {
+            "author": "sanajmi@microsoft.com",
+            "package": "@fluentui-react-native/callout",
+            "commit": "9dc61df83605c035822518c18cc46fb5503dff70",
+            "comment": "remove carbon header"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 17 Dec 2021 22:06:58 GMT",
+      "tag": "@fluentui-react-native/callout_v0.19.5",
+      "version": "0.19.5",
+      "comments": {
+        "patch": [
+          {
+            "author": "beachball",
+            "package": "@fluentui-react-native/callout",
+            "comment": "Bump @fluentui-react-native/interactive-hooks to v0.11.4",
+            "commit": "9dc61df83605c035822518c18cc46fb5503dff70"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 17 Dec 2021 19:53:21 GMT",
+      "tag": "@fluentui-react-native/callout_v0.19.4",
+      "version": "0.19.4",
+      "comments": {
+        "patch": [
+          {
+            "author": "beachball",
+            "package": "@fluentui-react-native/callout",
+            "comment": "Bump @fluentui-react-native/interactive-hooks to v0.11.3",
+            "commit": "3012e075ca89e36931357442679b73d20540af8b"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 17 Dec 2021 18:39:08 GMT",
+      "tag": "@fluentui-react-native/callout_v0.19.3",
+      "version": "0.19.3",
+      "comments": {
+        "patch": [
+          {
+            "author": "sanajmi@microsoft.com",
+            "package": "@fluentui-react-native/callout",
+            "commit": "b7787516d0c417fbe350793713ffce3330c0f4a7",
+            "comment": "Documentation fixes"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 17 Dec 2021 01:26:42 GMT",
       "tag": "@fluentui-react-native/callout_v0.19.2",
       "version": "0.19.2",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,44 @@
 # Change Log - @fluentui-react-native/callout
 
-This log was last generated on Fri, 17 Dec 2021 01:23:52 GMT and should not be manually modified.
+This log was last generated on Fri, 17 Dec 2021 22:42:02 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.19.6
+
+Fri, 17 Dec 2021 22:42:02 GMT
+
+### Patches
+
+- remove carbon header (sanajmi@microsoft.com)
+
+## 0.19.5
+
+Fri, 17 Dec 2021 22:06:58 GMT
+
+### Patches
+
+- Bump @fluentui-react-native/interactive-hooks to v0.11.4
+
+## 0.19.4
+
+Fri, 17 Dec 2021 19:53:21 GMT
+
+### Patches
+
+- Bump @fluentui-react-native/interactive-hooks to v0.11.3
+
+## 0.19.3
+
+Fri, 17 Dec 2021 18:39:08 GMT
+
+### Patches
+
+- Documentation fixes (sanajmi@microsoft.com)
+
 ## 0.19.2
 
-Fri, 17 Dec 2021 01:23:52 GMT
+Fri, 17 Dec 2021 01:26:42 GMT
 
 ### Patches
 

package/lib/Callout.types.d.ts

@@ -71,8 +71,8 @@ export interface ICalloutTokens extends IBackgroundColorTokens, CalloutBorderTok
 }
 export interface ICalloutProps extends IViewProps, ICalloutTokens {
     /**
-     * @platform win32
      * A string that should be announced when the callout is shown.
+     * @platform win32
      */
     accessibilityOnShowAnnouncement?: string;
     /**
@@ -80,10 +80,10 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
      */
     componentRef?: React.RefObject<IFocusable>;
     /**
-     * @platform win32
      * Adds a beak to the Callout, pointing to the anchor target.
      * Notable Win32 limitation: Beak rendering currently limits the border width to its default, and the
      * border width prop will not be honored.
+     * @platform win32
      */
     isBeakVisible?: boolean;
     /**
@@ -91,7 +91,6 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
      */
     onDismiss?: () => void;
     /**
-     * @platform win32
      * Callback invoked during callout dismissal; if set, focus will not be restored by the callout and onRestoreFocus must
      * result in focus being moved to the appropriate focusable target.
      *
@@ -100,6 +99,7 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
      * this callback is most appropriate for components strictly controlling focus.
      *
      * restoreFocusEvent.nativeEvent.containsFocus is true if the Callout had focus while being dismissed.
+     * @platform win32
      */
     onRestoreFocus?: (restoreFocusEvent: RestoreFocusEvent) => void;
     /**

package/lib-commonjs/Callout.types.d.ts

@@ -71,8 +71,8 @@ export interface ICalloutTokens extends IBackgroundColorTokens, CalloutBorderTok
 }
 export interface ICalloutProps extends IViewProps, ICalloutTokens {
     /**
-     * @platform win32
      * A string that should be announced when the callout is shown.
+     * @platform win32
      */
     accessibilityOnShowAnnouncement?: string;
     /**
@@ -80,10 +80,10 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
      */
     componentRef?: React.RefObject<IFocusable>;
     /**
-     * @platform win32
      * Adds a beak to the Callout, pointing to the anchor target.
      * Notable Win32 limitation: Beak rendering currently limits the border width to its default, and the
      * border width prop will not be honored.
+     * @platform win32
      */
     isBeakVisible?: boolean;
     /**
@@ -91,7 +91,6 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
      */
     onDismiss?: () => void;
     /**
-     * @platform win32
      * Callback invoked during callout dismissal; if set, focus will not be restored by the callout and onRestoreFocus must
      * result in focus being moved to the appropriate focusable target.
      *
@@ -100,6 +99,7 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
      * this callback is most appropriate for components strictly controlling focus.
      *
      * restoreFocusEvent.nativeEvent.containsFocus is true if the Callout had focus while being dismissed.
+     * @platform win32
      */
     onRestoreFocus?: (restoreFocusEvent: RestoreFocusEvent) => void;
     /**

package/macos/Callout.swift

@@ -83,12 +83,8 @@ class CalloutView: RCTView, CalloutWindowLifeCycleDelegate {
 
 	// MARK: WindowLifeCycleDelegate
 
-	func didDetectHitOutsideCallout(calloutWindow: CalloutWindow) {
-		 dismissCallout()
-	}
-
-	func applicationDidResignActiveForCalloutWindow(calloutWindow: CalloutWindow) {
-		 dismissCallout()
+	func calloutWillDismiss(window: CalloutWindow) {
+		onDismissCallout()
 	}
 
 	// MARK: Private methods
@@ -96,12 +92,12 @@ class CalloutView: RCTView, CalloutWindowLifeCycleDelegate {
 	private func showCallout() {
 		updateCalloutFrameToAnchor()
 		calloutWindow.makeKeyAndOrderFront(self)
-		didShowCallout()
+		onShowCallout()
 	}
 
 	private func dismissCallout() {
 		calloutWindow.close()
-		didDismissCallout()
+		onDismissCallout()
 	}
 
 	/// Sets the frame of the Callout Window (in screen coordinates to be off of the Anchor on the preferred edge
@@ -268,11 +264,11 @@ class CalloutView: RCTView, CalloutWindowLifeCycleDelegate {
 		return calloutScreenRect
 	}
 
-	private func didShowCallout() {
+	private func onShowCallout() {
 		onShow?([:])
 	}
 
-	private func didDismissCallout() {
+	private func onDismissCallout() {
 		if let onDismiss = onDismiss {
 			guard let reactTag = reactTag else {
 				preconditionFailure("React Tag missing")
@@ -286,11 +282,11 @@ class CalloutView: RCTView, CalloutWindowLifeCycleDelegate {
 
 	private var anchorView: NSView?
 
-	private var proxyView: RCTView = RCTView()
+	private var proxyView = RCTView()
 
 	private lazy var calloutWindow: CalloutWindow = {
 		let window = CalloutWindow()
-		window.windowLifeCycleDelegate = self
+		window.lifeCycleDelegate = self
 
 		let visualEffect = NSVisualEffectView()
 		visualEffect.translatesAutoresizingMaskIntoConstraints = false

package/macos/CalloutWindow.swift

@@ -1,41 +1,37 @@
 import Foundation
 import AppKit
 
-protocol CalloutWindowLifeCycleDelegate {
-	/*
-	 * Notify the CalloutWindowLifeCycle object that the user touched/clicked outside the bounds of the callout.
-	 */
-	func didDetectHitOutsideCallout(calloutWindow: CalloutWindow)
-
-	/*
-	 * Notify the CalloutWindowLifeCycle object that the window the callout is in is no longer active.
-	 */
-	func applicationDidResignActiveForCalloutWindow(calloutWindow: CalloutWindow)
+protocol CalloutWindowLifeCycleDelegate: AnyObject {
+	/// Notify the delegate that the Callout is about to dismiss
+	func calloutWillDismiss(window: CalloutWindow)
 }
 
 class CalloutWindow: NSWindow {
 
-	public var windowLifeCycleDelegate: CalloutWindowLifeCycleDelegate?
+	weak var lifeCycleDelegate: CalloutWindowLifeCycleDelegate?
 
 	override init(contentRect: NSRect, styleMask style: NSWindow.StyleMask, backing backingStoreType: NSWindow.BackingStoreType, defer flag: Bool) {
 		super.init(contentRect: contentRect, styleMask: style, backing: backingStoreType, defer: flag)
-		isReleasedWhenClosed = true
+		isReleasedWhenClosed = false
 
 		styleMask = .borderless
 		level = .popUpMenu
 		backgroundColor = .clear
 		isMovable = false
 
-		NotificationCenter.default.addObserver(self, selector: #selector(appDidChangeActive(notification:)), name: NSApplication.didResignActiveNotification, object: nil)
+		// Dismiss the Callout if the window is no longer active.
+		NotificationCenter.default.addObserver(self, selector: #selector(dismissCallout), name: NSApplication.didResignActiveNotification, object: nil)
 
-		mouseEventMonitor = NSEvent.addLocalMonitorForEvents(matching: .leftMouseUp, handler: { (event) -> NSEvent? in
+		// Dismiss the Callout if the user touched/clicked outside the bounds of the callout.
+		mouseEventMonitor = NSEvent.addLocalMonitorForEvents(matching: .leftMouseUp, handler: { [weak self] (event) -> NSEvent? in
 			if (event.window != self) {
-				self.windowLifeCycleDelegate?.didDetectHitOutsideCallout(calloutWindow: self)
+				self?.dismissCallout()
 			}
 			return event
 		})
 	}
 
+	// Required to get a key view loop in the window
 	override var canBecomeKey: Bool {
 		return true
 	}
@@ -44,9 +40,15 @@ class CalloutWindow: NSWindow {
 		return false
 	}
 
-	@objc func appDidChangeActive(notification: NSNotification) {
-		windowLifeCycleDelegate?.applicationDidResignActiveForCalloutWindow(calloutWindow: self)
+	// Required to close the window on escape key press
+	override func cancelOperation(_ sender: Any?) {
+		dismissCallout()
+	}
+
+	@objc private func dismissCallout() {
+		lifeCycleDelegate?.calloutWillDismiss(window: self)
+		close()
 	}
 
 	private var mouseEventMonitor: Any?
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluentui-react-native/callout",
-  "version": "0.19.2",
+  "version": "0.19.6",
   "description": "A cross-platform Callout component using the Fluent Design System",
   "license": "MIT",
   "author": "",
@@ -22,7 +22,7 @@
   "dependencies": {
     "@fluentui-react-native/adapters": "^0.8.1",
     "@fluentui-react-native/component-cache": "^1.3.0",
-    "@fluentui-react-native/interactive-hooks": ">=0.11.2 <1.0.0",
+    "@fluentui-react-native/interactive-hooks": ">=0.11.4 <1.0.0",
     "@fluentui-react-native/tokens": ">=0.11.1 <1.0.0",
     "@uifabricshared/foundation-composable": ">=0.10.0 <1.0.0",
     "@uifabricshared/foundation-compose": "^1.11.2",

package/src/Callout.types.ts

@@ -100,8 +100,8 @@ export interface ICalloutTokens extends IBackgroundColorTokens, CalloutBorderTok
 
 export interface ICalloutProps extends IViewProps, ICalloutTokens {
   /**
-   * @platform win32
    * A string that should be announced when the callout is shown.
+   * @platform win32
    */
   accessibilityOnShowAnnouncement?: string;
 
@@ -111,10 +111,10 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
   componentRef?: React.RefObject<IFocusable>;
 
   /**
-   * @platform win32
    * Adds a beak to the Callout, pointing to the anchor target.
    * Notable Win32 limitation: Beak rendering currently limits the border width to its default, and the
    * border width prop will not be honored.
+   * @platform win32
    */
   isBeakVisible?: boolean;
 
@@ -124,7 +124,6 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
   onDismiss?: () => void;
 
   /**
-   * @platform win32
    * Callback invoked during callout dismissal; if set, focus will not be restored by the callout and onRestoreFocus must
    * result in focus being moved to the appropriate focusable target.
    *
@@ -133,6 +132,7 @@ export interface ICalloutProps extends IViewProps, ICalloutTokens {
    * this callback is most appropriate for components strictly controlling focus.
    *
    * restoreFocusEvent.nativeEvent.containsFocus is true if the Callout had focus while being dismissed.
+   * @platform win32
    */
   onRestoreFocus?: (restoreFocusEvent: RestoreFocusEvent) => void;