TextBox
A text input field with rich editing capabilities.
Properties
| Property | Type | Default |
|---|---|---|
Name | string | "TextBox" |
AutoButtonColor | boolean | true |
ChangeCursorOnHover | boolean | true |
Visible | boolean | true |
Focused | boolean | false |
Text | string | "" |
PlaceholderText | string | "Type here..." |
FontSize | number | 18 |
TextColor3 | Color3 | Color3.new(1, 1, 1) |
BackgroundColor3 | Color3 | Color3.new(0.15, 0.15, 0.15) |
PlaceholderColor3 | Color3 | Color3.new(0.5, 0.5, 0.5) |
FocusColor3 | Color3 | Color3.new(0.02, 0.5, 1) |
TextXAlignment | EnumItem | Enum.TextXAlignment.Left |
Font | EnumItem | Enum.Font.DefaultEngineFont |
TextYAlignment | EnumItem | Enum.TextYAlignment.Center |
MultiLine | boolean | false |
ReadOnly | boolean | false |
MaxLength | any | nil |
Mask | any | nil |
AllowedChars | any | nil |
TrimWhitespace | boolean | false |
TabSize | number | 4 |
AutoPairs | boolean | true |
AutoIndent | boolean | false |
WordWrap | boolean | false |
Validator | any | nil |
Numeric | boolean | false |
NumericMin | any | nil |
NumericMax | any | nil |
NumericStep | number | 1 |
NumericPrecision | any | nil |
ShowStepButtons | boolean | false |
StepButtonWidth | number | 20 |
Slider | boolean | false |
SliderMin | number | 0 |
SliderMax | number | 100 |
SliderStep | number | 1 |
SliderWidth | number | 100 |
SliderPosition | string | "right" |
SliderGap | number | 10 |
Scrollable | boolean | false |
EnableScrollbar | boolean | true |
ScrollbarWidth | number | 10 |
ShowLineNumbers | boolean | false |
ShowLineCount | boolean | false |
ShowCharCount | boolean | false |
CornerRadius | number | 0 |
CornerSegments | number | 8 |
BorderWidth | number | 1 |
FocusBorderWidth | number | 1 |
DropShadow | boolean | false |
ShadowOffset | number | 2 |
LineHighlight | boolean | true |
MatchBrackets | boolean | false |
EnableAnimatedFocus | boolean | true |
EnableMinimap | boolean | false |
EnableHyperlinks | boolean | false |
EnableDragDrop | boolean | true |
EnableColumnSelection | boolean | true |
Label | any | nil |
LabelPosition | string | "left" |
LabelWidth | number | 60 |
LabelGap | number | 10 |
Prefix | any | nil |
Suffix | any | nil |
PrefixGap | number | 5 |
SuffixGap | number | 5 |
SelectAllOnFocus | boolean | false |
SubmitOnCtrlEnter | boolean | false |
BlurOnSubmit | boolean | true |
ClearOnEscape | boolean | false |
EscapeBlurs | boolean | false |
DoubleClickSelect | boolean | true |
TripleClickSelect | boolean | true |
ContextMenu | boolean | true |
OnChange | any | nil |
OnSubmit | any | nil |
OnFocus | any | nil |
OnBlur | any | nil |
OnValidationError | any | nil |
OnSearch | any | nil |
MaxHistory | number | 100 |
KeyRepeatInitialDelay | number | 0.5 |
KeyRepeatMinInterval | number | 0.02 |
KeyRepeatAcceleration | number | 0.85 |
Functions
`resolveFont`
`onChange`
`onSubmit`
`onFocus`
`onBlur`
`onValidationError`
`onSearch`
`instance._aereonInput.onChange`
`instance._aereonInput.onSubmit`
`instance._aereonInput.onFocus`
`instance._aereonInput.onBlur`
`instance._aereonInput.onValidationError`
`instance._aereonInput.onSearch`
resolveFont
Arguments
fontEnumReturns
This function returns nothing.
onChange
Arguments
textReturns
This function returns nothing.
onSubmit
Arguments
textReturns
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
errReturns
This function returns nothing.
onSearch
Arguments
query, countReturns
This function returns nothing.
instance._aereonInput.onChange
Arguments
textReturns
This function returns nothing.
instance._aereonInput.onSubmit
Arguments
textReturns
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
errReturns
This function returns nothing.
instance._aereonInput.onSearch
Arguments
query, countReturns
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)