You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

174 lines
6.4 KiB

5 years ago
  1. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/M13ProgressSuiteBanner.png">
  2. M13ProgressSuite
  3. ================
  4. A set of classes used to display progress information to users on iOS.
  5. Includes:
  6. ---------
  7. * A interchangeable set of progress view of diffrent styles. All the progress views are based on the same superclass, allowing any of them to be switched with any other easily.
  8. * A progress bar for UINavigationBar that works like Apple's Messages app. It also has the added feature of having an indeterminate style.
  9. * A HUD overlay that works over any UIView. Uses the M13ProgressView class to allow easy customizablility of the progress view.
  10. * A progress view that is styled like terminal.
  11. * Complete documentation of each class.
  12. UINavigationController (M13ProgressViewBar)
  13. ---------------------
  14. Adds a progress bar to the UINavigationController's UINavigationBar. The progress bar is controlled through the UINavigationController.
  15. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/UINavigationBar.gif">
  16. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/UINavigationBarIndeterminate.gif">
  17. M13ProgressHUD
  18. ---------------
  19. A customizable HUD that displays progress, and status information to the user. It uses the M13ProgressView class to allow easy changing of the progress view style.
  20. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/HUDBasic.gif">
  21. M13ProgressConsole
  22. ------------------
  23. A progress view styled like Terminal on OS X.
  24. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/ConsolePercent.gif">
  25. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/ConsoleDots.gif">
  26. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/ConsoleDotsRaise.gif">
  27. M13ProgressViews
  28. ----------------
  29. A set of progess view based off of the same superclass. Allowing easy switching between progress view. Each progress view has success and failure actions, an indeterminate mode, and appearance customization features.
  30. ***Bar***
  31. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/Bar.gif">
  32. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/BarIndeterminate.gif">
  33. ***Bordered Bar***
  34. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/BorderedBar.gif">
  35. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/BorderedIndeterminate.gif">
  36. ***Filtered Image***
  37. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/FilteredImage.gif">
  38. ***Image***
  39. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/Image.gif">
  40. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/ImageHidden.gif">
  41. ***Pie***
  42. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/Pie.gif">
  43. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/PieIndeterminate.gif">
  44. ***Ring***
  45. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/Ring.gif">
  46. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/RingIndeterminate.gif">
  47. **Segmented Bar***
  48. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/SegmentedBar.gif">
  49. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/SegmentedBarIndeterminate.gif">
  50. ***Segmented Ring***
  51. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/SegmentedRing.gif">
  52. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/SegmentedRingStraight.gif">
  53. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/SegmentedRingIndeterminate.gif">
  54. ***Striped Bar***
  55. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/Striped.gif">
  56. <img src="https://raw.github.com/Marxon13/M13ProgressSuite/master/ReadmeResources/StripedIndeterminate.gif">
  57. Progress View Usage:
  58. --------------------
  59. All progress bars follow the same general usage:
  60. ```
  61. // Create the progress view.
  62. M13ProgressViewBar *progressView = [[M13ProgressViewBar alloc] initWithFrame:CGRectMake(0.0, 0.0, 50.0, 5.0)];
  63. // Configure the progress view here.
  64. // Add it to the view.
  65. [self.view addSubview: progressView];
  66. // Update the progress as needed
  67. [progressView setProgress: 0.1 animated: YES];
  68. ```
  69. HUD Usage:
  70. ----------
  71. ```
  72. // Create the HUD
  73. M13ProgressHUD *HUD = [[M13ProgressHUD alloc] initWithProgressView:[[M13ProgressViewRing alloc] init]];
  74. // Configure the progress view
  75. HUD.progressViewSize = CGSizeMake(60.0, 60.0);
  76. HUD.animationPoint = CGPointMake([UIScreen mainScreen].bounds.size.width / 2, [UIScreen mainScreen].bounds.size.height / 2);
  77. // Add the HUD to the window. (Or any UIView)
  78. UIWindow *window = ((AppDelegate *)[UIApplication sharedApplication].delegate).window;
  79. [window addSubview:HUD];
  80. // Show the HUD
  81. [HUD show:YES];
  82. //Update the HUD progress
  83. [HUD setProgress:0.5 animated:YES];
  84. // Update the HUD status
  85. HUD.status = @"Processing";
  86. // Hide the HUD
  87. [HUD show:NO];
  88. ```
  89. Contact Me:
  90. -------------
  91. If you have any questions comments or suggestions, send me a message. If you find a bug, or want to submit a pull request, let me know.
  92. License:
  93. --------
  94. MIT License
  95. > Copyright (c) 2013 Brandon McQuilkin
  96. >
  97. > Permission is hereby granted, free of charge, to any person obtaining
  98. >a copy of this software and associated documentation files (the
  99. >"Software"), to deal in the Software without restriction, including
  100. >without limitation the rights to use, copy, modify, merge, publish,
  101. >distribute, sublicense, and/or sell copies of the Software, and to
  102. >permit persons to whom the Software is furnished to do so, subject to
  103. >the following conditions:
  104. >
  105. > The above copyright notice and this permission notice shall be
  106. >included in all copies or substantial portions of the Software.
  107. >
  108. > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  109. >EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  110. >MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  111. >IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  112. >CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  113. >TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  114. >SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.