Gets/sets the lineCount of the MaterialTextBox. You can use this property when multiline is true.
= 1]
4.3.0
Gets/sets the multiline of the MaterialTextBox. You should set this property at constructor method.
= false]
4.3.0
/**
3.1.2
This property used to assign a view right of MaterialTextBox. The given view's width & height must be specified.
3.2.1
Optional height?: numberGets/sets the lineColor of the MaterialTextBox. In Android, if error message appears then line color cannot be changed.
= {}]
3.1.2
Gets/sets the errorColor of the MaterialTextBox. In Android, hint text color does not changed as iOS.
3.1.2
Gets/sets the errorMessage of the MaterialTextBox.
3.1.2
Gets/sets the characterRestriction of the MaterialTextBox.
Use android.chacharacterRestriction instead.
3.1.2
Gets/sets the characterRestrictionColor of the MaterialTextBox.
Use android.characterRestrictionColor instead.
3.1.2
Gets/sets the labelsFont of the MaterialTextBox. In Android, sets the font to hint and any other labels (such as error and counter labels) but size of font does not take into account except for hint text size. Before using this property you should enable counter, error and give hint text. For iOS, this property overrides the underlineLabelsFont property for error and characterRestriction font.
3.1.3
Gets/sets font of a Label. In Android, to make hint text size as your given text size assign the font property in constructor.
import Label from '@smartface/native/ui/label';
import Font from '@smartface/native/ui/font';
const myLabel = new Label({
text: "This is my label",
visible: true
});
myLabel.font = Font.create("Arial", 16, Font.BOLD);
0.1
Gets/sets the text of the TextBox.
= ""]
0.1
Optional maxGets/Sets maximum character lenght restrict of TextBox.
5.0.5
Gets/sets automatically capitalization of the TextBox. UI.TextBox#cursorPosition Cursor Position might be necessary to re-set.
= UI.TextBox.AutoCapitalize.NONE]
2.8
Gets/sets the text alignment of the TextBox.
= UI.TextAlignment.MIDLEFT]
0.1
Gets/sets the text color of TextBox.
= UI.Color.BLACK]
0.1
Gets/sets the cursor position of TextBox.
2.0.8
import TextBox from '@smartface/native/ui/textbox';
const textBox = new TextBox();
console.info(textBox.cursorPosition);
Gets/sets the event which will be triggered when the textbox object gains focus. On iOS, you can return boolean variable to open keyboard or not. On Android, return value is ignored true -> works normally false -> doesn't open keyboard but still triggers the event
7.1.1 -> return value will only work on Smartface version 7.1.1 or above.
true
import TextBox from '@smartface/native/ui/textbox';
const textBox = new TextBox();
textBox.on('editBegins, () => {
console.info('onEditBegins');
});
Gets/sets the cursor color of TextBox.
3.2.1
Gets/sets hint text that will be displayed when TextBox is empty.
= ""]
0.1
Gets/sets the color of the hint text.
= UI.Color.LIGHTGRAY]
0.1
Gets/sets the content of the TextBox is password or not. UI.TextBox#cursorPosition Cursor Position might be necessary to re-set.
= false]
0.1
Gets/sets keyboard type for TextBox. UI.TextBox#cursorPosition Cursor Position might be necessary to re-set.
= UI.KeyboardType.DEFAULT]
0.1
Gets/sets action key type for TextBox.
= UI.ActionKeyType.DEFAULT]
0.1
Optional enabledGets/sets if the textbox should be touchable and enabled. When set to false, textBox may dim itself depending on the OS.
Gets/sets the transitionId to be used for transitionViews. See transitionViews for more information
0.1
Gets/sets whether the view is an accessibility element that an assistive app can access.
UI.View
4.3.2
A content description briefly describes the view. VoiceOver will read this string when a user selects the associated element.
UI.View
4.3.2
Defines the opacity of a view. The value of this property is a float number between 0.0 and 1.0. 0 represents view is completely transparent and 1 represents view is completely opaque.
= 1]
UI.View
0.1
Gets/sets background color of a view. It allows setting background color with UI.Color instance.
= UI.Color.WHITE]
UI.View
0.1
Sets/gets border color of bounded view.
= UI.Color.BLACK]
0.1
Sets/gets border thickness of bounded view. Accepts unsigned numbers, 0 means no border.
= 0]
0.1
Sets/gets corner radius of a view. BorderRadius maximum value must be half of the shortest edge.
= 0]
0.1
Sets/gets top-left corner radius of a view.
= 0]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderTopLeftRadius is available on Android.
Sets/gets top-right corner radius of a view.
= 0]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderTopRightRadius is available on Android.
Sets/gets top-start corner radius of a view.
= -1]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderTopStartRadius is available on Android.
Sets/gets top-end corner radius of a view.
= -1]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderTopEndRadius is available on Android.
Sets/gets bottom-left corner radius of a view.
= 0]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderBottomLeftRadius is available on Android.
Sets/gets bottom-right corner radius of a view.
= 0]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderBottomRightRadius is available on Android.
Sets/gets bottom-start corner radius of a view.
= -1]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderBottomStartRadius is available on Android.
Sets/gets bottom-end corner radius of a view.
= -1]
5.0.3
since 5.1.1 Use the borderRadiusEdges property instead. Also android.borderBottomEndRadius is available on Android.
Gets/sets id of a view. It should be unique number for each object inside page. Id will be generated unique by default.
UI.View
0.1
Gets/sets test id for view. resource-id for android; accessibilityIdentifier for iOS.
UI.View
4.3.2
Gets/sets visibility of view. It is set to true as default.
= true]
UI.View
0.1
Gets/sets the degrees that the view is rotated around the pivot point.
= 0]
UI.View
1.1.10
Gets/sets the degrees that the view is rotated around the horizontal axis through the pivot point. RotationX works different for iOS and Android. Android gives perpective to the view but iOS doesn't. This will cause difference on user interface.
= 0]
UI.View
1.1.10
Gets/sets the degrees that the view is rotated around the vertical axis through the pivot point. RotationY works different for iOS and Android. Android gives perpective to the view but iOS doesn't. This will cause difference on user interface.
= 0]
UI.View
1.1.10
Enables/disables touches to view. When set to false events related to touches won't fire. It is set to true as default.
= true]
UI.View
0.1
Gets/sets left position of a view relative to its parent.
= 0]
0.1
Gets/sets top position of a view relative to its parent.
= 0]
0.1
Gets/sets right position of a view relative to its parent. This property works only if view's positionType is UI.FlexLayout.PositionType.ABSOLUTE.
= 0]
0.1
Gets/sets bottom position of a view relative to its parent. This property works only if view's positionType is UI.FlexLayout.PositionType.ABSOLUTE.
= 0]
0.1
Gets/sets height of a view.
= 0]
0.1
Gets/sets width of a view.
= 0]
0.1
Gets/sets minimum width of a view.
= 0]
0.1
Gets/sets minimum height of a view.
= 0]
0.1
Gets/sets maximum width of a view.
= 0]
0.1
Gets/sets maximum height of a view.
= 0]
0.1
Gets/Sets the padding space on the top side of a view.
= 0]
0.1
Gets/Sets the padding space on the bottom side of a view.
= 0]
0.1
Gets/Sets the padding space on the left side of a view.
= 0]
0.1
Gets/Sets the padding space on the right side of a view.
= 0]
0.1
Gets/Sets the padding space on the all sides of a view.
= 0]
0.1
Gets/Sets the margin space on the top side of a view.
= 0]
0.1
Gets/Sets the margin space on the bottom side of a view.
= 0]
0.1
Gets/Sets the margin space on the left side of a view.
= 0]
0.1
Gets/Sets the margin space required on the right side of a view.
= 0]
0.1
Gets/Sets the margin space required on the all sides of a view.
= 0]
0.1
This property specifies the type of positioning method used for a view. To position a view relative to its parent with top,left,right and bottom properties you must set the position type to absolute.
= UI.FlexLayout.PositionType.RELATIVE]
0.1
This property specifies how much a view will grow relative to the other views inside the same UI.FlexLayout FlexLayout.
= 0]
0.1
AspectRatio keeps the ratio between the width and the height of a view. AspectRatio has higher priority than UI.View#flexGrow flexGrow.
0.1
This property specifies how much a view will shrink relative to the other views inside the same UI.FlexLayout FlexLayout.
= 1]
0.1
This property specifies the initial length of a view in a UI.FlexLayout FlexLayout.
= -1]
0.1
This property sets the amount that the view is scaled in X & Y around the pivot point, as a proportion of the view's unscaled width. A value of 1 means that no scaling is applied. Actually UI.flipVertically flipVertically & UI.flipHorizontally flipHorizontally functions are assignes -1 to X & Y to mirror the view. So while using scale, need to consider these functions.
4.0.1
This property specifies how a child view aligns in the cross-axis. It overrides the UI.FlexLayout.AlignItems FlexLayout.AlignItems property of the parent.
= UI.FlexLayout.AlignSelf.AUTO]
0.1
A Boolean indicating whether sublayers are clipped to the layer’s bounds. Android sublayers still overlaps the border's width and as known issue,if UI.View#maskedBorders maskedBorders is used then sublayer won't be clipped.
= true]
4.1.4
A Boolean indicating whether sublayers are clipped to the layer’s bounds. Android sublayers still overlaps the border's width and as known issue,if UI.View#borderRadiusEdges borderRadiusEdges is used then sublayer won't be clipped.
= {topLeft: true, topRight: true, bottomLeft: true, bottomRight: true}]
5.1.1
Specified enums indicates that which corner of View will have radius.
= [View.Border.TOP_LEFT, View.Border.TOP_RIGHT, View.Border.BOTTOM_RIGHT, View.Border.BOTTOM_LEFT]]
4.1.4
since 5.0.3 Use the borderRadiusEdges properties instead.
The color of the shadow. UI.View.ios#masksToBounds property must be false for shadow on iOS. On Android, this property only works on Android 9 and above.
= UI.Color.BLACK]
5.0.3
Readonly uniqueThis method is deprecated in favor of EventEmitter. You could get more details for the deprecated events from here https://docs.smartface.io/smartface-native-framework/tips-and-tricks/handling-events
import View from '@smartface/native/ui/view';
import FlexLayout from '@smartface/native/ui/flexlayout';
import Button from '@smartface/native/ui/button';
this.view1.on(View.Events.TouchMoved, (point) => {
console.info('view onTouchMoved', point);
});
this.flexLayout1.on(FlexLayout.Events.TouchMoved, (point) => {
console.info('flexLayout onTouchMoved', point);
});
this.button1.on(Button.Events.TouchMoved, (point) => {
console.info('button onTouchMoved', point);
});
Optional point: Point2DCreates an event emitter instance to listen for the actions
Call the function to remove the event
Gets as any arguments as it needs
Optional e: { actionKeyType: ActionKeyType }Optional e: { insertedText: string; location: number }Rest ...args: any[]Removes the specified event and invokes the callback after it is removed
Optional e: { actionKeyType: ActionKeyType }Optional e: { insertedText: string; location: number }Rest ...args: any[]Triggers the event manually.
Optional e: { actionKeyType: ActionKeyType }Arguments that needs to be passed down
Optional e: { insertedText: string; location: number }Rest ...args: any[]Creates an event emitter instance to listen for the actions
Call the function to remove the event
Gets as any arguments as it needs
Optional e: { actionKeyType: ActionKeyType }Optional e: { insertedText: string; location: number }Rest ...args: any[]Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
Optional e: { actionKeyType: ActionKeyType }Optional e: { insertedText: string; location: number }Rest ...args: any[]Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.
Optional e: { actionKeyType: ActionKeyType }Optional e: { insertedText: string; location: number }Rest ...args: any[]Call this when something has changed which has invalidated the layout of this view. This will schedule a layout pass of the view tree. It is useful to call this method when you want to change layout parameters on runtime. If this view layout invalidated, call applyLayout from the Page.layout in the iOS and from the view itself in the Android.
applyLayout
This method returns an object that defines view location on screen. Do not use this method for invisible views in UI.ListView ListView and UI.GridView GridView.
getScreenLocation
location
location.x
location.y
3.2.0
Gets the parent view of a view.
import FlexLayout from '@smartface/native/ui/flexlayout';
import Label from '@smartface/native/ui/label';
var myFlexLayout = new FlexLayout();
myFlexLayout.id = 5432;
var myLabel = new Label({
text: "Smartface Label"
});
myFlexLayout.addChild(myLabel);
var parentId = myLabel.getParent().id; //is equal to 5432.
Parent view of a view, null if not exists.
getParent
0.1
This event is called when user inserts or removes a character from TextBox.
0.1
import TextBox from '@smartface/native/ui/textbox';
const textBox = new TextBox();
textBox.on(TextBox.Events.TextChanged, (params) => {
console.info('onTextChanged', params);
});
Optional e: { insertedText: string; location: number }Event arguments.
The text that inserted into TextBox.
Index of inserted text. onTextChanged
The text box calls this method in response to the user pressing the built-in clear button. Return value is YES if the text box contents should be cleared; otherwise, NO. If you do not implement this method, the text box clears the text as if the method had returned YES.
onClearButtonPress
4.0.2
import TextBox from '@smartface/native/ui/textbox';
const textBox = new TextBox();
textBox.on(TextBox.Events.ClearButtonPress, () => {
console.info('onClearButtonPress');
});
This event is called when user finishes editing by clicking return key or clicking outside of the TextBox. On iOS, you can return boolean variable to close keyboard or not. On Android, return value is ignored true -> works normally false -> doesn't close the keyboard but still triggers the event
true
onEditEnds
7.1.1 -> return value will only work on Smartface version 7.1.1 or above.
import TextBox from '@smartface/native/ui/textbox';
const textBox = new TextBox();
textBox.on(TextBox.Events.EditEnds, () => {
console.info('onEditEnds');
});
This event is called when user clicks action key on the keyboard.
0.1
import TextBox from '@smartface/native/ui/textbox';
const textBox = new TextBox();
textBox.on(TextBox.Events.ActionButtonPress, (params) => {
console.info('onActionButtonPress', params);
});
Optional e: { actionKeyType: ActionKeyType }Event arguments.
Pressed action key type. onActionButtonPress
This event is called when a touch screen motion event starts.
onTouch
This method is deprecated in favor of EventEmitter. You could get more details for the deprecated events from here https://docs.smartface.io/smartface-native-framework/tips-and-tricks/handling-events
True if the listener has consumed the event, false otherwise.
UI.View
0.1
import View from '@smartface/native/ui/view';
import FlexLayout from '@smartface/native/ui/flexlayout';
import Button from '@smartface/native/ui/button';
this.view1.on(View.Events.Touch, (point) => {
console.info('view onTouch', point);
});
this.flexLayout1.on(FlexLayout.Events.Touch, (point) => {
console.info('flexLayout onTouch', point);
});
this.button1.on(Button.Events.Touch, (point) => {
console.info('button onTouch', point);
});
Optional e: Point2DThis event is called when a touch screen motion event ends. If touch position inside this view, isInside parameter will be true.
onTouchEnded
This method is deprecated in favor of EventEmitter. You could get more details for the deprecated events from here https://docs.smartface.io/smartface-native-framework/tips-and-tricks/handling-events
True if the listener has consumed the event, false otherwise.
UI.View
0.1
import View from '@smartface/native/ui/view';
import FlexLayout from '@smartface/native/ui/flexlayout';
import Button from '@smartface/native/ui/button';
this.view1.on(View.Events.TouchEnded, (isInside, point) => {
console.info('view onTouchEnded', isInside, point);
});
this.flexLayout1.on(FlexLayout.Events.TouchEnded, (isInside, point) => {
console.info('flexLayout onTouchEnded', isInside, point);
});
this.button1.on(Button.Events.TouchEnded, (isInside, point) => {
console.info('button onTouchEnded', isInside, point);
});
This argument is deprecated. Use motionEvent's property.
This event is called when a parent view takes control of the touch events, like a ListView or ScrollView does when scrolling.
onTouchCancelled
This method is deprecated in favor of EventEmitter. You could get more details for the deprecated events from here https://docs.smartface.io/smartface-native-framework/tips-and-tricks/handling-events
True if the listener has consumed the event, false otherwise.
UI.View
2.0.10
import View from '@smartface/native/ui/view';
import FlexLayout from '@smartface/native/ui/flexlayout';
import Button from '@smartface/native/ui/button';
this.view1.on(View.Events.TouchCancelled, (point) => {
console.info('view onTouchCancelled', point);
});
this.flexLayout1.on(FlexLayout.Events.TouchCancelled, (point) => {
console.info('flexLayout onTouchCancelled', point);
});
this.button1.on(Button.Events.TouchCancelled, (point) => {
console.info('button onTouchCancelled', point);
});
Generated using TypeDoc
Since
3.1.2
Example