Skip to main content
Version: Next

MaterialTextBox

API Reference: UI.MaterialTextBox

Material text field with consistent behavior on iOS and Android.

Migrating MaterialTextBox from Utility to Native

Since the utility have been deprecated, there are a few steps which needs to be done to migrate the components.

UI Editor Changes

warning

The Material Text Box utility was a MaterialTextBox in a FlexLayout, therefore there might also be design changes depending on your view hierarchy.

  1. Remove the wrapper component, keep in note that if you have customized it's class, you might need to tweak the new one or cover the new materialtextbox under a wrapper too.
  2. Add the new component

Moving the classes and the properties to their new place

We need to edit theme json files manually to avoid repetition and prevent re-adding properties one by one.

Old style file -> /themes/baseTheme/styles/MaterialTextBox.json New style file -> /themes/defaultTheme/styles/defaults/MaterialTextBox.json

Old class name -> .materialTextBox New class name -> .sf-materialTextBox

Go to the old style file and simply copy the properties under .materialTextBox to .sf-materialTextBox class on the new style file. You can currently ignore sub classes for now, but later they will be needed.

.materialTextBox-wrapper will not be used anymore on normal circumstances. You can delete that class.

info

It is recommended to not delete the old style file right away.

Code Changes

Since we now have removed&added materialtextbox components, we are going to have a lot of errors since we have removed the variables.

danger

If you have deleted the old style file, you should search your project with the class name if you have used them on any themeService.getNativeStyle functions. If you don't change them properly, the project will likely to raise errors since it won't be able to find the class.

With that out of the way, let's go over on necessary code changes:

Changes on Initialization

On old usage, we were creating textboxes like mtbText.options = {}. This will not be needed anymore. Simply change it as normal property.

// Old
mtbText.options = {
hint: 'hint',
text: 'text',
isPassword: true
};

// New
mtbText.hint = 'hint'; // This can also be assigned on UI Editor
mtbText.text = 'text'; // This can also be assigned on UI Editor
mtbText.isPasword = true; // This can also be assigned on UI Editor

Changes on property assignments

Since new materialtextbox usage doesn't have a wrapper, you should change their usage:

// Old
mtbText.materialTextBox.text = 'newText';

// New
mtbText.text = 'newText'

On old usage, mtbText.materialTextBox refers to the actual materialTextBox object. On new usage, mtbText itself will be our actual materialTextBox object. Therefore, on old usage e.g. mtbText.onDropDownClick = () => {} will not work anymore. We will cover them next.

Feature Usage Changes

SHOW/HIDE

On the MaterialTextBox utility, there was a showHideEnabled property to dynamically add Show and Hide buttons to the right of the component. Unfortunately, this feature will no longer there. To implement the feature on your own code, you can use rightLayout property.

// let's say mtbPassword is our name for materialtextbox

initRightLayout() {
this.mtbPassword.isPassword = true; //This property can also be assigned from UI Editor
const rightLayout = new FlexLayout({
flexGrow: 1,
alignContent: FlexLayout.AlignContent.FLEX_END
});
const label = new Label({
text: 'Show',
textAlignment: TextAlignment.MIDRIGHT,

});
rightLayout.onTouch = () => {
const isPassword = this.mtbExample.isPassword;
this.mtbPassword.isPassword = !isPassword; //Toggle the variable
label.text = isPassword ? 'Hide' : 'Show';
return false;
};
rightLayout.addChild(label);
mtbLogin.rightLayout = {
view: rightLayout,
width: 60, //Those values might change depending on your right layout
height: 20 //Those values might change depending on your right layout
};
}

Clear All

Same as SHOW/HIDE, this feature is also removed. To implement the feature on your own code, you can use rightLayout property.

// let's say mtbLogin is our name for materialtextbox

initRightLayout() {
const rightLayout = new FlexLayout({
flexGrow: 1,
alignContent: FlexLayout.AlignContent.FLEX_END
});
const label = new Label({
text: 'Clear All',
textAlignment: TextAlignment.MIDRIGHT,
});
rightLayout.onTouch = () => {
this.mtbExample.text = '';
return false;
};
rightLayout.addChild(label);
mtbLogin.rightLayout = {
view: rightLayout,
width: 60, //Those values might change depending on your right layout
height: 20 //Those values might change depending on your right layout
};
}

Dropdown click is useful when you want to have a textbox experience but don't want users to write anything on it.

This feature is also removed in favor of the new component.

warning

We do not recommend using this method for your dropdown actions. We recommend using inputview or designing your own mock materialtextbox component as library component and using that as dropdown instead.

///old code
mtbText.onDropDownClick = () => {
alert("dropwdown clicked");
};

