spezicontact

Spezi module to display contact information

https://github.com/stanfordspezi/spezicontact

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.7%) to scientific vocabulary

Keywords

contact ios spezi stanford swift swiftui xcode
Last synced: 6 months ago · JSON representation ·

Repository

Spezi module to display contact information

Basic Info
Statistics
  • Stars: 3
  • Watchers: 10
  • Forks: 3
  • Open Issues: 10
  • Releases: 13
Topics
contact ios spezi stanford swift swiftui xcode
Created almost 3 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

Spezi Contact

Build and Test codecov DOI

Views to display contact information.

Overview

The Spezi Contact Swift Package provides views and infrastructure to display contact information in an application.

| Screenshot showing a ContactsList rendered within the Spezi Template Application. Screenshot showing a ContactsList rendered within the Spezi Template Application. | |:---:| | A 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 or Swift package.

Example

The Contact module enables displaying contact information in an application. Information can be encoded in Contact and ContactOption to configure the contact views. The ContactView and ContactsList can display the contact information in a card-like layout and list.

The following example shows how Contacts can be created to encode an individual's contact information and displayed in a ContactsList within a SwiftUI View.

```swift import SpeziContact import SwiftUI

struct ContactsExample: View { let contact = Contact( name: PersonNameComponents(givenName: "Leland", familyName: "Stanford"), image: Image(systemName: "figure.wave.circle"), 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: ["example@stanford.edu"], subject: "Hi!") ] )

var body: some View {
    ContactsList(contacts: [contact])
}

} ```

For more information, please refer to the API documentation.

The Spezi Template Application

The Spezi Template Application provides a great starting point and example using the SpeziContact module.

Contributing

Contributions to this project are welcome. Please make sure to read the contribution guidelines and the contributor covenant code of conduct first.

License

This project is licensed under the MIT License. See Licenses for more information.

Spezi Footer Spezi Footer

Owner

  • Name: Stanford Spezi
  • Login: StanfordSpezi
  • Kind: organization

Citation (CITATION.cff)

#
# This source file is part of the Stanford Spezi open-source project
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
# 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Schmiedmayer"
  given-names: "Paul"
  orcid: "https://orcid.org/0000-0002-8607-9148"
- family-names: "Ravi"
  given-names: "Vishnu"
  orcid: "https://orcid.org/0000-0003-0359-1275"
- family-names: "Aalami"
  given-names: "Oliver"
  orcid: "https://orcid.org/0000-0002-7799-2429"
title: "SpeziContact"
doi: 10.5281/zenodo.7803121
url: "https://github.com/StanfordSpezi/SpeziContact"

GitHub Events

Total
  • Issues event: 1
  • Issue comment event: 2
  • Push event: 3
  • Pull request review event: 11
  • Pull request event: 3
  • Pull request review comment event: 10
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 1
  • Issue comment event: 2
  • Push event: 3
  • Pull request review event: 11
  • Pull request event: 3
  • Pull request review comment event: 10
  • Fork event: 2
  • Create event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 22
  • Total Committers: 5
  • Avg Commits per committer: 4.4
  • Development Distribution Score (DDS): 0.409
Past Year
  • Commits: 4
  • Committers: 3
  • Avg Commits per committer: 1.333
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Paul Schmiedmayer P****r 13
Andreas Bauer a****r@s****u 6
shamit05 5****5 1
Vishnu Ravi v****i@g****m 1
Akanshya Bhat 1****t 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 12
  • Total pull requests: 18
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 6
  • Total pull request authors: 7
  • Average comments per issue: 0.42
  • Average comments per pull request: 1.44
  • Merged pull requests: 14
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 7
  • Average time to close issues: about 2 hours
  • Average time to close pull requests: 1 day
  • Issue authors: 2
  • Pull request authors: 6
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.86
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • PSchmiedmayer (5)
  • Supereg (2)
  • mjoerke (1)
  • philippzagar (1)
  • vishnuravi (1)
  • bryant-jimenez (1)
Pull Request Authors
  • Supereg (9)
  • PSchmiedmayer (6)
  • akanshyabhat (4)
  • shamit05 (2)
  • pauljohanneskraft (2)
  • max-rosenblattl (2)
  • vishnuravi (2)
Top Labels
Issue Labels
enhancement (7) good first issue (5) help wanted (4) bug (3) documentation (1)
Pull Request Labels
enhancement (9) documentation (3)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 13
swiftpackageindex.com: github.com/StanfordSpezi/SpeziContact

Spezi module to display contact information

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Dependent repos count: 14.4%
Dependent packages count: 16.7%
Average: 35.9%
Forks count: 47.7%
Stargazers count: 64.7%
Last synced: 6 months ago

Dependencies

.github/workflows/build-and-test.yml actions
.github/workflows/monthly-markdown-link-check.yml actions
.github/workflows/pull_request.yml actions
Package.swift swiftpm