myalcinkuru / sf-extension-utils

Smartface Native Framework extension that has useful utility classes to use in your applications

Utility Extension from Smartface

An extension that has following utility classes for Smartface Native Framework.

• RAU (easy use for Remote App Update)
• Fingerprint & Touch ID (easy & best practice use for Fingerprint)
• Alert (fixes global alert)
• SpeechToText (setups timers for speech recognition)
• Permission (gets permissions with ease using a simple callback)
• Location (gets location with callback, no need to worry for the permission code)
• Timers (fixes thread issue of setTimeout & setInterval)
• Orientation (solves problems of managing different behaviour of Oritentation of iOS & Android)
• ServiceCall (service call library for common JSON requests)
• ButtonActivity (setting an activity indicator with correct elevation on top of a button)
• WebViewBridge (bi directional communication)
• Touch (addPress event to any target object)
• Color (converts Smartface color to TinyColor for color manipulations)
• TextBox (max text length)

Installation

Utility extension can be installed via npm easily from our public npm repository. The installation is pretty easy via Smartface Cloud IDE. Run the following code in terminal

(cd ~/workspace/scripts && npm i -S sf-extension-utils)

How to use

Just require("sf-extension-utils") and .<name> of the module to use. For timers and alert there is no accessor, there making global modifications.

• require("sf-extension-utils").rau
• require("sf-extension-utils").permission
• require("sf-extension-utils").fingerprint
• require("sf-extension-utils").speechToText
• require("sf-extension-utils").location

API

For each module api documentation is in separate file

• alert
• timers
• permission
• speechToText
• rau
• location
• fingerprint
• orientation
• ServiceCall
• ButtonActivity
• WebViewBridge
• Touch
• Color
• TextBox

Need Help?

Please submit an issue on GitHub and provide information about your problem.

Support & Documentation & Useful Links

• Guides
• API Docs
• Smartface Cloud Dashboard

Code of Conduct

We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file. Within the scope of this license, all modifications to the source code, regardless of the fact that it is used commercially or not, shall be committed as a contribution back to this repository.