Input
Defined in: ui/Input.ts:126
Extends
Container
<this
> &ISignalContainer
&IInteractive
&IFocusable
<this
>
Constructors
new Input()
new Input(
options
,isClone
,clone
):Input
Defined in: ui/Input.ts:153
Parameters
options
Partial
<InputProps
>
isClone
boolean
= false
clone
null
| Input
Returns
Overrides
Focusable(Interactive(WithSignals(Container))).constructor
Properties
__dill_pixel_method_binding_root
__dill_pixel_method_binding_root:
boolean
=true
Defined in: display/Container.ts:61
Inherited from
Focusable(Interactive(WithSignals(Container))).__dill_pixel_method_binding_root
add
add:
object
Defined in: mixins/factory/Factory.ts:6
animatedSprite()
animatedSprite: (
props
?) =>AnimatedSprite
Parameters
props?
Partial
<AnimatedSpriteProps
>
Returns
bitmapText()
bitmapText: (
props
?) =>BitmapText
Parameters
props?
Partial
<TextProps
>
Returns
BitmapText
button()
button: (
props
?) =>Button
Parameters
props?
Partial
<ButtonProps
>
Returns
container()
container: (
props
?) =>Container
Parameters
props?
Partial
<ContainerProps
>
Returns
existing()
existing: <
TEntity
>(entity
,props
?) =>TEntity
Type Parameters
• TEntity
Parameters
entity
TEntity
props?
Partial
<ExistingProps
>
Returns
TEntity
flexContainer()
flexContainer: (
props
?) =>FlexContainer
Parameters
props?
Partial
<FlexContainerProps
>
Returns
graphics()
graphics: (
props
?) =>Graphics
Parameters
props?
Partial
<GraphicsProps
>
Returns
Graphics
htmlText()
htmlText: (
props
?) =>HTMLText
Parameters
props?
Partial
<HTMLTextProps
>
Returns
HTMLText
particleContainer()
particleContainer: (
props
?) =>ParticleContainer
Parameters
props?
Partial
<ParticleContainerProps
>
Returns
spine()
spine: (
props
?) =>Spine
Parameters
props?
Partial
<SpineProps
>
Returns
spineAnimation()
spineAnimation: (
props
?) =>SpineAnimation
Parameters
props?
Partial
<SpineProps
>
Returns
sprite()
sprite: (
props
?) =>Sprite
Parameters
props?
Partial
<SpriteProps
>
Returns
Sprite
text()
text: (
props
?) =>Text
Parameters
props?
Partial
<TextProps
>
Returns
Text
texture()
texture: (
props
?) =>Texture
=resolveTexture
Parameters
props?
Partial
<TextureProps
>
Returns
Texture
uiCanvas()
uiCanvas: (
props
?) =>UICanvas
Parameters
props?
Partial
<UICanvasFactoryProps
>
Returns
svg()
Parameters
props
WithRequiredProps
<SvgProps
, "ctx"
>
Returns
Inherited from
Focusable(Interactive(WithSignals(Container))).add
bg
bg:
Graphics
Defined in: ui/Input.ts:133
caret
caret:
Container
Defined in: ui/Input.ts:134
clone
clone:
null
|Input
=null
Defined in: ui/Input.ts:156
error
error:
boolean
Defined in: ui/Input.ts:137
focusEnabled
focusEnabled:
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:19
Inherited from
Focusable(Interactive(WithSignals(Container))).focusEnabled
input
input:
Text
Defined in: ui/Input.ts:135
isClone
isClone:
boolean
=false
Defined in: ui/Input.ts:155
isFocused
isFocused:
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:17
Inherited from
Focusable(Interactive(WithSignals(Container))).isFocused
isKeyDown
isKeyDown:
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:18
Inherited from
Focusable(Interactive(WithSignals(Container))).isKeyDown
make
make:
object
Defined in: mixins/factory/Factory.ts:7
animatedSprite()
animatedSprite: (
props
?) =>AnimatedSprite
Parameters
props?
Partial
<AnimatedSpriteProps
>
Returns
bitmapText()
bitmapText: (
props
?) =>BitmapText
Parameters
props?
Partial
<TextProps
>
Returns
BitmapText
button()
button: (
props
?) =>Button
Parameters
props?
Partial
<ButtonProps
>
Returns
container()
container: (
props
?) =>Container
Parameters
props?
Partial
<ContainerProps
>
Returns
existing()
existing: <
TEntity
>(entity
,props
?) =>TEntity
Type Parameters
• TEntity
Parameters
entity
TEntity
props?
Partial
<ExistingProps
>
Returns
TEntity
flexContainer()
flexContainer: (
props
?) =>FlexContainer
Parameters
props?
Partial
<FlexContainerProps
>
Returns
graphics()
graphics: (
props
?) =>Graphics
Parameters
props?
Partial
<GraphicsProps
>
Returns
Graphics
htmlText()
htmlText: (
props
?) =>HTMLText
Parameters
props?
Partial
<HTMLTextProps
>
Returns
HTMLText
particleContainer()
particleContainer: (
props
?) =>ParticleContainer
Parameters
props?
Partial
<ParticleContainerProps
>
Returns
spine()
spine: (
props
?) =>Spine
Parameters
props?
Partial
<SpineProps
>
Returns
spineAnimation()
spineAnimation: (
props
?) =>SpineAnimation
Parameters
props?
Partial
<SpineProps
>
Returns
sprite()
sprite: (
props
?) =>Sprite
Parameters
props?
Partial
<SpriteProps
>
Returns
Sprite
text()
text: (
props
?) =>Text
Parameters
props?
Partial
<TextProps
>
Returns
Text
texture()
texture: (
props
?) =>Texture
=resolveTexture
Parameters
props?
Partial
<TextureProps
>
Returns
Texture
uiCanvas()
uiCanvas: (
props
?) =>UICanvas
Parameters
props?
Partial
<UICanvasFactoryProps
>
Returns
svg()
Parameters
props
WithRequiredProps
<SvgProps
, "ctx"
>
Returns
Inherited from
Focusable(Interactive(WithSignals(Container))).make
onAnimationComplete
onAnimationComplete:
Signal
<(entity
) =>void
>
Defined in: mixins/animated.ts:21
Inherited from
Focusable(Interactive(WithSignals(Container))).onAnimationComplete
onAnimationStart
onAnimationStart:
Signal
<(entity
) =>void
>
Defined in: mixins/animated.ts:19
Inherited from
Focusable(Interactive(WithSignals(Container))).onAnimationStart
onAnimationUpdate
onAnimationUpdate:
Signal
<(entity
) =>void
>
Defined in: mixins/animated.ts:20
Inherited from
Focusable(Interactive(WithSignals(Container))).onAnimationUpdate
onBlur
onBlur:
Signal
<(focusable
) =>void
>
Defined in: plugins/focus/FocusManagerPlugin.ts:35
Inherited from
Focusable(Interactive(WithSignals(Container))).onBlur
onChange
onChange:
Signal
<(detail
) =>void
>
Defined in: ui/Input.ts:129
onDestroy
onDestroy:
Signal
<() =>void
>
Defined in: display/Container.ts:60
Inherited from
Focusable(Interactive(WithSignals(Container))).onDestroy
onEnter
onEnter:
Signal
<(detail
) =>void
>
Defined in: ui/Input.ts:128
onError
onError:
Signal
<(detail
) =>void
>
Defined in: ui/Input.ts:130
onFocus
onFocus:
Signal
<(focusable
) =>void
>
Defined in: plugins/focus/FocusManagerPlugin.ts:34
Inherited from
Focusable(Interactive(WithSignals(Container))).onFocus
onFocusIn
onFocusIn:
Signal
<(focusable
) =>void
>
Defined in: plugins/focus/FocusManagerPlugin.ts:32
Inherited from
Focusable(Interactive(WithSignals(Container))).onFocusIn
onFocusOut
onFocusOut:
Signal
<(focusable
) =>void
>
Defined in: plugins/focus/FocusManagerPlugin.ts:33
Inherited from
Focusable(Interactive(WithSignals(Container))).onFocusOut
onInteraction()
onInteraction: (
eventName
) =>InteractionSignal
Defined in: mixins/interaction.ts:16
Parameters
eventName
keyof FederatedEventMap | keyof GlobalFederatedEventMap
Returns
Inherited from
Focusable(Interactive(WithSignals(Container))).onInteraction
options
options:
InputOptions
Defined in: ui/Input.ts:132
placeholder
placeholder:
Text
Defined in: ui/Input.ts:136
signalConnections
signalConnections:
SignalConnections
Defined in: mixins/signals.ts:9
Inherited from
Focusable(Interactive(WithSignals(Container))).signalConnections
Accessors
app
Get Signature
get app():
A
Defined in: display/Container.ts:82
Get the application instance.
Returns
A
Inherited from
Focusable(Interactive(WithSignals(Container))).app
caretPosition
Get Signature
get caretPosition():
number
Defined in: ui/Input.ts:226
Returns
number
isValid
Get Signature
get isValid():
boolean
Defined in: ui/Input.ts:242
Returns
boolean
regex
Set Signature
set regex(
value
):void
Defined in: ui/Input.ts:238
Parameters
value
RegExp
Returns
void
selectionRect
Get Signature
get selectionRect():
null
|Rectangle
Defined in: ui/Input.ts:232
Returns
null
| Rectangle
value
Get Signature
get value():
string
Defined in: ui/Input.ts:261
Returns
string
Set Signature
set value(
value
):void
Defined in: ui/Input.ts:265
Parameters
value
string
Returns
void
Methods
_checkPointerDownOutside()
_checkPointerDownOutside(
e
):void
Defined in: ui/Input.ts:340
Parameters
e
FederatedPointerEvent
Returns
void
_focusDomElement()
_focusDomElement(
selection
?):void
Defined in: ui/Input.ts:313
Parameters
selection?
number
Returns
void
_triggerFocusAndSelection()
_triggerFocusAndSelection(
selection
?):void
Defined in: ui/Input.ts:323
Parameters
selection?
number
Returns
void
addColoredBackground()
addColoredBackground(
colorOrConfig
,alpha
):Sprite
Defined in: display/Container.ts:86
Parameters
colorOrConfig
number
| Partial
<BackgroundConfig
>
alpha
number
= 1
Returns
Sprite
Inherited from
Focusable(Interactive(WithSignals(Container))).addColoredBackground
added()
added():
void
Defined in: ui/Input.ts:290
This method is called when the container is added to the stage. It is meant to be overridden by subclasses.
Returns
void
Overrides
Focusable(Interactive(WithSignals(Container))).added
addSignalConnection()
addSignalConnection(…
args
):void
Defined in: mixins/signals.ts:13
Parameters
args
…SignalConnection
[]
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).addSignalConnection
animate()
animate(
animationProps
,instance
?):Tween
Defined in: mixins/animated.ts:23
Parameters
animationProps
instance?
any
Returns
Tween
Inherited from
Focusable(Interactive(WithSignals(Container))).animate
animateFrom()
animateFrom(
animationProps
,instance
?):Tween
Defined in: mixins/animated.ts:25
Parameters
animationProps
instance?
any
Returns
Tween
Inherited from
Focusable(Interactive(WithSignals(Container))).animateFrom
animateFromTo()
animateFromTo(
fromProps
,toProps
,instance
?):Tween
Defined in: mixins/animated.ts:27
Parameters
fromProps
toProps
instance?
any
Returns
Tween
Inherited from
Focusable(Interactive(WithSignals(Container))).animateFromTo
animateSequence()
animateSequence(
sequences
,instance
?):Timeline
Defined in: mixins/animated.ts:33
Parameters
sequences
instance?
any
Returns
Timeline
Inherited from
Focusable(Interactive(WithSignals(Container))).animateSequence
blur()
blur():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:43
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).blur
bob()
bob(
config
?,instance
?):Tween
Defined in: mixins/animated.ts:50
Parameters
config?
duration
number
intensity
number
instance?
any
Returns
Tween
Inherited from
Focusable(Interactive(WithSignals(Container))).bob
click()
click():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:41
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).click
connectAction()
connectAction(…
args
):void
Defined in: mixins/signals.ts:15
Parameters
args
…SignalConnection
[]
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).connectAction
connectSignal()
connectSignal(…
args
):void
Defined in: mixins/signals.ts:14
Parameters
args
…SignalConnection
[]
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).connectSignal
destroy()
destroy():
void
Defined in: ui/Input.ts:485
Returns
void
Overrides
Focusable(Interactive(WithSignals(Container))).destroy
destroyAnimations()
destroyAnimations():
void
Defined in: mixins/animated.ts:39
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).destroyAnimations
drawBg()
drawBg(
width
,height
):void
Defined in: ui/Input.ts:469
Parameters
width
number
= ...
height
number
= ...
Returns
void
drawSelection()
drawSelection():
void
Defined in: ui/Input.ts:457
Returns
void
focusIn()
focusIn():
void
Defined in: ui/Input.ts:309
Returns
void
Overrides
Focusable(Interactive(WithSignals(Container))).focusIn
focusOut()
focusOut():
void
Defined in: ui/Input.ts:349
Returns
void
Overrides
Focusable(Interactive(WithSignals(Container))).focusOut
getFocusArea()
getFocusArea():
Bounds
Defined in: plugins/focus/FocusManagerPlugin.ts:47
Returns
Bounds
Inherited from
Focusable(Interactive(WithSignals(Container))).getFocusArea
getFocusPosition()
getFocusPosition():
null
|PointLike
Defined in: plugins/focus/FocusManagerPlugin.ts:49
Returns
null
| PointLike
Inherited from
Focusable(Interactive(WithSignals(Container))).getFocusPosition
getFocusSize()
getFocusSize():
null
|PointLike
Defined in: plugins/focus/FocusManagerPlugin.ts:51
Returns
null
| PointLike
Inherited from
Focusable(Interactive(WithSignals(Container))).getFocusSize
handleClick()
handleClick(
e
?):void
Defined in: ui/Input.ts:297
Parameters
e?
FederatedEvent
Returns
void
isAnimationPlaying()
isAnimationPlaying():
boolean
Defined in: mixins/animated.ts:43
Returns
boolean
Inherited from
Focusable(Interactive(WithSignals(Container))).isAnimationPlaying
pauseAnimations()
pauseAnimations():
void
Defined in: mixins/animated.ts:35
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).pauseAnimations
pulse()
pulse(
config
?,instance
?):Tween
Defined in: mixins/animated.ts:48
Parameters
config?
duration
number
intensity
number
times
number
instance?
any
Returns
Tween
Inherited from
Focusable(Interactive(WithSignals(Container))).pulse
removed()
removed():
void
Defined in: display/Container.ts:154
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).removed
resetBg()
resetBg():
void
Defined in: ui/Input.ts:286
Returns
void
resize()
resize():
void
Defined in: ui/Input.ts:279
Resize the container. This method is meant to be overridden by subclasses.
Returns
void
Overrides
Focusable(Interactive(WithSignals(Container))).resize
resumeAnimations()
resumeAnimations():
void
Defined in: mixins/animated.ts:37
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).resumeAnimations
reverseAnimation()
reverseAnimation():
void
Defined in: mixins/animated.ts:41
Returns
void
Inherited from
Focusable(Interactive(WithSignals(Container))).reverseAnimation
shake()
shake(
config
?,instance
?):Tween
Defined in: mixins/animated.ts:46
Parameters
config?
duration
number
intensity
number
times
number
instance?
any
Returns
Tween
Inherited from
Focusable(Interactive(WithSignals(Container))).shake
update()
update():
void
Defined in: ui/Input.ts:353
Update the container. This method is meant to be overridden by subclasses.
Returns
void
Overrides
Focusable(Interactive(WithSignals(Container))).update