Text area

.github/workflows/pythonpackage.yml

@@ -55,4 +55,4 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: snapshot-report-textual
-          path: tests/snapshot_tests/output/snapshot_report.html
+          path: snapshot_report.html

docs/examples/widgets/horizontal_rules.py

@@ -1,6 +1,6 @@
 from textual.app import App, ComposeResult
-from textual.widgets import Rule, Label
 from textual.containers import Vertical
+from textual.widgets import Label, Rule
 
 
 class HorizontalRulesApp(App):

docs/examples/widgets/java_highlights.scm

@@ -0,0 +1,140 @@
+; Methods
+
+(method_declaration
+  name: (identifier) @function.method)
+(method_invocation
+  name: (identifier) @function.method)
+(super) @function.builtin
+
+; Annotations
+
+(annotation
+  name: (identifier) @attribute)
+(marker_annotation
+  name: (identifier) @attribute)
+
+"@" @operator
+
+; Types
+
+(type_identifier) @type
+
+(interface_declaration
+  name: (identifier) @type)
+(class_declaration
+  name: (identifier) @type)
+(enum_declaration
+  name: (identifier) @type)
+
+((field_access
+  object: (identifier) @type)
+ (#match? @type "^[A-Z]"))
+((scoped_identifier
+  scope: (identifier) @type)
+ (#match? @type "^[A-Z]"))
+((method_invocation
+  object: (identifier) @type)
+ (#match? @type "^[A-Z]"))
+((method_reference
+  . (identifier) @type)
+ (#match? @type "^[A-Z]"))
+
+(constructor_declaration
+  name: (identifier) @type)
+
+[
+  (boolean_type)
+  (integral_type)
+  (floating_point_type)
+  (floating_point_type)
+  (void_type)
+] @type.builtin
+
+; Variables
+
+((identifier) @constant
+ (#match? @constant "^_*[A-Z][A-Z\\d_]+$"))
+
+(identifier) @variable
+
+(this) @variable.builtin
+
+; Literals
+
+[
+  (hex_integer_literal)
+  (decimal_integer_literal)
+  (octal_integer_literal)
+  (decimal_floating_point_literal)
+  (hex_floating_point_literal)
+] @number
+
+[
+  (character_literal)
+  (string_literal)
+] @string
+
+[
+  (true)
+  (false)
+  (null_literal)
+] @constant.builtin
+
+[
+  (line_comment)
+  (block_comment)
+] @comment
+
+; Keywords
+
+[
+  "abstract"
+  "assert"
+  "break"
+  "case"
+  "catch"
+  "class"
+  "continue"
+  "default"
+  "do"
+  "else"
+  "enum"
+  "exports"
+  "extends"
+  "final"
+  "finally"
+  "for"
+  "if"
+  "implements"
+  "import"
+  "instanceof"
+  "interface"
+  "module"
+  "native"
+  "new"
+  "non-sealed"
+  "open"
+  "opens"
+  "package"
+  "private"
+  "protected"
+  "provides"
+  "public"
+  "requires"
+  "return"
+  "sealed"
+  "static"
+  "strictfp"
+  "switch"
+  "synchronized"
+  "throw"
+  "throws"
+  "to"
+  "transient"
+  "transitive"
+  "try"
+  "uses"
+  "volatile"
+  "while"
+  "with"
+] @keyword

docs/examples/widgets/text_area_custom_language.py

@@ -0,0 +1,34 @@
+from pathlib import Path
+
+from tree_sitter_languages import get_language
+
+from textual.app import App, ComposeResult
+from textual.widgets import TextArea
+
+java_language = get_language("java")
+java_highlight_query = (Path(__file__).parent / "java_highlights.scm").read_text()
+java_code = """\
+class HelloWorld {
+    public static void main(String[] args) {
+        System.out.println("Hello, World!");
+    }
+}
+"""
+
+
+class TextAreaCustomLanguage(App):
+    def compose(self) -> ComposeResult:
+        text_area = TextArea(text=java_code)
+        text_area.cursor_blink = False
+
+        # Register the Java language and highlight query
+        text_area.register_language(java_language, java_highlight_query)
+
+        # Switch to Java
+        text_area.language = "java"
+        yield text_area
+
+
+app = TextAreaCustomLanguage()
+if __name__ == "__main__":
+    app.run()

docs/examples/widgets/text_area_custom_theme.py

@@ -0,0 +1,42 @@
+from rich.style import Style
+
+from textual._text_area_theme import TextAreaTheme
+from textual.app import App, ComposeResult
+from textual.widgets import TextArea
+
+TEXT = """\
+# says hello
+def hello(name):
+    print("hello" + name)
+
+# says goodbye
+def goodbye(name):
+    print("goodbye" + name)
+"""
+
+MY_THEME = TextAreaTheme(
+    # This name will be used to refer to the theme...
+    name="my_cool_theme",
+    # Basic styles such as background, cursor, selection, gutter, etc...
+    cursor_style=Style(color="white", bgcolor="blue"),
+    cursor_line_style=Style(bgcolor="yellow"),
+    # `syntax_styles` maps tokens parsed from the document to Rich styles.
+    syntax_styles={
+        "string": Style(color="red"),
+        "comment": Style(color="magenta"),
+    },
+)
+
+
+class TextAreaCustomThemes(App):
+    def compose(self) -> ComposeResult:
+        text_area = TextArea(TEXT, language="python")
+        text_area.cursor_blink = False
+        text_area.register_theme(MY_THEME)
+        text_area.theme = "my_cool_theme"
+        yield text_area
+
+
+app = TextAreaCustomThemes()
+if __name__ == "__main__":
+    app.run()

docs/examples/widgets/text_area_example.py

@@ -0,0 +1,20 @@
+from textual.app import App, ComposeResult
+from textual.widgets import TextArea
+
+TEXT = """\
+def hello(name):
+    print("hello" + name)
+
+def goodbye(name):
+    print("goodbye" + name)
+"""
+
+
+class TextAreaExample(App):
+    def compose(self) -> ComposeResult:
+        yield TextArea(TEXT, language="python")
+
+
+app = TextAreaExample()
+if __name__ == "__main__":
+    app.run()

docs/examples/widgets/text_area_extended.py

@@ -0,0 +1,23 @@
+from textual import events
+from textual.app import App, ComposeResult
+from textual.widgets import TextArea
+
+
+class ExtendedTextArea(TextArea):
+    """A subclass of TextArea with parenthesis-closing functionality."""
+
+    def _on_key(self, event: events.Key) -> None:
+        if event.character == "(":
+            self.insert("()")
+            self.move_cursor_relative(columns=-1)
+            event.prevent_default()
+
+
+class TextAreaKeyPressHook(App):
+    def compose(self) -> ComposeResult:
+        yield ExtendedTextArea(language="python")
+
+
+app = TextAreaKeyPressHook()
+if __name__ == "__main__":
+    app.run()

docs/examples/widgets/text_area_selection.py

@@ -0,0 +1,23 @@
+from textual.app import App, ComposeResult
+from textual.widgets import TextArea
+from textual.widgets.text_area import Selection
+
+TEXT = """\
+def hello(name):
+    print("hello" + name)
+
+def goodbye(name):
+    print("goodbye" + name)
+"""
+
+
+class TextAreaSelection(App):
+    def compose(self) -> ComposeResult:
+        text_area = TextArea(TEXT, language="python")
+        text_area.selection = Selection(start=(0, 0), end=(2, 0))  # (1)!
+        yield text_area
+
+
+app = TextAreaSelection()
+if __name__ == "__main__":
+    app.run()

docs/examples/widgets/vertical_rules.py

@@ -1,6 +1,6 @@
 from textual.app import App, ComposeResult
-from textual.widgets import Rule, Label
 from textual.containers import Horizontal
+from textual.widgets import Label, Rule
 
 
 class VerticalRulesApp(App):

docs/widget_gallery.md

@@ -281,7 +281,7 @@ Displays simple static content. Typically used as a base class.
 
 ## Switch
 
-A on / off control, inspired by toggle buttons.
+An on / off control, inspired by toggle buttons.
 
 [Switch reference](./widgets/switch.md){ .md-button .md-button--primary }
 
@@ -307,6 +307,14 @@ A Combination of Tabs and ContentSwitcher to navigate static content.
 ```{.textual path="docs/examples/widgets/tabbed_content.py" press="j"}
 ```
 
+## TextArea
+
+A multi-line text area which supports syntax highlighting various languages.
+
+[TextArea reference](./widgets/text_area.md){ .md-button .md-button--primary }
+
+```{.textual path="docs/examples/widgets/text_area.py" columns="42" lines="8"}
+```
 
 ## Tree
 

docs/widgets/_template.md

@@ -32,6 +32,7 @@ Example app showing the widget:
 
 ## Reactive Attributes
 
+## Messages
 
 ## Bindings