西瓜视频 iOS Voice Over 无障碍适配实践

A.accessibilityElements = @[B, C]
B.accessibilityElements = @[D, E]

searchBox.isAccessibilityElement = YES;
searchBox.accessibilityLabel = @"搜索框";
searchBox.accessibilityValue = @"热搜词1，第一座4万亿GDP的城市。热搜词2，南昌至台湾专列开通";
searchBox.accessibilityTraits = UIAccessibilityTraitSearchField;

/// 频道栏的无障碍适配
categoryCell.isAccessibilityElement = YES;
categoryCell.accessibilityLabel = @"推荐频道";
categoryCell.accessibilityVaule = @"热搜词1，第一座4万亿GDP的城市。热搜词2，南昌至台湾专列开通";
categoryCell.accessibilityHint = @"轻点两下切换首页频道";
/// 未选中时
categoryCell.accessibilityTraits = UIAccessibilityTraitTabBar;
/// 已选中时
categoryCell.accessibilityTraits = UIAccessibilityTraitTabBar｜UIAccessibilityTraitSelected;

/// 频道编辑器的无障碍适配
// 如果面板是以addSubview的形式添加到界面上时，需要屏蔽底层元素的访问
@implementation categoryEditViewController

- (void)viewDidAppear {
    categoryEditView.accessibilityViewIsModal = YES;
    /// 使用户焦点移动到频道编辑面板上。
    UIAccessibilityPostNotification(UIAccessibilityScreenChangedNotification, categoryEditView);
}

- (void)viewDidDisAppear {
    categoryEditView.accessibilityViewIsModal = NO;
}

@end

storyCell.isAccessibilityElement = YES;
storyCell.accessibilityLabel = isLive ?  @"入江闪闪,正在直播" : @"入江闪闪";
storyCell.accessibilityHint = isLive ? @"轻点两下进入作者直播观看视频" : @"轻点两下进入作者视频列表播放视频";

@implementation storyCell
// TableView与CollectionView嵌套时，cell可能会出现无法自然滚动的问题。
- (void)accessibilityElementDidBecomeFocused {
    [self.collectionView scrollToIndexPath:self.indexPath];
}

@end

videoCell.isAccessibilityElement = YES
videoCell.accessibilityLabel = [视频标题、作者名称、点赞数、收藏数、评论数等]
videoCell.accessibilityHint = @"轻点两下进入详情页播放视频，上下轻扫使用转子访问更多功能"

UIAccessibilityCustomAction * action1 = [[UIAccessibilityCustomAction alloc] initWithName:@"点赞" target:self selector:@selector(action1)];
UIAccessibilityCustomAction * action2 = [[UIAccessibilityCustomAction alloc] initWithName:@"收藏" target:self selector:@selector(action2)];
UIAccessibilityCustomAction * action3 = [[UIAccessibilityCustomAction alloc] initWithName:@"更多" target:self selector:@selector(action3)];

videoCell.accessibilityCustomActions = @[action1,action2,action3];

@interface NSObject (UIAccessibility)
/// 标记一个元素是否是无障碍元素
@property (nonatomic) BOOL isAccessibilityElement;
/// 标记一个元素的无障碍元素的简短描述 如 （点赞、收藏）
@property (nullable, nonatomic, copy) NSString *accessibilityLabel;
/// （可选）标记一个元素的无障碍元素的详细描述 如 （轻点两下与xxx人一起点赞，轻点两下将视频添加到收藏列表）
@property (nullable, nonatomic, copy) NSString *accessibilityHint;
/// （可选）标记一个元素的无障碍元素的具体值，如50%等
@property (nullable, nonatomic, copy) NSString *accessibilityValue;
/// （可选）标记一个元素的无障碍特征 如（按钮、标签夹等）
@property (nonatomic) UIAccessibilityTraits accessibilityTraits;
/// （可选）自定义一个元素的无障碍模式下的焦点大小
@property (nonatomic) CGRect accessibilityFrame;

@end

@interface NSObject (UIAccessibilityAction)

/// 自定义无障碍事件，可以使点击事件与普通用户隔离。
- (BOOL)accessibilityActivate API_AVAILABLE(ios(7.0));

/// 当元素被定义为可变元素时，可以实现下面的方法。如音量、亮度调节器。
- (void)accessibilityIncrement API_AVAILABLE(ios(4.0));
- (void)accessibilityDecrement API_AVAILABLE(ios(4.0));


- (BOOL)accessibilityScroll:(UIAccessibilityScrollDirection)direction API_AVAILABLE(ios(4.2));
/// 通常浮窗或页面需要实现该方法，实现该方法后用户可以使用“Z”字形手势退出页面
- (BOOL)accessibilityPerformEscape API_AVAILABLE(ios(5.0));
/// 该方法可以接收到用户的双指双击事件。可以用于弹出更多面板 or 定义一些重要操作如 暂停。
- (BOOL)accessibilityPerformMagicTap API_AVAILABLE(ios(6.0));

