neft
Version:
Universal Platform
94 lines (75 loc) • 9.71 kB
Markdown
> [Wiki](Home) ▸ [[API Reference|API-Reference]] ▸ [[Renderer|Renderer-API]] ▸ [[Item|Renderer-Item-API]] ▸ **TextInput**
# TextInput
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee)
## Table of contents
* [TextInput](#textinput)
* [**Class** TextInput](#class-textinput)
* [New](#new)
* [*Boolean* TextInput.keysFocusOnPointerPress = true](#boolean-textinputkeysfocusonpointerpress--true)
* [width](#width)
* [height](#height)
* [text](#text)
* [onTextChange](#ontextchange)
* [color](#color)
* [onColorChange](#oncolorchange)
* [lineHeight](#lineheight)
* [onLineHeightChange](#onlineheightchange)
* [multiLine](#multiline)
* [onMultiLineChange](#onmultilinechange)
* [echoMode](#echomode)
* [onEchoModeChange](#onechomodechange)
* [alignment](#alignment)
* [onAlignmentChange](#onalignmentchange)
* [font](#font)
* [onFontChange](#onfontchange)
* [Glossary](#glossary)
#**Class** TextInput
<dl><dt>Syntax</dt><dd><code>**Class** TextInput : *Item*</code></dd><dt>Extends</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Item-API#class-item">Item</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#class-textinput--item)
##New
<dl><dt>Syntax</dt><dd><code>*TextInput* TextInput.New([*Component* component, *Object* options])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>component — <i>Component</i> — <i>optional</i></li><li>options — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a> — <i>optional</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#textinput-textinputnewcomponent-component-object-options)
## *Boolean* TextInput.keysFocusOnPointerPress = true
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee)
##width
<dl><dt>Syntax</dt><dd><code>*Float* TextInput::width = `100`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>100</code></dd></dl>
##height
<dl><dt>Syntax</dt><dd><code>*Float* TextInput::height = `50`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>50</code></dd></dl>
##text
<dl><dt>Syntax</dt><dd><code>*String* TextInput::text</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><i>String</i></dd></dl>
##onTextChange
<dl><dt>Syntax</dt><dd><code>*Signal* TextInput::onTextChange(*String* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <i>String</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#signal-textinputontextchangestring-oldvalue)
##color
<dl><dt>Syntax</dt><dd><code>*String* TextInput::color = `'black'`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><i>String</i></dd><dt>Default</dt><dd><code>'black'</code></dd></dl>
##onColorChange
<dl><dt>Syntax</dt><dd><code>*Signal* TextInput::onColorChange(*String* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <i>String</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#signal-textinputoncolorchangestring-oldvalue)
##lineHeight
<dl><dt>Syntax</dt><dd><code>Hidden *Float* TextInput::lineHeight = `1`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Default</dt><dd><code>1</code></dd><dt>Not Implemented</dt></dl>
##onLineHeightChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* TextInput::onLineHeightChange(*Float* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#hidden-signal-textinputonlineheightchangefloat-oldvalue)
##multiLine
<dl><dt>Syntax</dt><dd><code>*Boolean* TextInput::multiLine = `false`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd></dl>
##onMultiLineChange
<dl><dt>Syntax</dt><dd><code>*Signal* TextInput::onMultiLineChange(*Boolean* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <i>Boolean</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#signal-textinputonmultilinechangeboolean-oldvalue)
##echoMode
<dl><dt>Syntax</dt><dd><code>*String* TextInput::echoMode = `'normal'`</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><i>String</i></dd><dt>Default</dt><dd><code>'normal'</code></dd></dl>
Accepts 'normal' and 'password'.
##onEchoModeChange
<dl><dt>Syntax</dt><dd><code>*Signal* TextInput::onEchoModeChange(*String* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>oldValue — <i>String</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#signal-textinputonechomodechangestring-oldvalue)
##alignment
<dl><dt>Syntax</dt><dd><code>Hidden *Item.Alignment* TextInput::alignment</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Item.Alignment-API#class-alignment">Item.Alignment</a></dd><dt>Not Implemented</dt></dl>
##onAlignmentChange
<dl><dt>Syntax</dt><dd><code>Hidden *Signal* TextInput::onAlignmentChange(*String* property, *Any* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>property — <i>String</i></li><li>oldValue — <i>Any</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd><dt>Not Implemented</dt></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#hidden-signal-textinputonalignmentchangestring-property-any-oldvalue)
##font
<dl><dt>Syntax</dt><dd><code>*Item.Text.Font* TextInput::font</code></dd><dt>Prototype property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Item.Text.Font-API#class-font">Item.Text.Font</a></dd></dl>
##onFontChange
<dl><dt>Syntax</dt><dd><code>*Signal* TextInput::onFontChange(*String* property, *Any* oldValue)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-TextInput-API#class-textinput">TextInput</a></dd><dt>Parameters</dt><dd><ul><li>property — <i>String</i></li><li>oldValue — <i>Any</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/65f8de73ffc0dbb38be0f58144f629599500b1a9/src/renderer/types/basics/item/types/textInput.litcoffee#signal-textinputonfontchangestring-property-any-oldvalue)
# Glossary
- [TextInput](#class-textinput)