String
public extension String
-
Source string content type.
See moreDeclaration
Swift
enum BionicReadingContentType
-
Convert HTML or plaintext to BIonic Reading.
Bolded parts of the returned HTML will be wrapped using the
<b>
tag.<b class="bionic-b" style="opacity: 1.0;">Bio</b>nic
Declaration
Swift
func bionicReadableHTML(sourceType type: BionicReadingContentType = .automatic, fixation: Int? = nil, saccade: Int? = nil, opacity: Int? = nil) -> String
Parameters
type
Input text content type.
fixation
if
nil
,fixation
fromBionicReadingSettings
will be used.saccade
if
nil
,saccade
fromBionicReadingSettings
will be used.opacity
if
nil
,opacity
fromBionicReadingSettings
will be used.Return Value
HTML string with Bionic Reading applied.
-
Convert plaintext to BIonic Reading.
Important
This method only works for plaintext source strings.
Declaration
Swift
func bionicReadableAttributedString(with font: UIFont_or_NSFont? = nil, color: UIColor_or_NSColor? = nil, fixation: Int? = nil, saccade: Int? = nil, opacity: Int? = nil) -> NSMutableAttributedString
Parameters
font
If
nil
, the default font for text stylebody
will be used.color
If
nil
, the default color for text will be used.fixation
if
nil
,fixation
fromBionicReadingSettings
will be used.saccade
if
nil
,saccade
fromBionicReadingSettings
will be used.opacity
if
nil
,opacity
fromBionicReadingSettings
will be used.Return Value
NSMutableAttributedString
with Bionic Reading applied. This returnedNSAttributedString
includes the custom attributeNSAttributedString.Key.bionicReadingBold
with a value oftrue
orfalse
.