1.0.5 • Published 5 years ago
ti.attributed v1.0.5
ti.attributed
Attributed strings made easy for Appcelerator Titanium Alloy MVC framework. Most of the Attributed Strings available through this module are documented from https://wiki.appcelerator.org/display/guides2/Attributed+Strings
Quick Start
How to use
You can use this library from different way, from Controller, View / Style
Controller: ES6
import { underline } from 'ti.attributed';
underline($.label, 'wordInLabelToUnderline')
ES5
const tiAttributed = require('ti.attributed')
tiAttributed.underline($.label, 'wordInLabel')
View
<Label module='ti.attributed' attribute: 'underline' text='Hello this will be underlined' />
TSS
<Label class='myLabel' module='ti.attributed' />
".myLabel" : {
attribute: 'underline',
text: 'Hello this will be underlined'
}
Methods (Attributed Strings) available
- color
- backgroundColor
- underline
- underlineAndColor
- bold
- boldAndColor
- strikethrough
- link
- kern
- shadow
- letterpress
- baseline
- obliqueness
- stretch
Method | Description | Use |
---|---|---|
color | Change the text color | |
backgroundColor | Change the text backgroundColor | |
underline | Underline the text | |
underlineAndColor | Underline and change the text color | |
bold | Bold the text | |
boldAndColor | Bold and change the text color | |
strikethrough | Strike the text | |
link | Add link to the text | |
kern | Kern the text | |
shadow | Add shadow to the text | |
letterpress | Letter Pres the text | |
baseline | Baseline the text | |
obliqueness | Add obliqueness to the text | |
stretch | Stretch the text |
Properties available
- attribute
- wordAttribute
- wordValue
- attributeColor
- attributeFont
Property | Description | Use |
---|---|---|
attribute | Method / Atributed string name | *required |
wordAttribute | Attributed string applied to | *required |
wordValue | Additional Attributed value for select methods | *optional |
attributeColor | Color for select methods | *required |
attributeFont | Font for select methods | *required |
Examples
color($.label, 'wordInLabelToColor', '#000')
backgroundColor($.label, 'wordInLabelToChangeBackgroundColor', '#000')
underline($.label, 'wordInLabelToUnderline', Ti.UI.ATTRIBUTE_UNDERLINE_STYLE_THICK) // 3rd parameter optional
underlineAndColor($.label, 'underlineAndColor', '#F1F1F1')
bold($.label, 'wordInLabelToBold', { fontFamily: 'Helvetica-Bold', fontSize: 20 })