Skip to content
pixi-silk
GitHub repository
Entry point

pixi-silk/ui/textedit

TextEditor: an editable SilkText field with caret, selection and IME.

import { TextEditor } from 'pixi-silk/ui/textedit';

Classes#

ClassDescription
TextEditorText you can click and edit on the canvas. It draws a SilkText plus a caret and a selection drawn with silk.

Interfaces#

InterfaceDescription
TextEditorOptionsOptions of a TextEditor: the text style plus how it edits.
TextEditorStateThe reactive state of a TextEditor.
TextEditorThemeColours of a TextEditor.
TextSelectionA selection: where it started (anchor) and where the caret is (focus). Equal for a plain caret.

Type Aliases#

Type AliasDescription
TextEditKindWhat kind of edit a change is. Consecutive edits of the same kind merge into one undo step.

Variables#

VariableDescription
TEXT_EDITOR_THEMEDefault colours of a TextEditor: a blue caret and highlight. Override single values with the theme option.