Sheet Modifier

Examples/Sources/WindowingExample/WindowingApp.swift

@@ -64,6 +64,112 @@ struct AlertDemo: View {
     }
 }
 
+// A demo displaying SwiftCrossUI's `View.sheet` modifier.
+struct SheetDemo: View {
+    @State var isPresented = false
+    @State var isShortTermSheetPresented = false
+
+    var body: some View {
+        Button("Open Sheet") {
+            isPresented = true
+        }
+        Button("Show Sheet for 5s") {
+            isShortTermSheetPresented = true
+            Task {
+                try? await Task.sleep(nanoseconds: 1_000_000_000 * 5)
+                isShortTermSheetPresented = false
+            }
+        }
+        .sheet(isPresented: $isPresented) {
+            print("sheet dismissed")
+        } content: {
+            SheetBody()
+                .presentationDetents([.height(150), .medium, .large])
+                .presentationDragIndicatorVisibility(.visible)
+                .presentationBackground(.green)
+        }
+        .sheet(isPresented: $isShortTermSheetPresented) {
+            Text("I'm only here for 5s")
+                .padding(20)
+                .presentationDetents([.height(150), .medium, .large])
+                .presentationCornerRadius(10)
+                .presentationBackground(.red)
+        }
+    }
+
+    struct SheetBody: View {
+        @State var isPresented = false
+        @Environment(\.dismiss) var dismiss
+
+        var body: some View {
+            VStack {
+                Text("Nice sheet content")
+                    .padding(20)
+                Button("I want more sheet") {
+                    isPresented = true
+                    print("should get presented")
+                }
+                Button("Dismiss") {
+                    dismiss()
+                }
+                Spacer()
+            }
+            .sheet(isPresented: $isPresented) {
+                print("nested sheet dismissed")
+            } content: {
+                NestedSheetBody(dismissParent: { dismiss() })
+                    .presentationCornerRadius(35)
+            }
+        }
+
+        struct NestedSheetBody: View {
+            @Environment(\.dismiss) var dismiss
+            var dismissParent: () -> Void
+            @State var showNextChild = false
+
+            var body: some View {
+                Text("I'm nested. Its claustrophobic in here.")
+                Button("New Child Sheet") {
+                    showNextChild = true
+                }
+                .sheet(isPresented: $showNextChild) {
+                    DoubleNestedSheetBody(dismissParent: { dismiss() })
+                        .interactiveDismissDisabled()
+                        .onAppear {
+                            print("deepest nested sheet appeared")
+                        }
+                        .onDisappear {
+                            print("deepest nested sheet disappeared")
+                        }
+                }
+                Button("dismiss parent sheet") {
+                    dismissParent()
+                }
+                Button("dismiss") {
+                    dismiss()
+                }
+                .onDisappear {
+                    print("nested sheet disappeared")
+                }
+            }
+        }
+        struct DoubleNestedSheetBody: View {
+            @Environment(\.dismiss) var dismiss
+            var dismissParent: () -> Void
+
+            var body: some View {
+                Text("I'm nested. Its claustrophobic in here.")
+                Button("dismiss parent sheet") {
+                    dismissParent()
+                }
+                Button("dismiss") {
+                    dismiss()
+                }
+            }
+        }
+    }
+}
+
 @main
 @HotReloadable
 struct WindowingApp: App {
@@ -92,6 +198,11 @@ struct WindowingApp: App {
                     Divider()
 
                     AlertDemo()
+
+                    Divider()
+
+                    SheetDemo()
+                        .padding(.bottom, 20)
                 }
                 .padding(20)
             }
@@ -108,23 +219,24 @@ struct WindowingApp: App {
                 }
             }
         }
-
-        WindowGroup("Secondary window") {
-            #hotReloadable {
-                Text("This a secondary window!")
-                    .padding(10)
+        #if !os(iOS) && !os(tvOS)
+            WindowGroup("Secondary window") {
+                #hotReloadable {
+                    Text("This a secondary window!")
+                        .padding(10)
+                }
             }
-        }
-        .defaultSize(width: 200, height: 200)
-        .windowResizability(.contentMinSize)
+            .defaultSize(width: 200, height: 200)
+            .windowResizability(.contentMinSize)
 
-        WindowGroup("Tertiary window") {
-            #hotReloadable {
-                Text("This a tertiary window!")
-                    .padding(10)
+            WindowGroup("Tertiary window") {
+                #hotReloadable {
+                    Text("This a tertiary window!")
+                        .padding(10)
+                }
             }
