Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stanfordspezi/spezicontact
Spezi module to display contact information
https://github.com/stanfordspezi/spezicontact
contact ios spezi stanford swift swiftui xcode
Last synced: 25 days ago
JSON representation
Spezi module to display contact information
- Host: GitHub
- URL: https://github.com/stanfordspezi/spezicontact
- Owner: StanfordSpezi
- License: mit
- Created: 2023-04-05T05:11:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-21T11:59:45.000Z (about 1 year ago)
- Last Synced: 2023-09-22T15:47:08.508Z (about 1 year ago)
- Topics: contact, ios, spezi, stanford, swift, swiftui, xcode
- Language: Swift
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziContact/documentation/
- Size: 587 KB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Spezi Contact
[](https://github.com/StanfordSpezi/SpeziContact/actions/workflows/build-and-test.yml)
[](https://codecov.io/gh/StanfordSpezi/SpeziContact)
[](https://doi.org/10.5281/zenodo.7803121)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziContact)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziContact)
Views to display contact information.
## Overview
The Spezi Contact Swift Package provides views and infrastructure to display contact information in an application.
|   |
|:---:|
| A [`ContactsList`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contactslist) rendered in the Spezi Template Application. |
## Setup
### Add Spezi Contact as a Dependency
You need to add the Spezi Contact Swift package to
[your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or
[Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).
## Example
The Contact module enables displaying contact information in an application.
Information can be encoded in [`Contact`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contact) and [`ContactOption`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contactoption) to configure the contact views.
The [`ContactView`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contactview) and [`ContactsList`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contactslist) can display the contact information in a card-like layout and list.
The following example shows how [`Contact`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contact)s can be created to encode an individual's contact information and displayed in a [`ContactsList`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contactslist) within a SwiftUI [`View`](https://developer.apple.com/documentation/swiftui/view).
```swift
import SpeziContact
import SwiftUI
struct ContactsExample: View {
let contact = Contact(
image: Image(systemName: "figure.wave.circle"),
name: PersonNameComponents(givenName: "Leland", familyName: "Stanford"),
title: "Founder",
description: """
Leland Stanford is the founder of Stanford University.
""",
organization: "Stanford University",
address: {
let address = CNMutablePostalAddress()
address.country = "USA"
address.state = "CA"
address.postalCode = "94305"
address.city = "Stanford"
address.street = "450 Serra Mall"
return address
}(),
contactOptions: [
.call("+1 (650) 123-4567"),
.text("+1 (650) 123-4567"),
.email(addresses: ["[email protected]"], subject: "Hi!")
]
)
var body: some View {
ContactsList(contacts: [contact])
}
}
```
For more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziContact/documentation).
## The Spezi Template Application
The [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the [`SpeziContact`](https://swiftpackageindex.com/stanfordspezi/spezicontact) module.
## Contributing
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first.
## License
This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziContact/tree/main/LICENSES) for more information.
