{"id":13778371,"url":"https://github.com/honkmaster/TTProgressHUD","last_synced_at":"2025-05-11T11:35:32.604Z","repository":{"id":42572867,"uuid":"283585318","full_name":"honkmaster/TTProgressHUD","owner":"honkmaster","description":"TTProgressHUD is a light weight HUD written in SwiftUI meant to display the progress of an ongoing task on iOS.","archived":false,"fork":false,"pushed_at":"2022-05-31T10:06:36.000Z","size":158,"stargazers_count":233,"open_issues_count":1,"forks_count":25,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-07-12T04:36:51.509Z","etag":null,"topics":["ios","swift5","swiftui"],"latest_commit_sha":null,"homepage":"https://github.com/honkmaster/TTProgressHUD","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/honkmaster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-29T19:29:46.000Z","updated_at":"2024-06-02T17:20:48.000Z","dependencies_parsed_at":"2022-08-29T11:40:24.476Z","dependency_job_id":null,"html_url":"https://github.com/honkmaster/TTProgressHUD","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkmaster%2FTTProgressHUD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkmaster%2FTTProgressHUD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkmaster%2FTTProgressHUD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honkmaster%2FTTProgressHUD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/honkmaster","download_url":"https://codeload.github.com/honkmaster/TTProgressHUD/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213837544,"owners_count":15645729,"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":["ios","swift5","swiftui"],"created_at":"2024-08-03T18:00:53.345Z","updated_at":"2024-08-03T18:04:47.198Z","avatar_url":"https://github.com/honkmaster.png","language":"Swift","readme":"# TTProgressHUD\n\n`TTProgressHUD` is a light weight HUD written in SwiftUI meant to display the progress of an ongoing task on iOS. `TTProgressHUD` (left) was designed to look as similar as possible to the Apple HUD (example from Podcast.app, right).\n\n\u003cimg src=\"https://raw.githubusercontent.com/honkmaster/TTProgressHUD/master/Sample.jpg\" width=\"500\"\u003e\n\n## Installation\n\nXcode 11 and iOS 13 is required.\n\n### Swift Package Manager\n\n* Xcode: File -\u003e Swift Packages -\u003e Add Package Dependency\n* Paste https://github.com/honkmaster/TTProgressHUD\n\n### Manually\n\nDrag `TTProgressHUD.swift` and `TTProgressHUDConfig.swift` into your project.\n\n## Usage\n\n**Use `TTProgressHUD` wisely! Only use it if you absolutely need to perform a task before taking the user forward. Bad use case examples: pull to refresh, infinite scrolling, sending message.**\n\n### Import\n\nImport the `TTProgressHUD`  package: \n\n```swift\nimport TTProgressHUD\n```\n\n### Instantiate and show the HUD view\n\n```swift\nstruct ContentView: View {\n    @State var hudVisible = true\n    @State var hudConfig = TTProgressHUDConfig()\n    \n    var body: some View {\n        TTProgressHUD($hudVisible, config: hudConfig)\n    }\n}\n```\n\n## Customization\n\n`TTProgressHUD` can be customized via the `TTProgressHUDConfig` struct.\nThe default values were chosen so that `TTProgressHUD` looks as similar as possible to the Apple HUD.\n\n```swift\n\npublic init(\n    type: TTProgressHUDType         = .loading,\n    title: String?                  = nil,\n    caption: String?                = nil,\n    minSize: CGSize                 = CGSize(width: 100.0, height: 100.0),\n    cornerRadius: CGFloat           = 12.0,\n    backgroundColor: Color          = .clear,\n    foregroundColor: Color          = Color(.systemBackground),\n    titleForegroundColor: Color     = .primary,\n    captionForegroundColor: Color   = .secondary,\n    shadowColor: Color              = .clear,\n    shadowRadius: CGFloat           = 0.0,\n    borderColor: Color              = .clear,\n    borderWidth: CGFloat            = 0.0,\n    lineWidth: CGFloat              = 10.0,\n    imageViewSize: CGSize           = CGSize(width: 100, height: 100),\n    imageViewForegroundColor: Color = .primary,\n    successImage: String            = \"checkmark.circle\",\n    warningImage: String            = \"exclamationmark.circle\",\n    errorImage: String              = \"xmark.circle\",\n    shouldAutoHide: Bool            = false,\n    allowsTapToHide: Bool           = false,\n    autoHideInterval: TimeInterval  = 10.0,\n    hapticsEnabled: Bool            = true\n){...}\n```\n\n## Haptic Feedback\n\n`TTProgressHUD` will automatically trigger haptic feedback depending on which HUD is being displayed. The feedback maps as follows:\n\n* `TTProgressHUDType.success` \u003c-\u003e `UINotificationFeedbackTypeSuccess`\n* `TTProgressHUDType.warning` \u003c-\u003e `UINotificationFeedbackTypeWarning`\n* `TTProgressHUDType.error` \u003c-\u003e `UINotificationFeedbackTypeError`\n\n## Contributing to this project\n\nIf you have feature requests or bug reports, feel free to help out by sending pull requests or by [creating new issues](https://github.com/honkmaster/TTProgressHUD/issues/new). Please take a moment to\nreview the guidelines written by [Nicolas Gallagher](https://github.com/necolas):\n\n* [Bug reports](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#bugs)\n* [Feature requests](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#features)\n* [Pull requests](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#pull-requests)\n\n## License\n\n`TTProgressHUD` is distributed under the terms and conditions of the [MIT license](hhttps://github.com/honkmaster/TTGaugeView/blob/master/LICENSE).\n\n## Credits\n\n`TTProgressHUD` is brought to you by [Tobias Tiemerding](http://tiemerding.com) and based on [SVProgressHUD](https://github.com/SVProgressHUD/SVProgressHUD). If you're using `TTProgressHUD` in your project, attribution would be very appreciated.\n","funding_links":[],"categories":["Loading-Indicator"],"sub_categories":["Content"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhonkmaster%2FTTProgressHUD","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhonkmaster%2FTTProgressHUD","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhonkmaster%2FTTProgressHUD/lists"}