Cody Weaver f76df19f12
[ActionSheet] Add scrim accessibility properties. (#4919)
Before this commit the scrim doesn't have any of the properties needed for accessibility, this will add the functionality that will allow clients to set accessibility properties on the scrim.

Closes #4902
2018-08-29 14:11:52 -04:00

2.0 KiB

Accessibility

To help ensure your Action Sheet is accessible to as many users as possible, please be sure to reivew the following recommendations:

The scrim by default enables the "Z" gesture to dismiss. If isScrimAccessibilityElement is not set or is set to false then scrimAccessibilityLabel, scrimAccessibilityHint, and scrimAccessibilityTraits will have any effect.

Set -isScrimAccessibilityElement

Swift

let actionSheet = MDCActionSheetController()
actionSheet.transitionController.isScrimAccessibilityElement = true

Objective-C

MDCActionSheetController *actionSheet = [MDCActionSheetController alloc] init];
actionSheet.isScrimAccessibilityElement = YES;

Set -scrimAccessibilityLabel

Swift

let actionSheet = MDCActionSheetController()
actionSheet.transitionController.scrimAccessibilityLabel = "Cancel"

Objective-C

MDCActionSheetController *actionSheet = [MDCActionSheetController alloc] init];
actionSheet.scrimAccessibilityLabel = @"Cancel";

Set -scrimAccessibilityHint

Swift

let actionSheet = MDCActionSheetController()
actionSheet.transitionController.scrimAccessibilityHint = "Dismiss the action sheet"

Objective-C

MDCActionSheetController *actionSheet = [MDCActionSheetController alloc] init];
actionSheet.scrimAccessibilityHint = @"Dismiss the action sheet";

Set -scrimAccessibilityTraits

Swift

let actionSheet = MDCActionSheetController()
actionSheet.transitionController.scrimAccessibilityTraits = UIAccessibilityTraitButton

Objective-C

MDCActionSheetController *actionSheet = [MDCActionSheetController alloc] init];
actionSheet.scrimAccessibilityTraits = UIAccessibilityTraitButton;