ContributorUI 是一个用户界面库,适用于 iOS 和 macOS 应用程序,旨在展示所有为项目做出贡献的开发者。
要访问 GitHub API,您需要将个人访问令牌提供给 ContributorUI。首先,在 开发者设置 下创建一个令牌,并将其安全地添加到项目中的某个位置。然后使用您的令牌密钥调用 configure(with:)
。
ContributorUI.configure(with: <token>)
对于那些想要访问私有仓库的人,请确保在创建令牌时启用 repo 作用域。
如果没有令牌密钥,GitHub API 允许访问公共仓库,但速率限制会 **降低**。 如果您需要更高的速率限制,**必须** 添加令牌密钥。 否则,您最终会收到 **未授权错误**。
ContributorCard 以卡片样式突出显示项目的顶级贡献者。 它可以放置在特定的屏幕中,以显示顶级提交者。
ContributorCard(owner: <owner>,repo: <repo>)
.padding(20)
.backgroundStyle(.thinMaterial)
.estimatedSize(38)
.minimumCardRowCount(1)
.maximumDisplayCount(30)
ContributorList 以表格或网格样式展示项目的所有贡献者,并具有无限滚动行为。 它可以通过 sheet 或全屏覆盖在您的应用程序中显示。
ContributorList(owner: <owner>,repo: <repo>)
.contributorListStyle(.grid)
.showsCommits(true)
ContributorUI 提供了方便的 UIKit 和 AppKit 视图控制器和视图,即使它是原生使用 SwiftUI 开发的,也能轻松地利用它们。 下表提供了 UIKit 和 AppKit 中相应的视图控制器和视图。
SwiftUI | UIKit | AppKit |
---|---|---|
ContributorCard | UIContributorCard | NSContributorCard |
ContributorList | UIContributorListController | NSContributorListController |
ContributorUI 是使用 Xcode 14.2 开发的。 确保您使用的是 Xcode 14.2 及以上版本。
将其作为依赖项添加到您的 Package.swift 中。
dependencies: [
.package(url: "https://github.com/dscyrescotti/ContributorUI.git", from: "1.0.1")
]
将其添加到您的 Podfile 中。
pod 'ContributorUI', '~> 1.0.1'
ContributorUI 还附带了一个演示项目,这是探索用法的最佳场所。 要运行演示项目,您可以在终端中使用以下命令。
> git clone https://github.com/dscyrescotti/ContributorUI.git
> cd ContributorUI && xed Demo/Demo
之后,Xcode 将打开该项目,然后您可以点击 ⌘+R 来运行该项目。
对于使用 UIKit 或 AppKit 的用户,您可以查看
Demo/Demo-UIKit
和Demo/Demo-AppKit
。
ContributorUI 的灵感来自 contrib.rocks,其开发目的是以最少的设置来赞扬 iOS 和 macOS 应用程序中项目的贡献者。
Dscyre Scotti | @dscyrescotti
如果您有任何增强的想法,或者遇到任何错误,欢迎所有开发者为 ContributorUI 做出贡献并提出 issue。
请随时通过访问项目的 讨论页面,分享您对 ContributorUI 的反馈或想法。 我们一直渴望听到像您这样的用户的声音。 此外,如果您在您的项目中使用过 ContributorUI,我们很想了解更多关于您的经验! 请在 使用 ContributorUI 的项目 类别下分享您使用 ContributorUI 的项目,以便我们可以编制项目列表并将其添加到 README.md 中。 感谢您的支持!
ContributorUI 在 MIT 许可证下可用。 有关更多信息,请参阅 LICENSE 文件。