{"id":15055325,"url":"https://github.com/stanfordspezi/spezicontact","last_synced_at":"2025-12-11T22:53:19.466Z","repository":{"id":151694506,"uuid":"623791761","full_name":"StanfordSpezi/SpeziContact","owner":"StanfordSpezi","description":"Spezi module to display contact information","archived":false,"fork":false,"pushed_at":"2025-03-19T15:09:12.000Z","size":1304,"stargazers_count":3,"open_issues_count":9,"forks_count":2,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-03T06:41:53.437Z","etag":null,"topics":["contact","ios","spezi","stanford","swift","swiftui","xcode"],"latest_commit_sha":null,"homepage":"https://swiftpackageindex.com/StanfordSpezi/SpeziContact/documentation/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StanfordSpezi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null},"funding":{"custom":["spezi.sites.stanford.edu"]}},"created_at":"2023-04-05T05:11:39.000Z","updated_at":"2025-03-10T20:44:06.000Z","dependencies_parsed_at":"2023-06-28T15:00:12.917Z","dependency_job_id":null,"html_url":"https://github.com/StanfordSpezi/SpeziContact","commit_stats":null,"previous_names":["StanfordBDHG/CardinalKitContact","stanfordbdhg/cardinalkitcontact"],"tags_count":7,"template":false,"template_full_name":"StanfordBDHG/SwiftPackageTemplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziContact","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziContact/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziContact/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StanfordSpezi%2FSpeziContact/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StanfordSpezi","download_url":"https://codeload.github.com/StanfordSpezi/SpeziContact/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248153526,"owners_count":21056448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["contact","ios","spezi","stanford","swift","swiftui","xcode"],"created_at":"2024-09-24T21:40:53.512Z","updated_at":"2025-12-11T22:53:19.418Z","avatar_url":"https://github.com/StanfordSpezi.png","language":"Swift","funding_links":["spezi.sites.stanford.edu"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\nThis source file is part of the Stanford Spezi open-source project.\n\nSPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)\n\nSPDX-License-Identifier: MIT\n  \n--\u003e\n\n# Spezi Contact\n\n[![Build and Test](https://github.com/StanfordSpezi/SpeziContact/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/StanfordSpezi/SpeziContact/actions/workflows/build-and-test.yml)\n[![codecov](https://codecov.io/gh/StanfordSpezi/SpeziContact/branch/main/graph/badge.svg?token=YWyxmie4aT)](https://codecov.io/gh/StanfordSpezi/SpeziContact)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7803121.svg)](https://doi.org/10.5281/zenodo.7803121)\n[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziContact%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/StanfordSpezi/SpeziContact)\n[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FStanfordSpezi%2FSpeziContact%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/StanfordSpezi/SpeziContact)\n\nViews to display contact information.\n\n## Overview\n\nThe Spezi Contact Swift Package provides views and infrastructure to display contact information in an application.\n\n| ![Screenshot showing a ContactsList rendered within the Spezi Template Application.](Sources/SpeziContact/SpeziContact.docc/Resources/Overview.png#gh-light-mode-only) ![Screenshot showing a ContactsList rendered within the Spezi Template Application.](Sources/SpeziContact/SpeziContact.docc/Resources/Overview~dark.png#gh-dark-mode-only) |\n |:---:|\n | A [`ContactsList`](https://swiftpackageindex.com/stanfordspezi/spezicontact/documentation/spezicontact/contactslist) rendered in the Spezi Template Application. |\n\n## Setup\n\n### Add Spezi Contact as a Dependency\n\nYou need to add the Spezi Contact Swift package to\n[your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#) or\n[Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).\n\n## Example\n\nThe Contact module enables displaying contact information in an application. \nInformation 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.\nThe [`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.\n\nThe 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).\n\n```swift\nimport SpeziContact\nimport SwiftUI\n\n\nstruct ContactsExample: View {\n    let contact = Contact(\n        name: PersonNameComponents(givenName: \"Leland\", familyName: \"Stanford\"),\n        image: Image(systemName: \"figure.wave.circle\"),\n        title: \"Founder\",\n        description: \"\"\"\n        Leland Stanford is the founder of Stanford University.\n        \"\"\",\n        organization: \"Stanford University\",\n        address: {\n            let address = CNMutablePostalAddress()\n            address.country = \"USA\"\n            address.state = \"CA\"\n            address.postalCode = \"94305\"\n            address.city = \"Stanford\"\n            address.street = \"450 Serra Mall\"\n            return address\n        }(),\n        contactOptions: [\n            .call(\"+1 (650) 123-4567\"),\n            .text(\"+1 (650) 123-4567\"),\n            .email(addresses: [\"example@stanford.edu\"], subject: \"Hi!\")\n        ]\n    )\n    \n    var body: some View {\n        ContactsList(contacts: [contact])\n    }\n}\n```\n\nFor more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziContact/documentation).\n\n\n## The Spezi Template Application\n\nThe [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the [`SpeziContact`](https://swiftpackageindex.com/stanfordspezi/spezicontact) module.\n\n\n## Contributing\n\nContributions 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.\n\n\n## License\n\nThis project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziContact/tree/main/LICENSES) for more information.\n\n![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterLight.png#gh-light-mode-only)\n![Spezi Footer](https://raw.githubusercontent.com/StanfordSpezi/.github/main/assets/FooterDark.png#gh-dark-mode-only)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstanfordspezi%2Fspezicontact","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstanfordspezi%2Fspezicontact","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstanfordspezi%2Fspezicontact/lists"}