// new code
const rightLayout = new FlexLayout({
flexGrow: 1,
alignContent: FlexLayout.AlignContent.FLEX_END,
});
const mtbText = this.mtbText;
this.mtbExample.onTouch = () => {
// Android will trigger here. This will not trigger itself on iOS.
alert("dropdown pressed"); //Your code here
mtbText.text = "after dropdown"; //Please note that you might get scope errors and this.mtbText might not work. Therefore, please assign it to another variable instead, or you can bind the function to this.
return true; //Important for touch to be consumed
};
this.mtbExample.onEditBegins = () => {
// Here will not be triggered on Android. onTouch will be disabled on iOS due to input taking focus, therefore we call onTouch ourselves here.
this.mtbExample.onTouch();
return false; //This is important
};
const imageview = new ImageView({
flexGrow: 1,
tintColor: Color.BLACK,
alignSelf: FlexLayout.AlignSelf.FLEX_END,
image: Image.createFromFile("images://arrowbottom.png"), // also make sure this name exists or create a new one for your dropdown arrow
});
rightLayout.addChild(imageview);

InputView (iOS)

On iOS, you can override default keyboard and place your picker(e.g. datepicker or custom picker) or other values there instead.

Example code together with arrowbottom.

view = new FlexLayout({
flexGrow: 1,
alignContent: FlexLayout.AlignContent.FLEX_END,
});
const inputView = new FlexLayout({
flexGrow: 1,
});
const inputViewPicker = new Picker({
items: ["test", "test2", "test3"],
onSelected: (index) => {
mtbExample.text = inputViewPicker.items[index];
},
});
inputView.addChild(inputViewPicker);
picker.textColor = Color.BLACK;
picker.dialogBackgroundColor = Color.WHITE;
mtbExample.onTouch = () => {
picker.show(); // For Android
return true;
};
mtbExample.ios.inputView = {
height: 200,
view: inputView,
};
const imageview = new ImageView({
flexGrow: 1,
tintColor: Color.BLACK,
alignSelf: FlexLayout.AlignSelf.FLEX_END,
});
imageview.image = Image.createFromFile("images://arrowbottom.png");
view.addChild(imageview);

Features

  • Material design guidelines compliance
  • Consistent look and feel on iOS and Android
  • Animated state transitions (normal & error)
  • Customizable font size and colors

Example

There is an example down below showing a login scenario.

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics
import PageSampleDesign from "generated/pages/pageSample";
import { Route, Router } from "@smartface/router";
import { styleableComponentMixin, styleableContainerComponentMixin } from "@smartface/styling-context";
import Color from "@smartface/native/ui/color";
import Application from "@smartface/native/application";
import FlexLayout from "@smartface/native/ui/flexlayout";
import ImageView from "@smartface/native/ui/imageview";
import Button from "@smartface/native/ui/button";
import MaterialTextBox from "@smartface/native/ui/materialtextbox";
import System from "@smartface/native/device/system";
import KeyboardType from "@smartface/native/ui/keyboardtype";

class StyleableButton extends styleableComponentMixin(Button) {}
class StyleableMaterialTextBox extends styleableComponentMixin(MaterialTextBox) {}
class StyleableImageView extends styleableComponentMixin(ImageView) {}
class StyleableFlexLayout extends styleableContainerComponentMixin(FlexLayout) {}

