{"id":13466663,"url":"https://github.com/krimpedance/KRProgressHUD","last_synced_at":"2025-03-26T00:31:19.546Z","repository":{"id":56917547,"uuid":"51550769","full_name":"krimpedance/KRProgressHUD","owner":"krimpedance","description":"A beautiful and easy-to-use progress HUD for your iOS.","archived":false,"fork":false,"pushed_at":"2024-03-08T05:23:48.000Z","size":26929,"stargazers_count":691,"open_issues_count":9,"forks_count":80,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-10-29T20:32:17.596Z","etag":null,"topics":["ios","progress-hud","swift"],"latest_commit_sha":null,"homepage":null,"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/krimpedance.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-11T22:09:23.000Z","updated_at":"2024-09-29T05:57:52.000Z","dependencies_parsed_at":"2024-06-18T12:38:05.956Z","dependency_job_id":"804b87f5-5502-4ddd-b321-ccf97a9be57c","html_url":"https://github.com/krimpedance/KRProgressHUD","commit_stats":{"total_commits":159,"total_committers":10,"mean_commits":15.9,"dds":0.2075471698113207,"last_synced_commit":"2d6b0246682fce2c8e226235c9cd6065d0b95e00"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krimpedance%2FKRProgressHUD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krimpedance%2FKRProgressHUD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krimpedance%2FKRProgressHUD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/krimpedance%2FKRProgressHUD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/krimpedance","download_url":"https://codeload.github.com/krimpedance/KRProgressHUD/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245566097,"owners_count":20636390,"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","progress-hud","swift"],"created_at":"2024-07-31T15:00:47.977Z","updated_at":"2025-03-26T00:31:19.183Z","avatar_url":"https://github.com/krimpedance.png","language":"Swift","funding_links":[],"categories":["Libs","UI [🔝](#readme)"],"sub_categories":["UI"],"readme":"[日本語](./README_Ja.md)\n\n\u003cimg src=\"https://github.com/krimpedance/Resources/blob/master/KRProgressHUD/logo.png\" width=\"100%\"\u003e\n\n[![Version](https://img.shields.io/cocoapods/v/KRProgressHUD.svg?style=flat)](http://cocoapods.org/pods/KRProgressHUD)\n[![License](https://img.shields.io/cocoapods/l/KRProgressHUD.svg?style=flat)](http://cocoapods.org/pods/KRProgressHUD)\n[![Platform](https://img.shields.io/cocoapods/p/KRProgressHUD.svg?style=flat)](http://cocoapods.org/pods/KRProgressHUD)\n[![Download](https://img.shields.io/cocoapods/dt/KRProgressHUD.svg?style=flat)](http://cocoapods.org/pods/KRProgressHUD)\n[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)\n[![CI Status](http://img.shields.io/travis/krimpedance/KRProgressHUD.svg?style=flat)](https://travis-ci.org/krimpedance/KRProgressHUD)\n\n`KRProgressHUD` is a beautiful and easy-to-use progress HUD for your iOS written by Swift.\n\n[KRActivityIndicatorView](https://github.com/krimpedance/KRActivityIndicatorView) is used for loading view.\n\n\u003cimg src=\"https://github.com/krimpedance/Resources/blob/master/KRProgressHUD/demo.gif\" height=400\u003e\n\u003cimg src=\"https://github.com/krimpedance/Resources/blob/master/KRProgressHUD/styles.png\" width=400\u003e\n\n## Features\n- Round indicator\n- Indicator color can be customized\n\n## Requirements\n- iOS 9.0+\n- Xcode 12.0+\n- Swift 5.3+\n\n## DEMO\nTo run the example project, clone the repo, and open `KRProgressHUDDemo.xcodeproj` from the DEMO directory.\n\nor [appetize.io](https://appetize.io/app/nw022juw0znkf1n5u6ynga5ntm)\n\n## Installation\nKRProgressHUD is available through [CocoaPods](http://cocoapods.org) and [Carthage](https://github.com/Carthage/Carthage).\nTo install it, simply add the following line to your Podfile or Cartfile:\n\n```ruby\n# CocoaPods\npod \"KRProgressHUD\"\n```\n\n```ruby\n# Carthage\ngithub \"Krimpedance/KRProgressHUD\"\n```\n\n## Usage\n(see sample Xcode project in /Demo)\n\n#### Caution :\n**Only use it if you absolutely need to perform a task before taking the user forward.**\n\n**If you want to use it with other cases (ex. pull to refresh), I suggest using [KRActivityIndicatorView](https://github.com/krimpedance/KRActivityIndicatorView).**\n\n\n`KRProgressHUD` is created as a singleton.\n\nAt first, import `KRProgressHUD` in your swift file.\n\n\nShow simple HUD :\n```Swift\nKRProgressHUD.show()\n\nDispatchQueue.main.asyncAfter(deadline: .now()+1) {\n   KRProgressHUD.dismiss()\n}\n```\n\n### Showing the HUD\n\n```Swift\nclass func show(withMessage message:String? = nil, completion: CompleteHandler? = nil)\n\n// Example\nKRProgressHUD.show()\nKRProgressHUD.show(withMessage: \"Loading...\")\nKRProgressHUD.show(withMessage: \"Loading...\") {\n   print(\"Complete handler\")\n}\n```\n\n**Show on ViewController**\n\nIf you want to show HUD on a view controller, set at `showOn()`.\n\n(This is applied only once.)\n\n```Swift\n  KRProgressHUD.showOn(viewController).show()\n```\n\nShow a confirmation glyph before getting dismissed a little bit later.\n(The display time is 1 sec in default. You can change the timing.)\n\n```Swift\nclass func showSuccess()\nclass func showInfo()\nclass func showWarning()\nclass func showError()\nclass func showImage() // This can set custom image. (Max size is 50x50)\n```\n\nShow the HUD (only message)\n\n```Swift\npublic class func showMessage(_ message: String)\n\n// Example\nKRProgressHUD.showMessage(\"Completed! \\n Let's start!\")\n```\n\n### Update the HUD's message\nThe HUD can update message.\n\n```Swift\nclass func update(message: String)\n\n// Example\nKRProgressHUD.update(message: \"20%\")\n```\n\n### Dismissing the HUD\nThe HUD can be dismissed using:\n\n```Swift\nclass func dismiss(_ completion: CompleteHandler? = nil)\n```\n\n### Customization\n`KRProgressHUD.appearance()` can set default styles.\n\n```Swift\nclass KRProgressHUDAppearance {\n    /// Default style.\n    public var style = KRProgressHUDStyle.white\n    /// Default mask type.\n    public var maskType = KRProgressHUDMaskType.black\n    /// Default KRActivityIndicatorView colors\n    public var activityIndicatorColors = [UIColor]([.black, .lightGray])\n    /// Default message label font.\n    public var font = UIFont.systemFont(ofSize: 13)\n    /// Default HUD center offset of y axis.\n    public var viewOffset = CGFloat(0.0)\n    /// Default duration to show HUD.\n    public var duration = Double(1.0)\n}\n```\n\nWhen you'd like to make styles reflected only in specific situation, use following methods.\n\n```Swift\n@discardableResult public class func set(style: KRProgressHUDStyle) -\u003e KRProgressHUD.Type\n@discardableResult public class func set(maskType: KRProgressHUDMaskType) -\u003e KRProgressHUD.Type\n@discardableResult public class func set(activityIndicatorViewColors colors: [UIColor]) -\u003e KRProgressHUD.Type\n@discardableResult public class func set(font: UIFont) -\u003e KRProgressHUD.Type\n@discardableResult public class func set(viewOffset offset: CGFloat) -\u003e KRProgressHUD.Type\n@discardableResult public class func set(duration: Double) -\u003e KRProgressHUD.Type\n\n\n// Example\nKRProgressHUD\n   .set(style: .custom(background: .blue, text: .white, icon: nil))\n   .set(maskType: .white)\n   .show()\n```\n\nThese `set()` setting can be reset by\n\n```Swift\n@discardableResult public class func resetStyles() -\u003e KRProgressHUD.Type\n```\n\n## Contributing to this project\nI'm seeking bug reports and feature requests.\n\n## Release Note\n+ 3.4.8 :\n  - Add privacy manifests\n\n+ 3.4.7 :\n  - Support for iOS 11 and below\n\n## License\nKRProgressHUD is available under the MIT license.\n\nSee the LICENSE file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrimpedance%2FKRProgressHUD","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkrimpedance%2FKRProgressHUD","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkrimpedance%2FKRProgressHUD/lists"}