smartface / sf-component-keyboardlayout

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Smartface KeyboardLayout Component

NPM

Installation

Execute the command on the scripts directory

yarn i @smartface/component-keyboardlayout

KeyboardLayout : Class

Provides a component for iOS that goes at the top of a keyboard when focused on a TextBox Number-only keyboard on iOS does not have a ActionKey on it, therefore it is recommended to use this component for ease of usage. This component is not supported on Android.

Author: Furkan Arabacı furkan.arabaci@smartface.io
Copyright: Smartface 2019

KeyboardLayout.init(textBoxes) ⇒ Array.<Object>

Initializes a keyboard layout for each given textbox or material textbox When given one textBox, up and down buttons will be disabled by default.

Kind: static method of KeyboardLayout
Returns: Array.<Object> - - Keyboard layouts as an order of textboxes given initially
Access: public

Param Type Description
textBoxes Array.<Object> | Object Array of or single textBox instance

KeyboardLayout~KeyboardLayout

Kind: inner class of KeyboardLayout

KeyboardLayout~toggleVisibilityofUpImage(disabled)

Sets disability of up image. When given true, it will gray out the layout.

Kind: inner method of KeyboardLayout
Access: public

Param Type Description
disabled boolean Pushes .disabled class to the layout, grays out by default

KeyboardLayout~toggleVisibilityofDownImage(disabled)

Sets disability of down image. When given true, it will gray out the layout.

Kind: inner method of KeyboardLayout
Access: public

Param Type Description
disabled boolean Pushes .disabled class to the layout, grays out by default

KeyboardLayout~toggleVisibilityOfUpImage(visible)

Sets visibility of up image

Kind: inner method of KeyboardLayout
Access: public

Param Type Description
visible boolean Toggles visibility

KeyboardLayout~toggleVisibilityOfDownImage(visible)

Sets visibility of down image

Kind: inner method of KeyboardLayout
Access: public

Param Type Description
visible boolean Toggles visibility

KeyboardLayout~toggleVisibilityOfDoneButton(visible)

Sets visibility of done button

Kind: inner method of KeyboardLayout
Access: public

Param Type Description
visible boolean Toggles visibility

About

License:Other


Languages

Language:TypeScript 94.6%Language:JavaScript 5.4%