Adding coding examples for Contact and ContactOption - v2 with signed commits

Sources/SpeziContact/Models/Contact.swift

@@ -11,6 +11,60 @@ import SwiftUI
 
 
 /// Encodes the contact information.
+///
+/// ### Usage
+///
+/// The following examples demonstrates the usage of the ``Contact`` in a ``ContactsList`` (`Contacts`) and an example view
+/// (`ContactRow`), that takes a single ``Contact`` and displays the corresopnding name, image, title, and organization.
+/// ```swift
+/// struct Contacts: View {
+///     let contacts = [
+///         Contact(
+///             name: PersonNameComponents(
+///                 givenName: "First",
+///                 familyName: "Last"
+///             ),
+///             image: Image(systemName: "figure.wave.circle"),
+///             title: "Title",
+///             description: "Description",
+///             organization: "Organization",
+///             address: {
+///                 let address = CNMutablePostalAddress()
+///                 address.country = "USA"
+///                 address.state = "CA"
+///                 address.postalCode = "94305"
+///                 address.city = "City"
+///                 address.street = "123 ABC St"
+///                 return address
+///             }(),
+///             contactOptions: [
+///                 .call("+1 (123) 456-7890"),
+///                 .text("+1 (123) 456-7890"),
+///                 .email(addresses: ["[email protected]"]),
+///             ]
+///         )
+///     ]
+/// }
+///
+/// struct ContactRow: View {
+///     let contact: Contact
+///     var body: some View {
+///         VStack(alignment: .leading) {
+///             \\ Accessing different properties of the contact
+///             contact.image
+///                 .resizable()
+///                 .frame(width: 50, height: 50)
+///                 .cornerRadius(25)
+///             Text("\(contact.name.givenName) \(contact.name.familyName)")
+///                 .font(.headline)
+///             Text(contact.title)
+///                 .font(.subheadline)
+///             Text(contact.organization)
+///                 .font(.subheadline)
+///         }
+///     }
+/// }
+/// ```
 public struct Contact {
     let id = UUID()
     /// The name of the individual. Ideally provide at least a first and given name.

Sources/SpeziContact/Models/ContactOption.swift

@@ -11,6 +11,28 @@ import SwiftUI
 
 
 /// Customizable way to get in contact with an individual and usually connected to a ``Contact``.
+///
+/// ### Usage
+///
+/// The following example demonstrates the usage of the ``ContactOption`` within a ``Contact``. For additional details, refer to the ``Contact`` documentation.
+/// ```swift
+/// Contact(
+///     // other parameters for Contact
+///     contactOptions: [
+///         .call("+1 (123) 456-7890"),
+///         .text("+1 (123) 456-7890"),
+///         .email(addresses: ["[email protected]"]),
+///         // Here is where the custom ContactOption can be used as a part of the contactOptions list
+///         ContactOption(
+///            image: Image(systemName: "safari.fill"),
+///            title: "More Info",
+///            action: {
+///                // Action that should be performed on pressing this ContactOption (i.e. opening a link for a website)...
+///             }
+///         )
+///     ]
+/// )
+/// ```
 public struct ContactOption {
     let id = UUID()
     /// The image representing the ``ContactOption`` in the user interface.