/// 转子的核心方法，给accessibilityCustomActions赋值后可以上下轻扫访问转子
@property (nullable, nonatomic, strong) NSArray <UIAccessibilityCustomAction *> *accessibilityCustomActions API_AVAILABLE(ios(8.0));
@end

@interface NSObject (UIAccessibilityFocus)

/// 焦点响应事件，可以捕获元素是否成为了焦点。通常重写这两个方法。
- (void)accessibilityElementDidBecomeFocused API_AVAILABLE(ios(4.0));
- (void)accessibilityElementDidLoseFocus API_AVAILABLE(ios(4.0));

/// 可以判断该元素是否被聚焦，通常不要处理该方法。
- (BOOL)accessibilityElementIsFocused API_AVAILABLE(ios(4.0));

@end

@interface NSObject (UIAccessibilityContainer)

/// 返回当前容器无障碍元素的总数
- (NSInteger)accessibilityElementCount NS_SWIFT_UI_ACTOR;

/// 返回对应index的元素
/// 需要保证返回的是真实存在的实例（不能为alloc出来的）
- (nullable id)accessibilityElementAtIndex:(NSInteger)index NS_SWIFT_UI_ACTOR;

/// 返回对应元素的index
- (NSInteger)indexOfAccessibilityElement:(id)element NS_SWIFT_UI_ACTOR;
⚠️如果使用上面的三个方法，一般需要同时全部实现。
⚠️如果实现了上面的三个方法，那么就不要再手动设置accessibilityElements

/// 容器的无障碍元素List，设置后页面无障碍元素范围将会被限制在List内，顺序与List内元素顺序相同。
@property (nullable, nonatomic, strong) NSArray *accessibilityElements API_AVAILABLE(ios(8.0)) NS_SWIFT_UI_ACTOR;

/// default == UIAccessibilityContainerTypeNone，绝大多数情况保持None即可。如果手动设置Type则需要实现对于Type的指定协议。
@property (nonatomic) UIAccessibilityContainerType accessibilityContainerType API_AVAILABLE(ios(11.0)) NS_SWIFT_UI_ACTOR;

@end

self.isAccessibilityElement = YES;
self.accessibilityLabel = @"点赞";  // 通常焦点描述也会缺失，需要一并补充。

/// 对于一些自定义的UI控件，也可以重写上述两个对象的Get方法。
- (NSString *)accessibilityLabel {
    return @"点赞";
}

- (BOOL) isAccessibilityElement {
    return YES;
}

self.isAccessibilityElement = YES;

/// Button
// 点赞按钮未被选中时
self.accessibilityTraits = UIAccessibilityTraitButton;
self.accessibilityHint = @"轻点两下与xxx人一同点赞";

// 点赞按钮被选中时
self.accessibilityTraits = UIAccessibilityTraitButton|UIAccessibilityTraitSelected;
self.accessibilityHint = @"轻点两下取消点赞";

///TabBar（包括顶Tab和底Tab）
// 当对象为TabBar
self.accessibilityTraits = UIAccessibilityTraitTabBar
// 被选中的TabBar
self.accessibilityTraits = UIAccessibilityTraitTabBar|UIAccessibilityTraitSelected；

@implementation MyViewController
- (void)viewDidAppear:(BOOL)animated
{
[super viewDidAppear:animated];

UIAccessibilityPostNotification(UIAccessibilityScreenChangedNotification,
self.myFirstElement);
}
@end

/// 普通场景. 切勿在TableView的Cell中使用

self.accessibilityElements = @[View1,View2,View3];

/// 复杂场景，务必将三个方法都实现，否则容易出现意料之外的问题

- (NSInteger)accessibilityElementCount {
    return 3;
}

- (nullable id)accessibilityElementAtIndex:(NSInteger)index {
    return Views[index];
}

- (NSInteger)indexOfAccessibilityElement:(id)element {
    return [Views indexOfObject:element];
}

❌
[self reloadData];

✅
[self updateVisibleCells];

- (void)updateVisibleCells {
  NSArray<UICollectionViewCell *> *visibleCells = self.collectionView.visibleCells;
  [visibleCells enumerateObjectsUsingBlock:^(UICollectionViewCell * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
    // Todo something
  }];
}

self.accessibilityViewIsModal = YES

- (BOOL)accessibilityElementDidBecomeFocused {
   [self.tableview scrollToRowAtIndexPath:indexPath atScrollPosition:UITableViewScrollPositionNone animated:NO];

   return YES;
}

UIAccessibilityCustomAction * action1 = [[UIAccessibilityCustomAction alloc] initWithName:@"进入详情页" target:self selector:@selector(action1)];
UIAccessibilityCustomAction * action2 = [[UIAccessibilityCustomAction alloc] initWithName:@"删除该视频" target:self selector:@selector(action2)];
UIAccessibilityCustomAction * action3 = [[UIAccessibilityCustomAction alloc] initWithName:@"隐藏该视频" target:self selector:@selector(action3)];

self.accessibilityCustomActions = @[action1,action2,action3];