TAOverlay 2.0.1

TAOverlay 2.0.1

×

测试已测试✗
语言语言 Obj-CObjective C
许可证 MIT
发布最后发布2015年3月

由 Taimur Ayaz 维护。

TAOverlay 2.0.1

TAOverlay

TAOverlay 是一个简洁简单的覆盖层，旨在向用户显示有用的信息。

TAOverlay

v2.0.1 新特性

  • 添加了在覆盖层隐藏时的完成块支持
  • 增强了隐藏方法
  • 添加了进度指示器覆盖类型
  • 添加了更多自定义方法
  • 错误修正

要求

  • iOS 7.0+
  • ARC

安装

TAOverlay 可以通过以下任一方式安装

手动

  • 将 TAOverlay/TAOverlay 文件夹拖入您的项目中。
  • 确保将 TAOverlay.bundle 添加到 Targets->Build Phases->Copy Bundle Resources
  • import "TAOverlay.h"

使用方式

在您的应用程序中使用 TAOverlay 非常简单。

显示 TAOverlay

您可以使用以下任一方式显示 TAOverlay

+ (void) showOverlayWithLabel:(NSString *)status Options:(TAOverlayOptions)options;
  • 参数 status 是在覆盖层上显示的文本。如果值为 'nil'，则覆盖层显示不带标签
  • 参数 options 是选项掩码，用于指示覆盖层的类型和外观
+ (void) showOverlayWithLabel:(NSString *)status Image:(UIImage *)image Options:(TAOverlayOptions)options;
  • 参数 status 是在覆盖层上显示的文本。如果值为 'nil'，则覆盖层显示不带标签
  • 参数 image 是在覆盖层上显示的图标图像。图像 不能为 nil
  • 参数 options 是选项掩码，用于指示覆盖层的外观
+ (void) showOverlayWithLabel:(NSString *)status ImageArray:(NSArray *)imageArray Duration:(CGFloat)duration Options:(TAOverlayOptions)options;
  • 参数 status 是要显示的文本
  • 参数 imageArray 是包含 UIImage 对象的数组。如果您可以用图像轻松表达动画，请使用此参数。该数组 不能为 nil
  • 参数 duration 是循环通过图像数组动画的持续时间
  • 参数 options 是选项掩码，用于指示覆盖层的外观

消失 TAOverlay

您可以使用以下方式隐藏 TAOverlay

+ (void) hideOverlay;
  • 隐藏当前显示的覆盖层
+ (void) hideOverlayWithCompletion;
  • 隐藏当前显示的覆盖层并运行 set 块代码
+ (void)hideOverlayWithCompletionBlock:(void (^)(BOOL finished))completionBlock;
  • 隐藏当前显示的覆盖层并运行给定块代码
  • 参数 completionBlock 是在覆盖层隐藏后要运行的代码块

示例

[TAOverlay showOverlayWithLabel:@"This is the status" Options:(TAOverlayOptionOverlayTypeActivityDefault | TAOverlayOptionAllowUserInteraction | TAOverlayOptionOverlaySizeFullScreen | TAOverlayOptionAutoHide)];

以下显示了具有以下属性的 TAOverlay

  • 它的 状态 是 "这是一条状态信息"
  • 它的 类型 是默认的 iOS Activity Indicator
  • 它的大小是全屏
  • 它启用了 用户交互
  • 它启用了 自动隐藏

( 以下详细介绍这些选项 )

自定义

TAOverlay 具有很多自定义选项。

自定义方法

您可以使用以下任意一种方式来自定义 TAOverlay

+ (void)setOverlayBackgroundColor:(UIColor *)color;
  • color 参数是您想要设置的叠加层背景颜色
+ (void)setOverlayLabelFont:(UIFont *)font;
  • font 参数是您想要设置的叠加层标签字体
+ (void)setOverlayLabelTextColor:(UIColor *)color;
  • color 参数是您想要设置的叠加层标签文本颜色
+ (void)setOverlayShadowColor:(UIColor *)color;
  • color 参数是您想要设置的叠加层阴影颜色
 (void)setOverlayLabelText:(NSString *)text;
  • text 参数是您想要设置的叠加层标签文本
+ (void)setOverlayIconColor:(UIColor *)color;
  • color 参数是您想要设置的叠加层成功、失败、信息和警告图标颜色
+ (void)setOverlayProgressColor:(UIColor *)color;
  • color 参数是您想要设置的叠加层进度指示器颜色
+ (void)setOverlayProgress:(CGFloat)overlayProgress;
  • overlayProgress 参数是要设置的叠加层进度指示器的叠加层进度，其值必须在 0.0 到 1.0 之间。默认值为 0.0。
+ (void)setCompletionBlock:(void (^)(BOOL))completionBlock;
  • 参数 completionBlock 是在覆盖层隐藏后要运行的代码块

TAOverlayOptions

TAOverlayOptions 定义了以下一组位掩码，可用于微调叠加层的显示
( 在 TAOverlay 的 "show" 方法中作为参数传递 )

外观选项

  • TAOverlayOptionOpaqueBackground 选项表示叠加层没有模糊效果，而是使用纯色背景

  • TAOverlayOptionOverlayShadow 选项表示叠加层在其背后的整个屏幕上有半透明阴影

  • TAOverlayOptionAutoHide 选项表示叠加层在经过一段时间后（基于状态字符串的长度）会自动隐藏

交互选项

  • TAOverlayOptionAllowUserInteraction 选项表示用户可以与叠加层背后的对象进行交互

