Kinemium Docs

TextBox

A text input field with rich editing capabilities.

Properties

PropertyTypeDefault
Namestring"TextBox"
AutoButtonColorbooleantrue
ChangeCursorOnHoverbooleantrue
Visiblebooleantrue
Focusedbooleanfalse
Textstring""
PlaceholderTextstring"Type here..."
FontSizenumber18
TextColor3Color3Color3.new(1, 1, 1)
BackgroundColor3Color3Color3.new(0.15, 0.15, 0.15)
PlaceholderColor3Color3Color3.new(0.5, 0.5, 0.5)
FocusColor3Color3Color3.new(0.02, 0.5, 1)
TextXAlignmentEnumItemEnum.TextXAlignment.Left
FontEnumItemEnum.Font.DefaultEngineFont
TextYAlignmentEnumItemEnum.TextYAlignment.Center
MultiLinebooleanfalse
ReadOnlybooleanfalse
MaxLengthanynil
Maskanynil
AllowedCharsanynil
TrimWhitespacebooleanfalse
TabSizenumber4
AutoPairsbooleantrue
AutoIndentbooleanfalse
WordWrapbooleanfalse
Validatoranynil
Numericbooleanfalse
NumericMinanynil
NumericMaxanynil
NumericStepnumber1
NumericPrecisionanynil
ShowStepButtonsbooleanfalse
StepButtonWidthnumber20
Sliderbooleanfalse
SliderMinnumber0
SliderMaxnumber100
SliderStepnumber1
SliderWidthnumber100
SliderPositionstring"right"
SliderGapnumber10
Scrollablebooleanfalse
EnableScrollbarbooleantrue
ScrollbarWidthnumber10
ShowLineNumbersbooleanfalse
ShowLineCountbooleanfalse
ShowCharCountbooleanfalse
CornerRadiusnumber0
CornerSegmentsnumber8
BorderWidthnumber1
FocusBorderWidthnumber1
DropShadowbooleanfalse
ShadowOffsetnumber2
LineHighlightbooleantrue
MatchBracketsbooleanfalse
EnableAnimatedFocusbooleantrue
EnableMinimapbooleanfalse
EnableHyperlinksbooleanfalse
EnableDragDropbooleantrue
EnableColumnSelectionbooleantrue
Labelanynil
LabelPositionstring"left"
LabelWidthnumber60
LabelGapnumber10
Prefixanynil
Suffixanynil
PrefixGapnumber5
SuffixGapnumber5
SelectAllOnFocusbooleanfalse
SubmitOnCtrlEnterbooleanfalse
BlurOnSubmitbooleantrue
ClearOnEscapebooleanfalse
EscapeBlursbooleanfalse
DoubleClickSelectbooleantrue
TripleClickSelectbooleantrue
ContextMenubooleantrue
OnChangeanynil
OnSubmitanynil
OnFocusanynil
OnBluranynil
OnValidationErroranynil
OnSearchanynil
MaxHistorynumber100
KeyRepeatInitialDelaynumber0.5
KeyRepeatMinIntervalnumber0.02
KeyRepeatAccelerationnumber0.85

Functions


resolveFont

Arguments

fontEnum

Returns

This function returns nothing.

onChange

Arguments

text

Returns

This function returns nothing.

onSubmit

Arguments

text

Returns

This function returns nothing.

onFocus

Arguments

This function takes no arguments.

Returns

This function returns nothing.

onBlur

Arguments

This function takes no arguments.

Returns

This function returns nothing.

onValidationError

Arguments

err

Returns

This function returns nothing.

onSearch

Arguments

query, count

Returns

This function returns nothing.

instance._aereonInput.onChange

Arguments

text

Returns

This function returns nothing.

instance._aereonInput.onSubmit

Arguments

text

Returns

This function returns nothing.

instance._aereonInput.onFocus

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance._aereonInput.onBlur

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance._aereonInput.onValidationError

Arguments

err

Returns

This function returns nothing.

instance._aereonInput.onSearch

Arguments

query, count

Returns

This function returns nothing.

API

instance:resolveFont(fontEnum)
instance:onChange(text)
instance:onSubmit(text)
instance:onFocus()
instance:onBlur()
instance:onValidationError(err)
instance:onSearch(query, count)
instance:_aereonInput.onChange(text)
instance:_aereonInput.onSubmit(text)
instance:_aereonInput.onFocus()
instance:_aereonInput.onBlur()
instance:_aereonInput.onValidationError(err)
instance:_aereonInput.onSearch(query, count)

On this page