+
+
+ text
+
+ The text representation of the conformance level.
+ +Swift
+public var text: String { get }
+
+
+ text
+
+ The text representation of the conformance level.
+ +Swift
+public var text: String { get }dependencies: [
- .package(url: "https://github.com/chrs1885/Capable.git", from: "1.0.0")
+ .package(url: "https://github.com/chrs1885/Capable.git", from: "1.0.1")
]
Typealias used for colors. It maps to UIColor.
"},"Typealiases.html#/Font":{"name":"Font","abstract":"Typealias used for fonts. It maps to UIFont.
"},"Typealiases.html#/s:7Capable5Colora":{"name":"Color","abstract":"Typealias used for colors. It maps to NSColor.
"},"Typealiases.html#/s:7Capable4Fonta":{"name":"Font","abstract":"Typealias used for fonts. It maps to NSFont.
"},"Structs/HandicapStatus.html#/s:7Capable14HandicapStatusV8handicapAA0B0Vvp":{"name":"handicap","abstract":"The Handicap that has changed.
The Handicap‘s status (enabled or disabled). Note that the status depends on the Handicap’s enabledIf value (see HandicapEnabledMode).
A list of CapableFeatures that are expected to be enabled if a user has this handicap.
The name of the Handicap that can be used to uniquely identify the Handicap. This name is also used inside the status map.
This mode defines whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
Initializes a new Handicap object.
The feature type.
","parent_name":"FeatureStatus"},"Structs/FeatureStatus.html#/s:7Capable13FeatureStatusV12statusStringSSvp":{"name":"statusString","abstract":"The feature’s status: While most features can only have a status set to enabled or disabled, the ‘.largerText` feature offers the font scale set by the user.
","parent_name":"FeatureStatus"},"Structs/Capable.html#/s:7CapableAAV12withFeaturesABSayAA0A7FeatureOG_tcfc":{"name":"init(withFeatures:)","abstract":"Initializes the framework instance with a specified set of features. If no feature was provided, this defaults to all features available on the current platform.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV13withHandicapsABSayAA8HandicapVG_tcfc":{"name":"init(withHandicaps:)","abstract":"Initializes the framework instance with a set of Handicaps.
The statusMap property returns a dictionary of all CapableFeatures or Handicaps , that the Capable instance has been initialized with along with their current statuses. This object is compatible with most analytic SDKs such as Fabric Answers, Firebase Analytics, AppCenter Analytics, or HockeyApp.","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV16isFeatureEnabled7featureSbAA0aC0O_tF":{"name":"isFeatureEnabled(feature:)","abstract":"
Provides information regarding the current status of a provided feature.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV17isHandicapEnabled12handicapNameSbSS_tF":{"name":"isHandicapEnabled(handicapName:)","abstract":"Provides information regarding the current status of a provided Handicap.
The minimum log level that should be considered when logging messages. Note that the custom ‘onLog’ closure will only be called for messages of this log type or higher. This value defaults to OSLogType.debug.
A custom closure that should be used by the logger for all Capable instances instead of the default os_log implementation.
","parent_name":"Capable"},"Structs/Capable.html":{"name":"Capable","abstract":"This class defines the main interface of the Capable framework.
"},"Structs/FeatureStatus.html":{"name":"FeatureStatus","abstract":"Model class that describes the content of a Capable notification (see Notification.Name.CapableFeatureStatusDidChange)
Model class that groups a number of CapableFeatures to represent a user’s handicap.
Model class that describes the content of a Capable notification (see Notification.Name.CapableHandicapStatusDidChange)
Makes the given font scalable.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledFont(withName:ofSize:)":{"name":"scaledFont(withName:ofSize:)","abstract":"Creates a scalable font with the given font name and reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledSystemFont(ofSize:)":{"name":"scaledSystemFont(ofSize:)","abstract":"Creates a scalable system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledBoldSystemFont(ofSize:)":{"name":"scaledBoldSystemFont(ofSize:)","abstract":"Creates a scalable bold system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledItalicSystemFont(ofSize:)":{"name":"scaledItalicSystemFont(ofSize:)","abstract":"Creates a scalable italic system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C22FeatureStatusDidChangeABvpZ":{"name":"CapableFeatureStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed accessibility feature status changes.
","parent_name":"Name"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C23HandicapStatusDidChangeABvpZ":{"name":"CapableHandicapStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed Handicap status changes.
Extension that defines notification names provided by the Capable framework.
","parent_name":"Notification"},"Extensions/Color.html#/s:So7NSColorC7CapableE16getContrastRatio12forTextColor012onBackgroundH012CoreGraphics7CGFloatVSgAB_ABtFZ":{"name":"getContrastRatio(forTextColor:onBackgroundColor:)","abstract":"Calculates the color ratio for a text color on a background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor012onBackgroundE0ABSgAB_tFZ":{"name":"getTextColor(onBackgroundColor:)","abstract":"Returns the text color with the highest contrast (black or white) for a given background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor10fromColors8withFont012onBackgroundE016conformanceLevelABSgSayABG_So6NSFontCAbC011ConformanceM0OtFZ":{"name":"getTextColor(fromColors:withFont:onBackgroundColor:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of text colors and a background color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor07forTextE0ABSgAB_tFZ":{"name":"getBackgroundColor(forTextColor:)","abstract":"Returns the background color with the highest contrast (black or white) for a given text color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor10fromColors07forTextE08withFont16conformanceLevelABSgSayABG_ABSo6NSFontCAC011ConformanceM0OtFZ":{"name":"getBackgroundColor(fromColors:forTextColor:withFont:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of background colors and a text color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html":{"name":"Color","abstract":"Extension that adds functionality for calculating WCAG compliant high contrast colors.
"},"Extensions/Notification.html":{"name":"Notification"},"Extensions/UIFont.html":{"name":"UIFont","abstract":"Extension that adds functionality for creating scalable UIFont objects.
"},"Enums/HandicapEnabledMode.html#/s:7Capable19HandicapEnabledModeO010oneFeatureC0yA2CmF":{"name":"oneFeatureEnabled","abstract":"The Handicap‘s status is enabled if one of its features is currently set to enabled.
The Handicap‘s status is enabled if all its features are currently set to enabled.
Menu that helps people with motor skill impairments to do certain actions or gestures by using a single tap.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/darkerSystemColors":{"name":"darkerSystemColors","abstract":"Enhances text contrast.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/guidedAccess":{"name":"guidedAccess","abstract":"Restricts access to certain features of a single app to keep the user focused.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/hearingDevice":{"name":"hearingDevice","abstract":"Pairing status of a hearing aid.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/shakeToUndo":{"name":"shakeToUndo","abstract":"Deletes the last command by shaking the phone.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakScreen":{"name":"speakScreen","abstract":"Reads out the content of the current screen.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakSelection":{"name":"speakSelection","abstract":"Reads out the selected content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO25differentiateWithoutColoryA2CmF":{"name":"differentiateWithoutColor","abstract":"Helps color blind users to differentiate settings differently, e.g. by using shapes rather than colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18fullKeyboardAccessyA2CmF":{"name":"fullKeyboardAccess","abstract":"Enables users to navigate through items of the screen without having to use a mouse.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO16increaseContrastyA2CmF":{"name":"increaseContrast","abstract":"Increases contrast to make out text and interface elements.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/closedCaptioning":{"name":"closedCaptioning","abstract":"Displays subtitles when playing videos.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/grayscale":{"name":"grayscale","abstract":"Makes the display more readable for color blind people by using gray tones instead of colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/monoAudio":{"name":"monoAudio","abstract":"Merges stereo audio channels to help users that are hard of hearing or deaf in one ear.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/largerText":{"name":"largerText","abstract":"Increases legibility by making fonts bigger.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12invertColorsyA2CmF":{"name":"invertColors","abstract":"Helps people with low vision, color blindness, or sensitivity to brightness to read the display content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18reduceTransparencyyA2CmF":{"name":"reduceTransparency","abstract":"Removes transparency from layers to make them readable for users with visual impairment.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO13switchControlyA2CmF":{"name":"switchControl","abstract":"Allows users with limited mobility to control their device with the help of ability switches and other adaptive devices.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/boldText":{"name":"boldText","abstract":"Increases legibility by making fonts heavier.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12reduceMotionyA2CmF":{"name":"reduceMotion","abstract":"Reduces animations to help users with motion sickness and epilepsy issues.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO9voiceOveryA2CmF":{"name":"voiceOver","abstract":"The screen reader available on Apple platforms.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO4keys11forFeaturesSaySSGSayACG_tFZ":{"name":"keys(forFeatures:)","abstract":"Iterates through a given list of feature types and returns an array containing the feature names as strings.
","parent_name":"CapableFeature"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO1AyA2CmF":{"name":"A","abstract":"The minimum level of conformance.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO2AAyA2CmF":{"name":"AA","abstract":"The medium level of conformance including success criterias of level A.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO3AAAyA2CmF":{"name":"AAA","abstract":"The highest level of conformance including success criterias of level A and AA.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO6failedyA2CmF":{"name":"failed","abstract":"Indicates that no level of conformance has been reached.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO13contrastRatio8fontSize10isBoldFontAC12CoreGraphics7CGFloatV_AISbtcfc":{"name":"init(contrastRatio:fontSize:isBoldFont:)","abstract":"Initializes a ConformanceLevel based on a given contrast ratio and font information used for the text.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html":{"name":"ConformanceLevel","abstract":"An enum specifying all WCAG conformance levels.
"},"Enums/CapableFeature.html":{"name":"CapableFeature","abstract":"An enum specifying all features available on the current platform.
"},"Enums/HandicapEnabledMode.html":{"name":"HandicapEnabledMode","abstract":"This enum defines several modes which describe whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file +{"Typealiases.html#/Color":{"name":"Color","abstract":"Typealias used for colors. It maps to UIColor.
"},"Typealiases.html#/Font":{"name":"Font","abstract":"Typealias used for fonts. It maps to UIFont.
"},"Typealiases.html#/s:7Capable5Colora":{"name":"Color","abstract":"Typealias used for colors. It maps to NSColor.
"},"Typealiases.html#/s:7Capable4Fonta":{"name":"Font","abstract":"Typealias used for fonts. It maps to NSFont.
"},"Structs/HandicapStatus.html#/s:7Capable14HandicapStatusV8handicapAA0B0Vvp":{"name":"handicap","abstract":"The Handicap that has changed.
The Handicap‘s status (enabled or disabled). Note that the status depends on the Handicap’s enabledIf value (see HandicapEnabledMode).
A list of CapableFeatures that are expected to be enabled if a user has this handicap.
The name of the Handicap that can be used to uniquely identify the Handicap. This name is also used inside the status map.
This mode defines whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
Initializes a new Handicap object.
The feature type.
","parent_name":"FeatureStatus"},"Structs/FeatureStatus.html#/s:7Capable13FeatureStatusV12statusStringSSvp":{"name":"statusString","abstract":"The feature’s status: While most features can only have a status set to enabled or disabled, the ‘.largerText` feature offers the font scale set by the user.
","parent_name":"FeatureStatus"},"Structs/Capable.html#/s:7CapableAAV12withFeaturesABSayAA0A7FeatureOG_tcfc":{"name":"init(withFeatures:)","abstract":"Initializes the framework instance with a specified set of features. If no feature was provided, this defaults to all features available on the current platform.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV13withHandicapsABSayAA8HandicapVG_tcfc":{"name":"init(withHandicaps:)","abstract":"Initializes the framework instance with a set of Handicaps.
The statusMap property returns a dictionary of all CapableFeatures or Handicaps , that the Capable instance has been initialized with along with their current statuses. This object is compatible with most analytic SDKs such as Fabric Answers, Firebase Analytics, AppCenter Analytics, or HockeyApp.","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV16isFeatureEnabled7featureSbAA0aC0O_tF":{"name":"isFeatureEnabled(feature:)","abstract":"
Provides information regarding the current status of a provided feature.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV17isHandicapEnabled12handicapNameSbSS_tF":{"name":"isHandicapEnabled(handicapName:)","abstract":"Provides information regarding the current status of a provided Handicap.
The minimum log level that should be considered when logging messages. Note that the custom ‘onLog’ closure will only be called for messages of this log type or higher. This value defaults to OSLogType.debug.
A custom closure that should be used by the logger for all Capable instances instead of the default os_log implementation.
","parent_name":"Capable"},"Structs/Capable.html":{"name":"Capable","abstract":"This class defines the main interface of the Capable framework.
"},"Structs/FeatureStatus.html":{"name":"FeatureStatus","abstract":"Model class that describes the content of a Capable notification (see Notification.Name.CapableFeatureStatusDidChange)
Model class that groups a number of CapableFeatures to represent a user’s handicap.
Model class that describes the content of a Capable notification (see Notification.Name.CapableHandicapStatusDidChange)
Makes the given font scalable.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledFont(withName:ofSize:)":{"name":"scaledFont(withName:ofSize:)","abstract":"Creates a scalable font with the given font name and reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledSystemFont(ofSize:)":{"name":"scaledSystemFont(ofSize:)","abstract":"Creates a scalable system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledBoldSystemFont(ofSize:)":{"name":"scaledBoldSystemFont(ofSize:)","abstract":"Creates a scalable bold system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledItalicSystemFont(ofSize:)":{"name":"scaledItalicSystemFont(ofSize:)","abstract":"Creates a scalable italic system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C22FeatureStatusDidChangeABvpZ":{"name":"CapableFeatureStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed accessibility feature status changes.
","parent_name":"Name"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C23HandicapStatusDidChangeABvpZ":{"name":"CapableHandicapStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed Handicap status changes.
Extension that defines notification names provided by the Capable framework.
","parent_name":"Notification"},"Extensions/Color.html#/s:So7NSColorC7CapableE16getContrastRatio12forTextColor012onBackgroundH012CoreGraphics7CGFloatVSgAB_ABtFZ":{"name":"getContrastRatio(forTextColor:onBackgroundColor:)","abstract":"Calculates the color ratio for a text color on a background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor012onBackgroundE0ABSgAB_tFZ":{"name":"getTextColor(onBackgroundColor:)","abstract":"Returns the text color with the highest contrast (black or white) for a given background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor10fromColors8withFont012onBackgroundE016conformanceLevelABSgSayABG_So6NSFontCAbC011ConformanceM0OtFZ":{"name":"getTextColor(fromColors:withFont:onBackgroundColor:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of text colors and a background color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor07forTextE0ABSgAB_tFZ":{"name":"getBackgroundColor(forTextColor:)","abstract":"Returns the background color with the highest contrast (black or white) for a given text color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor10fromColors07forTextE08withFont16conformanceLevelABSgSayABG_ABSo6NSFontCAC011ConformanceM0OtFZ":{"name":"getBackgroundColor(fromColors:forTextColor:withFont:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of background colors and a text color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html":{"name":"Color","abstract":"Extension that adds functionality for calculating WCAG compliant high contrast colors.
"},"Extensions/Notification.html":{"name":"Notification"},"Extensions/UIFont.html":{"name":"UIFont","abstract":"Extension that adds functionality for creating scalable UIFont objects.
"},"Enums/HandicapEnabledMode.html#/s:7Capable19HandicapEnabledModeO010oneFeatureC0yA2CmF":{"name":"oneFeatureEnabled","abstract":"The Handicap‘s status is enabled if one of its features is currently set to enabled.
The Handicap‘s status is enabled if all its features are currently set to enabled.
Menu that helps people with motor skill impairments to do certain actions or gestures by using a single tap.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/darkerSystemColors":{"name":"darkerSystemColors","abstract":"Enhances text contrast.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/guidedAccess":{"name":"guidedAccess","abstract":"Restricts access to certain features of a single app to keep the user focused.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/hearingDevice":{"name":"hearingDevice","abstract":"Pairing status of a hearing aid.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/shakeToUndo":{"name":"shakeToUndo","abstract":"Deletes the last command by shaking the phone.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakScreen":{"name":"speakScreen","abstract":"Reads out the content of the current screen.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakSelection":{"name":"speakSelection","abstract":"Reads out the selected content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO25differentiateWithoutColoryA2CmF":{"name":"differentiateWithoutColor","abstract":"Helps color blind users to differentiate settings differently, e.g. by using shapes rather than colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18fullKeyboardAccessyA2CmF":{"name":"fullKeyboardAccess","abstract":"Enables users to navigate through items of the screen without having to use a mouse.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO16increaseContrastyA2CmF":{"name":"increaseContrast","abstract":"Increases contrast to make out text and interface elements.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/closedCaptioning":{"name":"closedCaptioning","abstract":"Displays subtitles when playing videos.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/grayscale":{"name":"grayscale","abstract":"Makes the display more readable for color blind people by using gray tones instead of colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/monoAudio":{"name":"monoAudio","abstract":"Merges stereo audio channels to help users that are hard of hearing or deaf in one ear.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/largerText":{"name":"largerText","abstract":"Increases legibility by making fonts bigger.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12invertColorsyA2CmF":{"name":"invertColors","abstract":"Helps people with low vision, color blindness, or sensitivity to brightness to read the display content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18reduceTransparencyyA2CmF":{"name":"reduceTransparency","abstract":"Removes transparency from layers to make them readable for users with visual impairment.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO13switchControlyA2CmF":{"name":"switchControl","abstract":"Allows users with limited mobility to control their device with the help of ability switches and other adaptive devices.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/boldText":{"name":"boldText","abstract":"Increases legibility by making fonts heavier.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12reduceMotionyA2CmF":{"name":"reduceMotion","abstract":"Reduces animations to help users with motion sickness and epilepsy issues.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO9voiceOveryA2CmF":{"name":"voiceOver","abstract":"The screen reader available on Apple platforms.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO4keys11forFeaturesSaySSGSayACG_tFZ":{"name":"keys(forFeatures:)","abstract":"Iterates through a given list of feature types and returns an array containing the feature names as strings.
","parent_name":"CapableFeature"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO1AyA2CmF":{"name":"A","abstract":"The minimum level of conformance.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO2AAyA2CmF":{"name":"AA","abstract":"The medium level of conformance including success criterias of level A.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO3AAAyA2CmF":{"name":"AAA","abstract":"The highest level of conformance including success criterias of level A and AA.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO6failedyA2CmF":{"name":"failed","abstract":"Indicates that no level of conformance has been reached.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO13contrastRatio8fontSize10isBoldFontAC12CoreGraphics7CGFloatV_AISbtcfc":{"name":"init(contrastRatio:fontSize:isBoldFont:)","abstract":"Initializes a ConformanceLevel based on a given contrast ratio and font information used for the text.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO4textSSvp":{"name":"text","abstract":"The text representation of the conformance level.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html":{"name":"ConformanceLevel","abstract":"An enum specifying all WCAG conformance levels.
"},"Enums/CapableFeature.html":{"name":"CapableFeature","abstract":"An enum specifying all features available on the current platform.
"},"Enums/HandicapEnabledMode.html":{"name":"HandicapEnabledMode","abstract":"This enum defines several modes which describe whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file diff --git a/Documentation/docsets/Capable.docset/Contents/Resources/docSet.dsidx b/Documentation/docsets/Capable.docset/Contents/Resources/docSet.dsidx index 17fb65a..7f9cb81 100644 Binary files a/Documentation/docsets/Capable.docset/Contents/Resources/docSet.dsidx and b/Documentation/docsets/Capable.docset/Contents/Resources/docSet.dsidx differ diff --git a/Documentation/docsets/Capable.tgz b/Documentation/docsets/Capable.tgz index ef62228..6b72e1d 100644 Binary files a/Documentation/docsets/Capable.tgz and b/Documentation/docsets/Capable.tgz differ diff --git a/Documentation/index.html b/Documentation/index.html index 1bb7733..26f1ac2 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -174,7 +174,7 @@dependencies: [
- .package(url: "https://github.com/chrs1885/Capable.git", from: "1.0.0")
+ .package(url: "https://github.com/chrs1885/Capable.git", from: "1.0.1")
]
Typealias used for colors. It maps to UIColor.
"},"Typealiases.html#/Font":{"name":"Font","abstract":"Typealias used for fonts. It maps to UIFont.
"},"Typealiases.html#/s:7Capable5Colora":{"name":"Color","abstract":"Typealias used for colors. It maps to NSColor.
"},"Typealiases.html#/s:7Capable4Fonta":{"name":"Font","abstract":"Typealias used for fonts. It maps to NSFont.
"},"Structs/HandicapStatus.html#/s:7Capable14HandicapStatusV8handicapAA0B0Vvp":{"name":"handicap","abstract":"The Handicap that has changed.
The Handicap‘s status (enabled or disabled). Note that the status depends on the Handicap’s enabledIf value (see HandicapEnabledMode).
A list of CapableFeatures that are expected to be enabled if a user has this handicap.
The name of the Handicap that can be used to uniquely identify the Handicap. This name is also used inside the status map.
This mode defines whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
Initializes a new Handicap object.
The feature type.
","parent_name":"FeatureStatus"},"Structs/FeatureStatus.html#/s:7Capable13FeatureStatusV12statusStringSSvp":{"name":"statusString","abstract":"The feature’s status: While most features can only have a status set to enabled or disabled, the ‘.largerText` feature offers the font scale set by the user.
","parent_name":"FeatureStatus"},"Structs/Capable.html#/s:7CapableAAV12withFeaturesABSayAA0A7FeatureOG_tcfc":{"name":"init(withFeatures:)","abstract":"Initializes the framework instance with a specified set of features. If no feature was provided, this defaults to all features available on the current platform.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV13withHandicapsABSayAA8HandicapVG_tcfc":{"name":"init(withHandicaps:)","abstract":"Initializes the framework instance with a set of Handicaps.
The statusMap property returns a dictionary of all CapableFeatures or Handicaps , that the Capable instance has been initialized with along with their current statuses. This object is compatible with most analytic SDKs such as Fabric Answers, Firebase Analytics, AppCenter Analytics, or HockeyApp.","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV16isFeatureEnabled7featureSbAA0aC0O_tF":{"name":"isFeatureEnabled(feature:)","abstract":"
Provides information regarding the current status of a provided feature.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV17isHandicapEnabled12handicapNameSbSS_tF":{"name":"isHandicapEnabled(handicapName:)","abstract":"Provides information regarding the current status of a provided Handicap.
The minimum log level that should be considered when logging messages. Note that the custom ‘onLog’ closure will only be called for messages of this log type or higher. This value defaults to OSLogType.debug.
A custom closure that should be used by the logger for all Capable instances instead of the default os_log implementation.
","parent_name":"Capable"},"Structs/Capable.html":{"name":"Capable","abstract":"This class defines the main interface of the Capable framework.
"},"Structs/FeatureStatus.html":{"name":"FeatureStatus","abstract":"Model class that describes the content of a Capable notification (see Notification.Name.CapableFeatureStatusDidChange)
Model class that groups a number of CapableFeatures to represent a user’s handicap.
Model class that describes the content of a Capable notification (see Notification.Name.CapableHandicapStatusDidChange)
Makes the given font scalable.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledFont(withName:ofSize:)":{"name":"scaledFont(withName:ofSize:)","abstract":"Creates a scalable font with the given font name and reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledSystemFont(ofSize:)":{"name":"scaledSystemFont(ofSize:)","abstract":"Creates a scalable system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledBoldSystemFont(ofSize:)":{"name":"scaledBoldSystemFont(ofSize:)","abstract":"Creates a scalable bold system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledItalicSystemFont(ofSize:)":{"name":"scaledItalicSystemFont(ofSize:)","abstract":"Creates a scalable italic system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C22FeatureStatusDidChangeABvpZ":{"name":"CapableFeatureStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed accessibility feature status changes.
","parent_name":"Name"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C23HandicapStatusDidChangeABvpZ":{"name":"CapableHandicapStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed Handicap status changes.
Extension that defines notification names provided by the Capable framework.
","parent_name":"Notification"},"Extensions/Color.html#/s:So7NSColorC7CapableE16getContrastRatio12forTextColor012onBackgroundH012CoreGraphics7CGFloatVSgAB_ABtFZ":{"name":"getContrastRatio(forTextColor:onBackgroundColor:)","abstract":"Calculates the color ratio for a text color on a background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor012onBackgroundE0ABSgAB_tFZ":{"name":"getTextColor(onBackgroundColor:)","abstract":"Returns the text color with the highest contrast (black or white) for a given background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor10fromColors8withFont012onBackgroundE016conformanceLevelABSgSayABG_So6NSFontCAbC011ConformanceM0OtFZ":{"name":"getTextColor(fromColors:withFont:onBackgroundColor:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of text colors and a background color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor07forTextE0ABSgAB_tFZ":{"name":"getBackgroundColor(forTextColor:)","abstract":"Returns the background color with the highest contrast (black or white) for a given text color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor10fromColors07forTextE08withFont16conformanceLevelABSgSayABG_ABSo6NSFontCAC011ConformanceM0OtFZ":{"name":"getBackgroundColor(fromColors:forTextColor:withFont:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of background colors and a text color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html":{"name":"Color","abstract":"Extension that adds functionality for calculating WCAG compliant high contrast colors.
"},"Extensions/Notification.html":{"name":"Notification"},"Extensions/UIFont.html":{"name":"UIFont","abstract":"Extension that adds functionality for creating scalable UIFont objects.
"},"Enums/HandicapEnabledMode.html#/s:7Capable19HandicapEnabledModeO010oneFeatureC0yA2CmF":{"name":"oneFeatureEnabled","abstract":"The Handicap‘s status is enabled if one of its features is currently set to enabled.
The Handicap‘s status is enabled if all its features are currently set to enabled.
Menu that helps people with motor skill impairments to do certain actions or gestures by using a single tap.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/darkerSystemColors":{"name":"darkerSystemColors","abstract":"Enhances text contrast.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/guidedAccess":{"name":"guidedAccess","abstract":"Restricts access to certain features of a single app to keep the user focused.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/hearingDevice":{"name":"hearingDevice","abstract":"Pairing status of a hearing aid.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/shakeToUndo":{"name":"shakeToUndo","abstract":"Deletes the last command by shaking the phone.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakScreen":{"name":"speakScreen","abstract":"Reads out the content of the current screen.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakSelection":{"name":"speakSelection","abstract":"Reads out the selected content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO25differentiateWithoutColoryA2CmF":{"name":"differentiateWithoutColor","abstract":"Helps color blind users to differentiate settings differently, e.g. by using shapes rather than colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18fullKeyboardAccessyA2CmF":{"name":"fullKeyboardAccess","abstract":"Enables users to navigate through items of the screen without having to use a mouse.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO16increaseContrastyA2CmF":{"name":"increaseContrast","abstract":"Increases contrast to make out text and interface elements.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/closedCaptioning":{"name":"closedCaptioning","abstract":"Displays subtitles when playing videos.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/grayscale":{"name":"grayscale","abstract":"Makes the display more readable for color blind people by using gray tones instead of colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/monoAudio":{"name":"monoAudio","abstract":"Merges stereo audio channels to help users that are hard of hearing or deaf in one ear.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/largerText":{"name":"largerText","abstract":"Increases legibility by making fonts bigger.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12invertColorsyA2CmF":{"name":"invertColors","abstract":"Helps people with low vision, color blindness, or sensitivity to brightness to read the display content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18reduceTransparencyyA2CmF":{"name":"reduceTransparency","abstract":"Removes transparency from layers to make them readable for users with visual impairment.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO13switchControlyA2CmF":{"name":"switchControl","abstract":"Allows users with limited mobility to control their device with the help of ability switches and other adaptive devices.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/boldText":{"name":"boldText","abstract":"Increases legibility by making fonts heavier.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12reduceMotionyA2CmF":{"name":"reduceMotion","abstract":"Reduces animations to help users with motion sickness and epilepsy issues.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO9voiceOveryA2CmF":{"name":"voiceOver","abstract":"The screen reader available on Apple platforms.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO4keys11forFeaturesSaySSGSayACG_tFZ":{"name":"keys(forFeatures:)","abstract":"Iterates through a given list of feature types and returns an array containing the feature names as strings.
","parent_name":"CapableFeature"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO1AyA2CmF":{"name":"A","abstract":"The minimum level of conformance.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO2AAyA2CmF":{"name":"AA","abstract":"The medium level of conformance including success criterias of level A.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO3AAAyA2CmF":{"name":"AAA","abstract":"The highest level of conformance including success criterias of level A and AA.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO6failedyA2CmF":{"name":"failed","abstract":"Indicates that no level of conformance has been reached.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO13contrastRatio8fontSize10isBoldFontAC12CoreGraphics7CGFloatV_AISbtcfc":{"name":"init(contrastRatio:fontSize:isBoldFont:)","abstract":"Initializes a ConformanceLevel based on a given contrast ratio and font information used for the text.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html":{"name":"ConformanceLevel","abstract":"An enum specifying all WCAG conformance levels.
"},"Enums/CapableFeature.html":{"name":"CapableFeature","abstract":"An enum specifying all features available on the current platform.
"},"Enums/HandicapEnabledMode.html":{"name":"HandicapEnabledMode","abstract":"This enum defines several modes which describe whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file +{"Typealiases.html#/Color":{"name":"Color","abstract":"Typealias used for colors. It maps to UIColor.
"},"Typealiases.html#/Font":{"name":"Font","abstract":"Typealias used for fonts. It maps to UIFont.
"},"Typealiases.html#/s:7Capable5Colora":{"name":"Color","abstract":"Typealias used for colors. It maps to NSColor.
"},"Typealiases.html#/s:7Capable4Fonta":{"name":"Font","abstract":"Typealias used for fonts. It maps to NSFont.
"},"Structs/HandicapStatus.html#/s:7Capable14HandicapStatusV8handicapAA0B0Vvp":{"name":"handicap","abstract":"The Handicap that has changed.
The Handicap‘s status (enabled or disabled). Note that the status depends on the Handicap’s enabledIf value (see HandicapEnabledMode).
A list of CapableFeatures that are expected to be enabled if a user has this handicap.
The name of the Handicap that can be used to uniquely identify the Handicap. This name is also used inside the status map.
This mode defines whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
Initializes a new Handicap object.
The feature type.
","parent_name":"FeatureStatus"},"Structs/FeatureStatus.html#/s:7Capable13FeatureStatusV12statusStringSSvp":{"name":"statusString","abstract":"The feature’s status: While most features can only have a status set to enabled or disabled, the ‘.largerText` feature offers the font scale set by the user.
","parent_name":"FeatureStatus"},"Structs/Capable.html#/s:7CapableAAV12withFeaturesABSayAA0A7FeatureOG_tcfc":{"name":"init(withFeatures:)","abstract":"Initializes the framework instance with a specified set of features. If no feature was provided, this defaults to all features available on the current platform.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV13withHandicapsABSayAA8HandicapVG_tcfc":{"name":"init(withHandicaps:)","abstract":"Initializes the framework instance with a set of Handicaps.
The statusMap property returns a dictionary of all CapableFeatures or Handicaps , that the Capable instance has been initialized with along with their current statuses. This object is compatible with most analytic SDKs such as Fabric Answers, Firebase Analytics, AppCenter Analytics, or HockeyApp.","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV16isFeatureEnabled7featureSbAA0aC0O_tF":{"name":"isFeatureEnabled(feature:)","abstract":"
Provides information regarding the current status of a provided feature.
","parent_name":"Capable"},"Structs/Capable.html#/s:7CapableAAV17isHandicapEnabled12handicapNameSbSS_tF":{"name":"isHandicapEnabled(handicapName:)","abstract":"Provides information regarding the current status of a provided Handicap.
The minimum log level that should be considered when logging messages. Note that the custom ‘onLog’ closure will only be called for messages of this log type or higher. This value defaults to OSLogType.debug.
A custom closure that should be used by the logger for all Capable instances instead of the default os_log implementation.
","parent_name":"Capable"},"Structs/Capable.html":{"name":"Capable","abstract":"This class defines the main interface of the Capable framework.
"},"Structs/FeatureStatus.html":{"name":"FeatureStatus","abstract":"Model class that describes the content of a Capable notification (see Notification.Name.CapableFeatureStatusDidChange)
Model class that groups a number of CapableFeatures to represent a user’s handicap.
Model class that describes the content of a Capable notification (see Notification.Name.CapableHandicapStatusDidChange)
Makes the given font scalable.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledFont(withName:ofSize:)":{"name":"scaledFont(withName:ofSize:)","abstract":"Creates a scalable font with the given font name and reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledSystemFont(ofSize:)":{"name":"scaledSystemFont(ofSize:)","abstract":"Creates a scalable system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledBoldSystemFont(ofSize:)":{"name":"scaledBoldSystemFont(ofSize:)","abstract":"Creates a scalable bold system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/UIFont.html#/scaledItalicSystemFont(ofSize:)":{"name":"scaledItalicSystemFont(ofSize:)","abstract":"Creates a scalable italic system font with a given reference font size.
","parent_name":"UIFont"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C22FeatureStatusDidChangeABvpZ":{"name":"CapableFeatureStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed accessibility feature status changes.
","parent_name":"Name"},"Extensions/Notification/Name.html#/s:So18NSNotificationNamea7CapableE0C23HandicapStatusDidChangeABvpZ":{"name":"CapableHandicapStatusDidChange","abstract":"Name of the notification that gets fired whenever an observed Handicap status changes.
Extension that defines notification names provided by the Capable framework.
","parent_name":"Notification"},"Extensions/Color.html#/s:So7NSColorC7CapableE16getContrastRatio12forTextColor012onBackgroundH012CoreGraphics7CGFloatVSgAB_ABtFZ":{"name":"getContrastRatio(forTextColor:onBackgroundColor:)","abstract":"Calculates the color ratio for a text color on a background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor012onBackgroundE0ABSgAB_tFZ":{"name":"getTextColor(onBackgroundColor:)","abstract":"Returns the text color with the highest contrast (black or white) for a given background color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE12getTextColor10fromColors8withFont012onBackgroundE016conformanceLevelABSgSayABG_So6NSFontCAbC011ConformanceM0OtFZ":{"name":"getTextColor(fromColors:withFont:onBackgroundColor:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of text colors and a background color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor07forTextE0ABSgAB_tFZ":{"name":"getBackgroundColor(forTextColor:)","abstract":"Returns the background color with the highest contrast (black or white) for a given text color.
","parent_name":"Color"},"Extensions/Color.html#/s:So7NSColorC7CapableE18getBackgroundColor10fromColors07forTextE08withFont16conformanceLevelABSgSayABG_ABSo6NSFontCAC011ConformanceM0OtFZ":{"name":"getBackgroundColor(fromColors:forTextColor:withFont:conformanceLevel:)","abstract":"Calculates the contrast ratio of a given list of background colors and a text color. The first color that conforms to the conformance level defined gets returned. The default conformance level is .AA.
","parent_name":"Color"},"Extensions/Color.html":{"name":"Color","abstract":"Extension that adds functionality for calculating WCAG compliant high contrast colors.
"},"Extensions/Notification.html":{"name":"Notification"},"Extensions/UIFont.html":{"name":"UIFont","abstract":"Extension that adds functionality for creating scalable UIFont objects.
"},"Enums/HandicapEnabledMode.html#/s:7Capable19HandicapEnabledModeO010oneFeatureC0yA2CmF":{"name":"oneFeatureEnabled","abstract":"The Handicap‘s status is enabled if one of its features is currently set to enabled.
The Handicap‘s status is enabled if all its features are currently set to enabled.
Menu that helps people with motor skill impairments to do certain actions or gestures by using a single tap.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/darkerSystemColors":{"name":"darkerSystemColors","abstract":"Enhances text contrast.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/guidedAccess":{"name":"guidedAccess","abstract":"Restricts access to certain features of a single app to keep the user focused.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/hearingDevice":{"name":"hearingDevice","abstract":"Pairing status of a hearing aid.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/shakeToUndo":{"name":"shakeToUndo","abstract":"Deletes the last command by shaking the phone.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakScreen":{"name":"speakScreen","abstract":"Reads out the content of the current screen.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/speakSelection":{"name":"speakSelection","abstract":"Reads out the selected content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO25differentiateWithoutColoryA2CmF":{"name":"differentiateWithoutColor","abstract":"Helps color blind users to differentiate settings differently, e.g. by using shapes rather than colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18fullKeyboardAccessyA2CmF":{"name":"fullKeyboardAccess","abstract":"Enables users to navigate through items of the screen without having to use a mouse.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO16increaseContrastyA2CmF":{"name":"increaseContrast","abstract":"Increases contrast to make out text and interface elements.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/closedCaptioning":{"name":"closedCaptioning","abstract":"Displays subtitles when playing videos.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/grayscale":{"name":"grayscale","abstract":"Makes the display more readable for color blind people by using gray tones instead of colors.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/monoAudio":{"name":"monoAudio","abstract":"Merges stereo audio channels to help users that are hard of hearing or deaf in one ear.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/largerText":{"name":"largerText","abstract":"Increases legibility by making fonts bigger.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12invertColorsyA2CmF":{"name":"invertColors","abstract":"Helps people with low vision, color blindness, or sensitivity to brightness to read the display content.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO18reduceTransparencyyA2CmF":{"name":"reduceTransparency","abstract":"Removes transparency from layers to make them readable for users with visual impairment.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO13switchControlyA2CmF":{"name":"switchControl","abstract":"Allows users with limited mobility to control their device with the help of ability switches and other adaptive devices.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/boldText":{"name":"boldText","abstract":"Increases legibility by making fonts heavier.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO12reduceMotionyA2CmF":{"name":"reduceMotion","abstract":"Reduces animations to help users with motion sickness and epilepsy issues.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO9voiceOveryA2CmF":{"name":"voiceOver","abstract":"The screen reader available on Apple platforms.
","parent_name":"CapableFeature"},"Enums/CapableFeature.html#/s:7Capable0A7FeatureO4keys11forFeaturesSaySSGSayACG_tFZ":{"name":"keys(forFeatures:)","abstract":"Iterates through a given list of feature types and returns an array containing the feature names as strings.
","parent_name":"CapableFeature"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO1AyA2CmF":{"name":"A","abstract":"The minimum level of conformance.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO2AAyA2CmF":{"name":"AA","abstract":"The medium level of conformance including success criterias of level A.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO3AAAyA2CmF":{"name":"AAA","abstract":"The highest level of conformance including success criterias of level A and AA.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO6failedyA2CmF":{"name":"failed","abstract":"Indicates that no level of conformance has been reached.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO13contrastRatio8fontSize10isBoldFontAC12CoreGraphics7CGFloatV_AISbtcfc":{"name":"init(contrastRatio:fontSize:isBoldFont:)","abstract":"Initializes a ConformanceLevel based on a given contrast ratio and font information used for the text.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html#/s:7Capable16ConformanceLevelO4textSSvp":{"name":"text","abstract":"The text representation of the conformance level.
","parent_name":"ConformanceLevel"},"Enums/ConformanceLevel.html":{"name":"ConformanceLevel","abstract":"An enum specifying all WCAG conformance levels.
"},"Enums/CapableFeature.html":{"name":"CapableFeature","abstract":"An enum specifying all features available on the current platform.
"},"Enums/HandicapEnabledMode.html":{"name":"HandicapEnabledMode","abstract":"This enum defines several modes which describe whether all features need to be enabled to set the Handicap‘s status to enabled or only one of them.
The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file diff --git a/Example/Podfile b/Example/Podfile index 1fd7e7c..a24d42b 100644 --- a/Example/Podfile +++ b/Example/Podfile @@ -1,5 +1,5 @@ def sharedPods - pod 'Capable', '~> 0.9.0' + pod 'Capable', path: '../' end target 'Example-iOS' do @@ -8,7 +8,7 @@ target 'Example-iOS' do sharedPods pod 'SheetyColors' - pod 'AppCenter/Analytics' + pod 'AppCenter/Analytics', '1.14.0' pod 'Fabric' pod 'Answers' pod 'Firebase/Core' diff --git a/Example/Podfile.lock b/Example/Podfile.lock index e662dba..fb37e6c 100644 --- a/Example/Podfile.lock +++ b/Example/Podfile.lock @@ -4,71 +4,71 @@ PODS: - AppCenter/Analytics (1.14.0): - AppCenter/Core - AppCenter/Core (1.14.0) - - Capable (0.9.0): - - Capable/Colors (= 0.9.0) - - Capable/Features (= 0.9.0) - - Capable/Fonts (= 0.9.0) - - Capable/Colors (0.9.0) - - Capable/Features (0.9.0) - - Capable/Fonts (0.9.0) + - Capable (1.0.1): + - Capable/Colors (= 1.0.1) + - Capable/Features (= 1.0.1) + - Capable/Fonts (= 1.0.1) + - Capable/Colors (1.0.1) + - Capable/Features (1.0.1) + - Capable/Fonts (1.0.1) - Fabric (1.8.2) - - Firebase/Core (5.20.2): + - Firebase/Core (6.1.0): - Firebase/CoreOnly - - FirebaseAnalytics (= 5.8.1) - - Firebase/CoreOnly (5.20.2): - - FirebaseCore (= 5.4.1) - - FirebaseAnalytics (5.8.1): - - FirebaseCore (~> 5.4) - - FirebaseInstanceID (~> 3.8) - - GoogleAppMeasurement (= 5.8.1) - - GoogleUtilities/AppDelegateSwizzler (~> 5.2) - - GoogleUtilities/MethodSwizzler (~> 5.2) - - GoogleUtilities/Network (~> 5.2) - - "GoogleUtilities/NSData+zlib (~> 5.2)" + - FirebaseAnalytics (= 6.0.1) + - Firebase/CoreOnly (6.1.0): + - FirebaseCore (= 6.0.1) + - FirebaseAnalytics (6.0.1): + - FirebaseCore (~> 6.0) + - FirebaseInstanceID (~> 4.1) + - GoogleAppMeasurement (= 6.0.1) + - GoogleUtilities/AppDelegateSwizzler (~> 6.0) + - GoogleUtilities/MethodSwizzler (~> 6.0) + - GoogleUtilities/Network (~> 6.0) + - "GoogleUtilities/NSData+zlib (~> 6.0)" - nanopb (~> 0.3) - - FirebaseCore (5.4.1): - - GoogleUtilities/Environment (~> 5.2) - - GoogleUtilities/Logger (~> 5.2) - - FirebaseInstanceID (3.8.1): - - FirebaseCore (~> 5.2) - - GoogleUtilities/Environment (~> 5.2) - - GoogleUtilities/UserDefaults (~> 5.2) - - GoogleAppMeasurement (5.8.1): - - GoogleUtilities/AppDelegateSwizzler (~> 5.2) - - GoogleUtilities/MethodSwizzler (~> 5.2) - - GoogleUtilities/Network (~> 5.2) - - "GoogleUtilities/NSData+zlib (~> 5.2)" + - FirebaseCore (6.0.1): + - GoogleUtilities/Environment (~> 6.0) + - GoogleUtilities/Logger (~> 6.0) + - FirebaseInstanceID (4.1.0): + - FirebaseCore (~> 6.0) + - GoogleUtilities/Environment (~> 6.0) + - GoogleUtilities/UserDefaults (~> 6.0) + - GoogleAppMeasurement (6.0.1): + - GoogleUtilities/AppDelegateSwizzler (~> 6.0) + - GoogleUtilities/MethodSwizzler (~> 6.0) + - GoogleUtilities/Network (~> 6.0) + - "GoogleUtilities/NSData+zlib (~> 6.0)" - nanopb (~> 0.3) - - GoogleUtilities/AppDelegateSwizzler (5.8.0): + - GoogleUtilities/AppDelegateSwizzler (6.2.0): - GoogleUtilities/Environment - GoogleUtilities/Logger - GoogleUtilities/Network - - GoogleUtilities/Environment (5.8.0) - - GoogleUtilities/Logger (5.8.0): + - GoogleUtilities/Environment (6.2.0) + - GoogleUtilities/Logger (6.2.0): - GoogleUtilities/Environment - - GoogleUtilities/MethodSwizzler (5.8.0): + - GoogleUtilities/MethodSwizzler (6.2.0): - GoogleUtilities/Logger - - GoogleUtilities/Network (5.8.0): + - GoogleUtilities/Network (6.2.0): - GoogleUtilities/Logger - "GoogleUtilities/NSData+zlib" - GoogleUtilities/Reachability - - "GoogleUtilities/NSData+zlib (5.8.0)" - - GoogleUtilities/Reachability (5.8.0): + - "GoogleUtilities/NSData+zlib (6.2.0)" + - GoogleUtilities/Reachability (6.2.0): - GoogleUtilities/Logger - - GoogleUtilities/UserDefaults (5.8.0): + - GoogleUtilities/UserDefaults (6.2.0): - GoogleUtilities/Logger - nanopb (0.3.901): - nanopb/decode (= 0.3.901) - nanopb/encode (= 0.3.901) - nanopb/decode (0.3.901) - nanopb/encode (0.3.901) - - SheetyColors (0.3.0): - - Capable/Colors (~> 0.9.0) + - SheetyColors (0.3.1): + - Capable/Colors (~> 1.0.0) DEPENDENCIES: - Answers - - AppCenter/Analytics - - Capable (~> 0.9.0) + - AppCenter/Analytics (= 1.14.0) + - Capable (from `../`) - Fabric - Firebase/Core - SheetyColors @@ -77,7 +77,6 @@ SPEC REPOS: https://github.com/cocoapods/specs.git: - Answers - AppCenter - - Capable - Fabric - Firebase - FirebaseAnalytics @@ -88,20 +87,24 @@ SPEC REPOS: - nanopb - SheetyColors +EXTERNAL SOURCES: + Capable: + :path: "../" + SPEC CHECKSUMS: Answers: e7317ccd30e7bf55c3bacfe28adbe2304b082e49 AppCenter: 02c5efe08d3bbab5421ae41d5f7aa7238906b817 - Capable: 3f2cbbd61326df7304ff97ca4b954c2de2e3ff43 + Capable: f102b9cb3167470fac31d07d175b95ecb4f9ca9a Fabric: d2b22f443ba195d8a7cc204da230977c72733b40 - Firebase: 0c8cf33f266410c61ab3e2265cfa412200351d9c - FirebaseAnalytics: ece1aa57a4f43c64d53a648b5a5e05151aae947b - FirebaseCore: f1a9a8be1aee4bf71a2fc0f4096df6788bdfda61 - FirebaseInstanceID: a122b0c258720cf250551bb2bedf48c699f80d90 - GoogleAppMeasurement: ffe513e90551844a739e7bcbb1d2aca1c28a4338 - GoogleUtilities: 04fce34bcd5620c1ee76fb79172105c74a4df335 + Firebase: 8d77bb33624ae9b62d745d82ec023de5f70f7e4f + FirebaseAnalytics: 629301c2b9925f3537d4093a17a72751ae5b7084 + FirebaseCore: 66bdef3b310a026880e2a5bc8aa586ab62ce4543 + FirebaseInstanceID: 27bed93a59b6685f5c3e0c028a878a764fd75c33 + GoogleAppMeasurement: 51d8d9ea48f0ca44484d29cfbdef976fbd4fc336 + GoogleUtilities: 996e0db07153674fd1b54b220fda3a3dc3547cba nanopb: 2901f78ea1b7b4015c860c2fdd1ea2fee1a18d48 - SheetyColors: 635021ca45c08654941011c4be840460fcb9a0ff + SheetyColors: 71fc251618928f399503138093229e3ea700b35f -PODFILE CHECKSUM: 6ef241208de4f6ab41a7e17a8e5ba864002279b1 +PODFILE CHECKSUM: b6b60cbce08e7b88bb2acc2c5dee948795b58baf COCOAPODS: 1.6.0.rc.2 diff --git a/README.md b/README.md index 0425d87..fb5e0cd 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ github "chrs1885/Capable" ```ruby dependencies: [ - .package(url: "https://github.com/chrs1885/Capable.git", from: "1.0.0") + .package(url: "https://github.com/chrs1885/Capable.git", from: "1.0.1") ] ``` diff --git a/Source/Colors/Models/ConformanceLevel.swift b/Source/Colors/Models/ConformanceLevel.swift index 7bbe497..fc8a65c 100644 --- a/Source/Colors/Models/ConformanceLevel.swift +++ b/Source/Colors/Models/ConformanceLevel.swift @@ -59,6 +59,20 @@ extension ConformanceLevel { self = value } + /// The text representation of the conformance level. + public var text: String { + switch self { + case .A: + return "A" + case .AA: + return "AA" + case .AAA: + return "AAA" + case .failed: + return "failed" + } + } + static func >= (lhs: ConformanceLevel, rhs: ConformanceLevel) -> Bool { return lhs.rawValue >= rhs.rawValue } diff --git a/Source/Colors/Models/FontProps.swift b/Source/Colors/Models/FontProps.swift index ad116ee..6465908 100644 --- a/Source/Colors/Models/FontProps.swift +++ b/Source/Colors/Models/FontProps.swift @@ -12,6 +12,6 @@ struct FontProps: Equatable { var isBoldFont: Bool var isLargeText: Bool { - return self.fontSize >= 18.0 || (self.fontSize >= 14 && self.isBoldFont) + return self.fontSize >= 18.0 || (self.fontSize >= 14.0 && self.isBoldFont) } } diff --git a/Tests/Colors/ConformanceLevelTests.swift b/Tests/Colors/ConformanceLevelTests.swift index bc41cba..810c82b 100644 --- a/Tests/Colors/ConformanceLevelTests.swift +++ b/Tests/Colors/ConformanceLevelTests.swift @@ -113,6 +113,32 @@ class ConformanceLevelTests: QuickSpec { } } + context("when retrieving the text property value") { + context("for conformance level .A") { + it("returns 'A'") { + expect(ConformanceLevel.A.text).to(equal("A")) + } + } + + context("for conformance level .AA") { + it("returns 'AA'") { + expect(ConformanceLevel.AA.text).to(equal("AA")) + } + } + + context("for conformance level .AAA") { + it("returns 'AAA'") { + expect(ConformanceLevel.AAA.text).to(equal("AAA")) + } + } + + context("for conformance level .failed") { + it("returns 'failed'") { + expect(ConformanceLevel.failed.text).to(equal("failed")) + } + } + } + context("when comparing ConformanceLevel types by using >= operator") { it("returns the correct result") { expect(ConformanceLevel.AAA >= ConformanceLevel.AAA).to(beTrue())