//You should create new Page from UI-Editor and extend with it.
export default class Sample extends PageSampleDesign {
flWrapper: StyleableFlexLayout;
imgShow: StyleableImageView;
mtbPassword: StyleableMaterialTextBox;
mtbUsername: StyleableMaterialTextBox;
btnLogin: StyleableButton;
NORMAL_FONT: any = {
font: {
size: 16,
bold: false,
italic: false,
family: "SFProText",
style: "Semibold",
},
};
TB_HEIGHT_ANDROID: number = 85;
isIOS = System.OS === System.OSType.IOS;

constructor(private router?: Router, private route?: Route) {
super({});
}

// The page design has been made from the code for better
// showcase purposes. As a best practice, remove this and
// use WYSIWYG editor to style your pages.
centerizeTheChildrenLayout() {
this.dispatch({
type: "updateUserStyle",
userStyle: {
flexProps: {
flexDirection: "ROW",
justifyContent: "CENTER",
alignItems: "CENTER",
},
},
});
}

onShow() {
super.onShow();
Application.statusBar.visible = false;
this.headerBar.visible = false;
}

onLoad() {
super.onLoad();
this.centerizeTheChildrenLayout();

const { TB_HEIGHT_ANDROID, isIOS, NORMAL_FONT } = this;

this.flWrapper = new StyleableFlexLayout();
this.imgShow = new StyleableImageView({
height: 20,
image: "images://smartface.png",
imageFillType: ImageView.FillType.ASPECTFIT,
});

this.mtbUsername = new StyleableMaterialTextBox({
hint: "Username",
onActionButtonPress: (e) => this.mtbPassword.requestFocus(),
});

this.mtbUsername.onTextChanged = (e) => {
// Reset error message
this.mtbUsername.errorMessage = "";
};

this.mtbPassword = new StyleableMaterialTextBox({
hint: "Password",
onActionButtonPress: (e) => this.mtbPassword.removeFocus(),
});
this.mtbPassword.isPassword = true;
this.mtbPassword.onTextChanged = (e) => {
// Reset error message
this.mtbPassword.errorMessage = "";
};
this.mtbPassword.android.rippleEnabled = true;
this.mtbPassword.android.rippleColor = Color.RED;
this.mtbPassword.rightLayout = { view: this.imgShow, width: 30 };

this.btnLogin = new StyleableButton({
text: "Login",
onPress: (): void => {
// If username or password doesn't exist, show error message
let usernameExists = !!this.mtbUsername.text;
let passwordExists = !!this.mtbPassword.text;
!usernameExists && (this.mtbUsername.errorMessage = "Invalid username");
!passwordExists && (this.mtbPassword.errorMessage = "Invalid password");
},
});

this.mtbUsername.ios.clearButtonEnabled = true;
this.mtbUsername.keyboardType = KeyboardType.android.TEXTSHORTMESSAGE;
this.mtbPassword.ios.clearButtonEnabled = true;

this.addChild(this.flWrapper, "flWrapper", ".sf-flexLayout", {
flexProps: {
alignItems: "CENTER",
},
height: 300,
});

let materialtextboxOptions = Object.assign(
{
width: 200,
font: NORMAL_FONT,
labelsFont: NORMAL_FONT,
borderWidth: 0,
},
isIOS ? {} : { height: TB_HEIGHT_ANDROID }
);

this.flWrapper.addChild(this.mtbUsername, "mtbUsername", ".sf-textBox", materialtextboxOptions);

this.flWrapper.addChild(this.mtbPassword, "mtbPassword", ".sf-textBox", materialtextboxOptions);

this.flWrapper.addChild(this.btnLogin, "btnLogin", ".sf-button", {
top: 20,
height: 60,
width: 200,
backgroundColor: "#00A1F1",
});
}
}
Height & Width difference
  • If height isn't specified in iOS, it is considered as the minimum height required. Android always requires height.
  • If width isn't specified, looks tight than required in Android and iOS matches it parent width.
  • Recall that you can define OS specific styles using rules with UI Editor.

Adjusting Text Size

There are three labels of the size that can be modified.

Unselected Hint Text

mtbUsername.labelsFont = Font.create(Font.DEFAULT, 22, Font.NORMAL);
//Font size >> 22dpi

The font size used in the Material Textboxes can be set to a specific value through the style.xml file. These changes can be observed in the published app, not on emulator.

<resources>
<style name="SFMaterialTextBoxHintAppearance" parent="TextAppearance.Design.Hint" >
<item name="android:textSize">40dp</item>
</style>
<style name="SFMaterialTextBoxErrorTextAppearance" parent="TextAppearance.Design.Error" >
<item name="android:textSize">10dp</item>
</style>
</resources>

Selected Hint Text Size

  • Modify style.xml file below SFMaterialTextBoxHintAppearance.

Error Text Size

  • Modify style.xml file below SFMaterialTextBoxErrorTextAppearance.

Colors

There are total of 4 main colors of MaterialTextBox

  • Color of text shown in default
  • Color of line under the text where user is able to edit
  • Color of hint which appears at the top
  • Color of the cursor (not changeable for both platforms)

Also 3 different states of MaterialTextBox

  • Default state, when user didn't interact with MaterialTextBox
  • Selected state, when is focused on MaterialTextBox
  • Error state, when errorMessage is shown

Changing Colors

Currently some colors are not changeable on both platforms. Here is what you may change:

Tips & Tricks

  • The Android only property, enableErrorMessage is not mandatory to use, but recommended. Not assigning it may cause unexpected results. Enabling error and counter in initialization time that will draw space for those views. By default disabling error messages causes a little bit bounce, in order to handle must be set enable out of the gate then assign.
  • It is not recommended to use flexGrow on both Android and iOS.
  • To change the keyboard appearance when it is touched on MaterialTextBox, refer here.
Known Issue

Currently there is no way to change font size on Android while using labelsFont property. Any given font size parameter will be ignored.