如果上述选项 不存在，以下选项将确定用户如何关闭叠加层

  • TAOverlayOptionOverlayDismissTap 选项允许用户通过点击手势来关闭叠加层

  • TAOverlayOptionOverlayDismissSwipeUp 选项允许用户通过向上滑动来关闭叠加层

  • TAOverlayOptionOverlayDismissSwipeDown 选项允许用户通过向下滑动来关闭叠加层

  • TAOverlayOptionOverlayDismissSwipeLeft 选项允许用户通过向左滑动来关闭叠加层

  • TAOverlayOptionOverlayDismissSwipeRight 选项允许用户通过向右滑动来关闭叠加层

类型选项

  • TAOverlayOptionOverlayTypeActivityDefault 选项表示叠加层使用默认的 iOS Activity Indicator 显示正在进行的活动

  • TAOverlayOptionOverlayTypeActivityLeaf 选项表示叠加层使用自定义的叶子风格活动指示器显示正在进行的活动 - 默认选项

  • TAOverlayOptionOverlayTypeActivityBlur 选项表示叠加层使用模糊光环风格的自定义活动指示器显示正在进行的活动

  • TAOverlayOptionOverlayTypeActivitySquare 选项表示叠加层使用圆角矩形风格的自定义活动指示器显示正在进行的活动

  • TAOverlayOptionOverlayTypeSuccess 选项表示叠加层在圆圈内显示勾号，表示任务的顺利完成

  • TAOverlayOptionOverlayTypeWarning 选项表示叠加层在圆圈内显示感叹号，提示用户某个信息

  • TAOverlayOptionOverlayTypeError 选项表示叠加层在圆圈内显示交叉符号，表示事件未成功

  • TAOverlayOptionOverlayTypeInfo 选项表示叠加层在圆圈内显示信息符号，通知用户某个信息

  • TAOverlayOptionOverlayTypeProgress 选项表示叠加层显示进度指示器 - 可用的进度处理方法

  • TAOverlayOptionOverlayTypeText 选项表示叠加层仅显示文本

尺寸选项

  • TAOverlayOptionOverlaySizeFullScreen 选项表示叠加层填充整个屏幕

  • TAOverlayOptionOverlaySizeBar 选项表示叠加层具有条形形状 默认选项

  • TAOverlayOptionOverlaySizeRoundedRect 选项表示叠加层采用圆角矩形形状

定义

头文件包括以下定义，用于调整叠加层的外观

  • OVERLAY_LABEL_FONT 状态标签的 字体

  • OVERLAY_LABEL_COLOR 状态标签的 文字颜色

  • OVERLAY_ACTIVITY_DEFAULT_COLOR 默认类型活动指示器的 颜色

  • OVERLAY_ACTIVITY_LEAF_COLOR 叶子类型活动指示器的 颜色

  • OVERLAY_ACTIVITY_BLUR_COLOR 模糊类型活动指示器的 颜色

  • OVERLAY_ACTIVITY_SQUARE_COLOR 方形类型活动指示器的 颜色

  • OVERLAY_SHADOW_COLOR 叠加层后面的半透明阴影的颜色

  • OVERLAY_BACKGROUND_COLOR 叠加层背景的颜色

  • OVERLAY_BLUR_TINT_COLOR 叠加层模糊的着色颜色

  • OVERLAY_SUCCESS_COLOR 成功图标的 颜色

  • OVERLAY_WARNING_COLOR 警告图标的 颜色

  • OVERLAY_ERROR_COLOR 错误图标的 颜色

  • OVERLAY_INFO_COLOR 信息图标的 颜色

  • OVERLAY_PROGRESS_COLOR 如果显示，进度指示器的 填充颜色

  • OVERLAY_ICON_THICKNESS 成功、警告、错误和信息图标的 粗细

  • ANIMATION_DURATION 出现和消失动画的 动画时长

自定义图像

可以使用上述“显示”方法中的后一个方法来显示自定义图像。 TAOverlay 包含一个用于将图像遮罩到特定颜色的 UIImage 分类。请使用以下方法进行此操作

- (UIImage *) maskImageWithColor:(UIColor *)color;
  • color 参数是用于遮罩给定图像的颜色
  • 返回值 是遮罩后的图像

通知

TAOverlay 通过 NSNotificationCenter 发布以下通知

  • 在显示动画开始时发布 TAOverlayWillAppearNotification

  • 在显示动画完成后发布 TAOverlayDidAppearNotification

  • 在消失动画开始时发布 TAOverlayWillDisappearNotification

  • 在消失动画完成后发布 TAOverlayDidDisappearNotification

  • 当一个进度类型叠加层完成进度指示器时发布 TAOverlayProgressCompletedNotification

每个通知都传递一个包含叠加层状态字符串（如有）的 userInfo 字典，可以通过 TAOverlayStatusUserInfoKey 获取。

待办事项

  • 增强叠加层以提供更多信息

为此项目做出贡献

如果您有功能请求或故障报告，请通过发送拉取请求或创建新问题来提供帮助 :)

鸣谢

TAOverlay 由 Taimur Ayaz 提供。如果您在项目中使用 TAOverlay，很期待您的署名 :)

许可

版权 (c) 2015 Taimur Ayaz

任何获得本软件及其相关文档（统称为“软件”）副本的个人，在此免费获得对该软件处理的权限，不受限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件拷贝的权限，以及对提供软件的个人或实体允许其如此操作，但需遵守以下条件。

上述版权声明和本许可声明应包含在软件的任何副本或主要部分的软件中。

软件按“现状”提供，不提供任何形式的保证，无论是明示还是暗示，包括但不限于适用性、特定用途和侵权不保证。在任何情况下，作者或版权持有人不应对任何因软件而引起的索赔、损害或其他责任负责，无论是基于合同、侵权或其他法律主张，这些索赔、损害或其他责任是否源于、涉及或与软件、软件的使用或其他涉及软件的处理有关。