-        }
-        .defaultSize(width: 200, height: 200)
-        .windowResizability(.contentMinSize)
+            .defaultSize(width: 200, height: 200)
+            .windowResizability(.contentMinSize)
+        #endif
     }
 }

Sources/AppKitBackend/AppKitBackend.swift

@@ -16,6 +16,7 @@ public final class AppKitBackend: AppBackend {
     public typealias Menu = NSMenu
     public typealias Alert = NSAlert
     public typealias Path = NSBezierPath
+    public typealias Sheet = NSCustomSheet
 
     public let defaultTableRowContentHeight = 20
     public let defaultTableCellVerticalPadding = 4
@@ -1689,6 +1690,122 @@ public final class AppKitBackend: AppBackend {
         let request = URLRequest(url: url)
         webView.load(request)
     }
+
+    public func createSheet(content: NSView) -> NSCustomSheet {
+        // Initialize with a default contentRect, similar to `createWindow`
+        let sheet = NSCustomSheet(
+            contentRect: NSRect(
+                x: 0,
+                y: 0,
+                width: 400,  // Default width
+                height: 400  // Default height
+            ),
+            styleMask: [.titled, .closable],
+            backing: .buffered,
+            defer: true
+        )
+        sheet.contentView = content
+
+        return sheet
+    }
+
+    public func updateSheet(
+        _ sheet: NSCustomSheet,
+        size: SIMD2<Int>,
+        onDismiss: @escaping () -> Void
+    ) {
+        sheet.contentView?.frame.size = .init(width: size.x, height: size.y)
+        sheet.onDismiss = onDismiss
+    }
+
+    public func size(ofSheet sheet: NSCustomSheet) -> SIMD2<Int> {
+        guard let size = sheet.contentView?.frame.size else {
+            return SIMD2(x: 0, y: 0)
+        }
+        return SIMD2(x: Int(size.width), y: Int(size.height))
+    }
+
+    public func showSheet(_ sheet: NSCustomSheet, sheetParent: Any) {
+        // Critical sheets stack. beginSheet only shows a nested sheet
+        // after its parent gets dismissed.
+        let window = sheetParent as! NSCustomWindow
+        window.beginSheet(sheet)
+        window.managedAttachedSheet = sheet
+    }
+
+    public func dismissSheet(_ sheet: NSCustomSheet, sheetParent: Any) {
+        let window = sheetParent as! NSCustomWindow
+
+        if let nestedSheet = sheet.managedAttachedSheet {
+            dismissSheet(nestedSheet, sheetParent: sheet)
+        }
+
+        defer { window.managedAttachedSheet = nil }
+
+        window.endSheet(sheet)
+    }
+
+    public func setPresentationBackground(of sheet: NSCustomSheet, to color: Color) {
+        if let backgroundView = sheet.backgroundView {
+            backgroundView.layer?.backgroundColor = color.nsColor.cgColor
+            return
+        }
+
+        let backgroundView = NSView()
+        backgroundView.wantsLayer = true
+        backgroundView.layer?.backgroundColor = color.nsColor.cgColor
+
+        sheet.backgroundView = backgroundView
+
+        if let existingContentView = sheet.contentView {
+            let container = NSView()
+            container.translatesAutoresizingMaskIntoConstraints = false
+
+            container.addSubview(backgroundView)
+            backgroundView.translatesAutoresizingMaskIntoConstraints = false
+            backgroundView.leadingAnchor.constraint(equalTo: container.leadingAnchor).isActive =
+                true
+            backgroundView.topAnchor.constraint(equalTo: container.topAnchor).isActive = true
+            backgroundView.trailingAnchor.constraint(equalTo: container.trailingAnchor).isActive =
+                true
+            backgroundView.bottomAnchor.constraint(equalTo: container.bottomAnchor).isActive = true
+
+            container.addSubview(existingContentView)
+            existingContentView.translatesAutoresizingMaskIntoConstraints = false
+            existingContentView.leadingAnchor.constraint(equalTo: container.leadingAnchor)
+                .isActive = true
+            existingContentView.topAnchor.constraint(equalTo: container.topAnchor).isActive = true
+            existingContentView.trailingAnchor.constraint(equalTo: container.trailingAnchor)
+                .isActive = true
+            existingContentView.bottomAnchor.constraint(equalTo: container.bottomAnchor).isActive =
+                true
+
+            sheet.contentView = container
+        }
+    }
+
+    public func setInteractiveDismissDisabled(for sheet: NSCustomSheet, to disabled: Bool) {
+        sheet.interactiveDismissDisabled = disabled
+    }
+}
+
+public final class NSCustomSheet: NSCustomWindow, NSWindowDelegate {
+    public var onDismiss: (() -> Void)?
+
+    public var interactiveDismissDisabled: Bool = false
+
+    public var backgroundView: NSView?
+
+    public func dismiss() {
+        onDismiss?()
+        self.contentViewController?.dismiss(self)
+    }
+
+    @objc override public func cancelOperation(_ sender: Any?) {
+        if !interactiveDismissDisabled {
+            dismiss()
+        }
+    }
 }
 
 final class NSCustomTapGestureTarget: NSView {
@@ -2111,6 +2228,8 @@ public class NSCustomWindow: NSWindow {
     var customDelegate = Delegate()
     var persistentUndoManager = UndoManager()
 
+    var managedAttachedSheet: NSCustomSheet?
+
     /// Allows the backing scale factor to be overridden. Useful for keeping
     /// UI tests consistent across devices.
     ///

Sources/Gtk/Generated/EventControllerKey.swift

@@ -0,0 +1,77 @@
+import CGtk
+
+/// Provides access to key events.
+open class EventControllerKey: EventController {
+    /// Creates a new event controller that will handle key events.
+    public convenience init() {
+        self.init(
+            gtk_event_controller_key_new()
+        )
+    }
+
+    public override func registerSignals() {
+        super.registerSignals()
+
+        addSignal(name: "im-update") { [weak self] () in
+            guard let self = self else { return }
+            self.imUpdate?(self)
+        }
+
+        let handler1:
+            @convention(c) (
+                UnsafeMutableRawPointer, UInt, UInt, GdkModifierType, UnsafeMutableRawPointer
+            ) -> Void =
+                { _, value1, value2, value3, data in
+                    SignalBox3<UInt, UInt, GdkModifierType>.run(data, value1, value2, value3)
+                }
+
+        addSignal(name: "key-pressed", handler: gCallback(handler1)) {
+            [weak self] (param0: UInt, param1: UInt, param2: GdkModifierType) in
+            guard let self = self else { return }
+            self.keyPressed?(self, param0, param1, param2)
+        }
+
+        let handler2:
+            @convention(c) (
+                UnsafeMutableRawPointer, UInt, UInt, GdkModifierType, UnsafeMutableRawPointer
+            ) -> Void =
+                { _, value1, value2, value3, data in
+                    SignalBox3<UInt, UInt, GdkModifierType>.run(data, value1, value2, value3)
+                }
+
+        addSignal(name: "key-released", handler: gCallback(handler2)) {
+            [weak self] (param0: UInt, param1: UInt, param2: GdkModifierType) in
+            guard let self = self else { return }
+            self.keyReleased?(self, param0, param1, param2)
+        }
+
+        let handler3:
+            @convention(c) (UnsafeMutableRawPointer, GdkModifierType, UnsafeMutableRawPointer) ->
+                Void =
+                { _, value1, data in
+                    SignalBox1<GdkModifierType>.run(data, value1)
+                }
+
+        addSignal(name: "modifiers", handler: gCallback(handler3)) {
+            [weak self] (param0: GdkModifierType) in
+            guard let self = self else { return }
+            self.modifiers?(self, param0)
+        }
+    }
+
+    /// Emitted whenever the input method context filters away
+    /// a keypress and prevents the @controller receiving it.
+    ///
+    /// See [method@Gtk.EventControllerKey.set_im_context] and
+    /// [method@Gtk.IMContext.filter_keypress].
+    public var imUpdate: ((EventControllerKey) -> Void)?
+
+    /// Emitted whenever a key is pressed.
+    public var keyPressed: ((EventControllerKey, UInt, UInt, GdkModifierType) -> Void)?
+
+    /// Emitted whenever a key is released.
+    public var keyReleased: ((EventControllerKey, UInt, UInt, GdkModifierType) -> Void)?
+
+    /// Emitted whenever the state of modifier keys and pointer buttons change.
+    public var modifiers: ((EventControllerKey, GdkModifierType) -> Void)?
+}