Files
TUIkit/Sources/TUIKit/Views/Dialog.swift
T
phranck 37cd4b88f5 feat: Add ContainerView with Header/Body/Footer architecture
- Add ContainerView as unified base for container views
- Add ContainerStyle for separator and border configuration
- Add containerBackground and containerHeaderBackground to Theme
- Standard appearances: Title in top border, Footer as separate section
- Block appearance: Separate Header section with darker background
- Migrate Panel, Card, Alert, Dialog to use ContainerView
- All views now support optional footer with separator
2026-01-28 23:24:35 +01:00

260 lines
7.6 KiB
Swift

//
// Dialog.swift
// TUIKit
//
// A modal dialog view with title, custom content, and optional footer.
//
/// A modal dialog view with a title, customizable content, and optional footer.
///
/// `Dialog` is more flexible than `Alert` — it accepts any content,
/// making it suitable for forms, selections, or complex interactions.
///
/// ## Structure
///
/// - **Header**: Title (in border for standard appearances, separate section for block)
/// - **Body**: Custom content
/// - **Footer**: Optional, typically buttons (separated by optional separator line)
///
/// ## Examples
///
/// ```swift
/// // Simple dialog
/// Dialog(title: "Settings") {
/// Text("Option 1: Enabled")
/// Text("Option 2: Disabled")
/// }
///
/// // Dialog with footer buttons
/// Dialog(title: "User Profile") {
/// Text("Name: John Doe")
/// Text("Email: john@example.com")
/// } footer: {
/// ButtonRow {
/// Button("Edit") { }
/// Button("Close") { }
/// }
/// }
///
/// // Modal overlay pattern
/// mainContent
/// .dimmed()
/// .overlay {
/// Dialog(title: "Confirm Action") {
/// Text("Are you sure you want to proceed?")
/// } footer: {
/// ButtonRow {
/// Button("Yes") { }
/// Button("No") { }
/// }
/// }
/// }
/// ```
public struct Dialog<Content: View, Footer: View>: View {
/// The dialog title.
public let title: String
/// The dialog content.
public let content: Content
/// The footer content (typically buttons).
public let footer: Footer?
/// The border style (nil uses appearance default).
public let borderStyle: BorderStyle?
/// The border color.
public let borderColor: Color?
/// The title color.
public let titleColor: Color?
/// The inner padding.
public let padding: EdgeInsets
/// Whether to show a separator before the footer.
public let showFooterSeparator: Bool
/// Creates a dialog with content and footer.
///
/// - Parameters:
/// - title: The dialog title.
/// - borderStyle: The border style (default: appearance borderStyle).
/// - borderColor: The border color (default: theme border).
/// - titleColor: The title color (default: theme foreground).
/// - padding: The inner padding (default: horizontal 2, vertical 1).
/// - showFooterSeparator: Whether to show separator before footer (default: true).
/// - content: The dialog content.
/// - footer: The footer content.
public init(
title: String,
borderStyle: BorderStyle? = nil,
borderColor: Color? = nil,
titleColor: Color? = nil,
padding: EdgeInsets = EdgeInsets(horizontal: 2, vertical: 1),
showFooterSeparator: Bool = true,
@ViewBuilder content: () -> Content,
@ViewBuilder footer: () -> Footer
) {
self.title = title
self.borderStyle = borderStyle
self.borderColor = borderColor
self.titleColor = titleColor
self.padding = padding
self.showFooterSeparator = showFooterSeparator
self.content = content()
self.footer = footer()
}
public var body: Never {
fatalError("Dialog renders via Renderable")
}
}
// MARK: - Rendering
extension Dialog: Renderable {
public func renderToBuffer(context: RenderContext) -> FrameBuffer {
let containerStyle = ContainerStyle(
showHeaderSeparator: true,
showFooterSeparator: showFooterSeparator,
borderStyle: borderStyle,
borderColor: borderColor
)
if let footerView = footer {
let container = ContainerView(
title: title,
titleColor: titleColor,
style: containerStyle,
padding: padding
) {
content
} footer: {
footerView
}
return container.renderToBuffer(context: context)
} else {
let container = ContainerView(
title: title,
titleColor: titleColor,
style: containerStyle,
padding: padding
) {
content
}
return container.renderToBuffer(context: context)
}
}
}
// MARK: - Convenience Initializer (no footer)
extension Dialog where Footer == EmptyView {
/// Creates a dialog without a footer.
///
/// - Parameters:
/// - title: The dialog title.
/// - borderStyle: The border style (default: appearance borderStyle).
/// - borderColor: The border color (default: theme border).
/// - titleColor: The title color (default: theme foreground).
/// - padding: The inner padding (default: horizontal 2, vertical 1).
/// - content: The dialog content.
public init(
title: String,
borderStyle: BorderStyle? = nil,
borderColor: Color? = nil,
titleColor: Color? = nil,
padding: EdgeInsets = EdgeInsets(horizontal: 2, vertical: 1),
@ViewBuilder content: () -> Content
) {
self.title = title
self.borderStyle = borderStyle
self.borderColor = borderColor
self.titleColor = titleColor
self.padding = padding
self.showFooterSeparator = false
self.content = content()
self.footer = nil
}
}
// MARK: - Convenience Extensions
extension Dialog where Footer == EmptyView {
/// Creates a dialog with a double-line border style.
///
/// - Parameters:
/// - title: The dialog title.
/// - borderColor: The border color (default: nil).
/// - titleColor: The title color (default: nil).
/// - content: The dialog content.
/// - Returns: A dialog with double-line borders.
public static func doubleLine<C: View>(
title: String,
borderColor: Color? = nil,
titleColor: Color? = nil,
@ViewBuilder content: () -> C
) -> Dialog<C, EmptyView> {
Dialog<C, EmptyView>(
title: title,
borderStyle: .doubleLine,
borderColor: borderColor,
titleColor: titleColor,
content: content
)
}
/// Creates a dialog with a heavy border style.
///
/// - Parameters:
/// - title: The dialog title.
/// - borderColor: The border color (default: nil).
/// - titleColor: The title color (default: nil).
/// - content: The dialog content.
/// - Returns: A dialog with heavy borders.
public static func heavy<C: View>(
title: String,
borderColor: Color? = nil,
titleColor: Color? = nil,
@ViewBuilder content: () -> C
) -> Dialog<C, EmptyView> {
Dialog<C, EmptyView>(
title: title,
borderStyle: .heavy,
borderColor: borderColor,
titleColor: titleColor,
content: content
)
}
}
// MARK: - Modal Presentation Helper
extension View {
/// Presents this view as a modal dialog over dimmed content.
///
/// This is a convenience method that combines `.dimmed()` and `.overlay()`
/// with center alignment.
///
/// ## Example
///
/// ```swift
/// mainContent.modal {
/// Dialog(title: "Settings") {
/// Text("Setting 1")
/// Text("Setting 2")
/// }
/// }
/// ```
///
/// - Parameter content: The modal content to display.
/// - Returns: A view with the modal overlay.
public func modal<Modal: View>(
@ViewBuilder content: () -> Modal
) -> some View {
self.dimmed()
.overlay(alignment: .center, content: content)
}
}