Split code samples by OS (#262)

Author: davdroman

CHANGELOG.md

@@ -6,6 +6,7 @@ Changelog
 ### SwiftUIIntrospect
 
 - Changed: disabled accessibility for introspection views (#261)
+- Documentation: code samples are now split by OS (#262)
 - Infrastructure: use [`xcodes`](https://github.com/XcodesOrg/xcodes) via [`tea`](https://github.com/teaxyz/cli) on CI (#261)
 
 ## [0.6.2]

Package.swift

@@ -6,8 +6,8 @@ let package = Package(
     name: "Introspect",
     platforms: [
         .iOS(.v13),
-        .macOS(.v10_15),
         .tvOS(.v13),
+        .macOS(.v10_15),
     ],
     products: [
         .library(name: "Introspect", targets: ["Introspect"]),

[email protected]

@@ -6,8 +6,8 @@ let package = Package(
     name: "swiftui-introspect",
     platforms: [
         .iOS(.v13),
-        .macOS(.v10_15),
         .tvOS(.v13),
+        .macOS(.v10_15),
     ],
     products: [
         // legacy library

Sources/ViewTypes/Button.swift

@@ -2,15 +2,23 @@ import SwiftUI
 
 /// An abstract representation of the `Button` type in SwiftUI.
 ///
+/// ### iOS
+///
+/// Not available.
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ### macOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     var body: some View {
 ///         Button("Action", action: {})
-///             #if os(macOS)
 ///             .introspect(.button, on: .macOS(.v10_15, .v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSButton
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```

Sources/ViewTypes/ColorPicker.swift

@@ -2,21 +2,36 @@ import SwiftUI
 
 /// An abstract representation of the `ColorPicker` type in SwiftUI.
 ///
+/// ### iOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     @State var color = Color.red
 ///
 ///     var body: some View {
 ///         ColorPicker("Pick a color", selection: $color)
-///             #if os(iOS)
 ///             .introspect(.colorPicker, on: .iOS(.v14, .v15, .v16, .v17)) {
 ///                 print(type(of: $0)) // UIColorPicker
 ///             }
-///             #elseif os(macOS)
+///     }
+/// }
+/// ```
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ### macOS
+///
+/// ```swift
+/// struct ContentView: View {
+///     @State var color = Color.red
+///
+///     var body: some View {
+///         ColorPicker("Pick a color", selection: $color)
 ///             .introspect(.colorPicker, on: .macOS(.v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSColorPicker
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```

Sources/ViewTypes/DatePicker.swift

@@ -2,21 +2,34 @@ import SwiftUI
 
 /// An abstract representation of the `DatePicker` type in SwiftUI.
 ///
+/// ### iOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     @State var date = Date()
 ///
 ///     var body: some View {
 ///         DatePicker("Pick a date", selection: $date)
-///             #if os(iOS)
 ///             .introspect(.datePicker, on: .iOS(.v13, .v14, .v15, .v16, .v17)) {
 ///                 print(type(of: $0)) // UIDatePicker
 ///             }
-///             #elseif os(macOS)
+///     }
+/// }
+/// ```
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ```swift
+/// struct ContentView: View {
+///     @State var date = Date()
+///
+///     var body: some View {
+///         DatePicker("Pick a date", selection: $date)
 ///             .introspect(.datePicker, on: .macOS(.v10_15, .v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSDatePicker
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```

Sources/ViewTypes/DatePickerWithCompactStyle.swift

@@ -2,22 +2,38 @@ import SwiftUI
 
 /// An abstract representation of the `DatePicker` type in SwiftUI, with `.compact` style.
 ///
+/// ### iOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     @State var date = Date()
 ///
 ///     var body: some View {
 ///         DatePicker("Pick a date", selection: $date)
 ///             .datePickerStyle(.compact)
-///             #if os(iOS)
 ///             .introspect(.datePicker(style: .compact), on: .iOS(.v14, .v15, .v16, .v17)) {
 ///                 print(type(of: $0)) // UIDatePicker
 ///             }
-///             #elseif os(macOS)
+///     }
+/// }
+/// ```
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ### macOS
+///
+/// ```swift
+/// struct ContentView: View {
+///     @State var date = Date()
+///
+///     var body: some View {
+///         DatePicker("Pick a date", selection: $date)
+///             .datePickerStyle(.compact)
 ///             .introspect(.datePicker(style: .compact), on: .macOS(.v10_15_4, .v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSDatePicker
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```

Sources/ViewTypes/DatePickerWithFieldStyle.swift

@@ -2,18 +2,26 @@ import SwiftUI
 
 /// An abstract representation of the `DatePicker` type in SwiftUI, with `.field` style.
 ///
+/// ### iOS
+///
+/// Not available.
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ### macOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     @State var date = Date()
 ///
 ///     var body: some View {
 ///         DatePicker("Pick a date", selection: $date)
 ///             .datePickerStyle(.field)
-///             #if os(macOS)
 ///             .introspect(.datePicker(style: .field), on: .macOS(.v10_15, .v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSDatePicker
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```

Sources/ViewTypes/DatePickerWithGraphicalStyleType.swift

@@ -2,22 +2,38 @@ import SwiftUI
 
 /// An abstract representation of the `DatePicker` type in SwiftUI, with `.graphical` style.
 ///
+/// ### iOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     @State var date = Date()
 ///
 ///     var body: some View {
 ///         DatePicker("Pick a date", selection: $date)
 ///             .datePickerStyle(.graphical)
-///             #if os(iOS)
 ///             .introspect(.datePicker(style: .graphical), on: .iOS(.v14, .v15, .v16, .v17)) {
 ///                 print(type(of: $0)) // UIDatePicker
 ///             }
-///             #elseif os(macOS)
+///     }
+/// }
+/// ```
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ### macOS
+///
+/// ```swift
+/// struct ContentView: View {
+///     @State var date = Date()
+///
+///     var body: some View {
+///         DatePicker("Pick a date", selection: $date)
+///             .datePickerStyle(.graphical)
 ///             .introspect(.datePicker(style: .graphical), on: .macOS(.v10_15, .v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSDatePicker
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```

Sources/ViewTypes/DatePickerWithStepperFieldStyle.swift

@@ -2,18 +2,26 @@ import SwiftUI
 
 /// An abstract representation of the `DatePicker` type in SwiftUI, with `.stepperField` style.
 ///
+/// ### iOS
+///
+/// Not available.
+///
+/// ### tvOS
+///
+/// Not available.
+///
+/// ### macOS
+///
 /// ```swift
 /// struct ContentView: View {
 ///     @State var date = Date()
 ///
 ///     var body: some View {
 ///         DatePicker("Pick a date", selection: $date)
 ///             .datePickerStyle(.stepperField)
-///             #if os(macOS)
 ///             .introspect(.datePicker(style: .stepperField), on: .macOS(.v10_15, .v11, .v12, .v13, .v14)) {
 ///                 print(type(of: $0)) // NSDatePicker
 ///             }
-///             #endif
 ///     }
 /// }
 /// ```