More documentation for Input widget

docs/events/click.md

@@ -8,7 +8,7 @@ The `Click` event is sent to a widget when the user clicks a mouse button.
 ## Attributes
 
 | attribute  | type | purpose                                   |
-| ---------- | ---- | ----------------------------------------- |
+|------------|------|-------------------------------------------|
 | `x`        | int  | Mouse x coordinate, relative to Widget    |
 | `y`        | int  | Mouse y coordinate, relative to Widget    |
 | `delta_x`  | int  | Change in x since last mouse event        |

docs/events/mouse_move.md

@@ -8,7 +8,7 @@ The `MouseMove` event is sent to a widget when the mouse pointer is moved over a
 ## Attributes
 
 | attribute  | type | purpose                                   |
-| ---------- | ---- | ----------------------------------------- |
+|------------|------|-------------------------------------------|
 | `x`        | int  | Mouse x coordinate, relative to Widget    |
 | `y`        | int  | Mouse y coordinate, relative to Widget    |
 | `delta_x`  | int  | Change in x since last mouse event        |

docs/events/mouse_release.md

@@ -8,7 +8,7 @@ The `MouseRelease` event is sent to a widget when it is no longer receiving mous
 ## Attributes
 
 | attribute        | type   | purpose                                       |
-| ---------------- | ------ | --------------------------------------------- |
+|------------------|--------|-----------------------------------------------|
 | `mouse_position` | Offset | Mouse coordinates when the mouse was released |
 
 ## Code

docs/events/mouse_scroll_down.md

@@ -8,7 +8,7 @@ The `MouseScrollDown` event is sent to a widget when the scroll wheel (or trackp
 ## Attributes
 
 | attribute | type | purpose                                |
-| --------- | ---- | -------------------------------------- |
+|-----------|------|----------------------------------------|
 | `x`       | int  | Mouse x coordinate, relative to Widget |
 | `y`       | int  | Mouse y coordinate, relative to Widget |
 

docs/events/mouse_scroll_up.md

@@ -8,7 +8,7 @@ The `MouseScrollUp` event is sent to a widget when the scroll wheel (or trackpad
 ## Attributes
 
 | attribute | type | purpose                                |
-| --------- | ---- | -------------------------------------- |
+|-----------|------|----------------------------------------|
 | `x`       | int  | Mouse x coordinate, relative to Widget |
 | `y`       | int  | Mouse y coordinate, relative to Widget |
 

docs/events/mouse_up.md

@@ -8,7 +8,7 @@ The `MouseUp` event is sent to a widget when the user releases a mouse button.
 ## Attributes
 
 | attribute  | type | purpose                                   |
-| ---------- | ---- | ----------------------------------------- |
+|------------|------|-------------------------------------------|
 | `x`        | int  | Mouse x coordinate, relative to Widget    |
 | `y`        | int  | Mouse y coordinate, relative to Widget    |
 | `delta_x`  | int  | Change in x since last mouse event        |

docs/events/paste.md

@@ -8,7 +8,7 @@ The `Paste` event is sent to a widget when the user pastes text.
 ## Attributes
 
 | attribute | type | purpose                  |
-| --------- | ---- | ------------------------ |
+|-----------|------|--------------------------|
 | `text`    | str  | The text that was pasted |
 
 ## Code

docs/events/resize.md

@@ -8,7 +8,7 @@ The `Resize` event is sent to a widget when its size changes and when it is firs
 ## Attributes
 
 | attribute        | type | purpose                                          |
-| ---------------- | ---- | ------------------------------------------------ |
+|------------------|------|--------------------------------------------------|
 | `size`           | Size | The new size of the Widget                       |
 | `virtual_size`   | Size | The virtual size (scrollable area) of the Widget |
 | `container_size` | Size | The size of the container (parent widget)        |

docs/reference/input.md

@@ -0,0 +1 @@
+::: textual.widgets.Input

docs/widgets/footer.md

@@ -5,6 +5,9 @@
 A simple footer widget which is docked to the bottom of its parent container. Displays
 available keybindings for the currently focused widget.
 
+- [ ] Focusable
+- [ ] Container
+
 ## Example
 
 The example below shows an app with a single keybinding that contains only a `Footer`

docs/widgets/header.md

@@ -4,6 +4,9 @@
 
 A simple header widget which docks itself to the top of the parent container.
 
+- [ ] Focusable
+- [ ] Container
+
 ## Example
 
 The example below shows an app with a `Header`.

docs/widgets/input.md

@@ -0,0 +1,68 @@
+# Input
+
+## Description
+
+A single-line text input widget.
+
+- [x] Focusable
+- [ ] Container
+
+## Example
+
+The example below shows how you might create a simple form using two `Input` widgets.
+
+=== "Output"
+
+    ```{.textual path="docs/examples/widgets/input.py"}
+    ```
+
+=== "input.py"
+
+    ```python
+    --8<-- "docs/examples/widgets/input.py"
+    ```
+
+## Reactive Attributes
+
+| Name              | Type   | Default | Description                                                     |
+|-------------------|--------|---------|-----------------------------------------------------------------|
+| `cursor_blink`    | `bool` | `True`  | True if cursor blinking is enabled.                             |
+| `value`           | `str`  | `""`    | The value currently in the text input.                          |
+| `cursor_position` | `int`  | `0`     | The index of the cursor in the value string.                    |
+| `placeholder`     | `str`  | `str`   | The dimmed placeholder text to display when the input is empty. |
+| `password`        | `bool` | `False` | True if the input should be masked.                             |
+
+## Messages
+
+### Changed
+
+The `Input.Changed` message is sent when the value in the text input changes.
+
+- [x] Bubbles
+
+#### Attributes
+
+| attribute | type  | purpose                          |
+|-----------|-------|----------------------------------|
+| `value`   | `str` | The new value in the text input. |
+
+
+### Submitted
+
+- [x] Bubbles
+
+#### Attributes
+
+| attribute | type  | purpose                          |
+|-----------|-------|----------------------------------|
+| `value`   | `str` | The new value in the text input. |
+
+
+## Additional Notes
+
+* The spacing around the text content is due to border. To remove it, set `border: none;` in your CSS.
+*
+
+## See Also
+
+* [Input](../reference/input.md) code reference

docs/widgets/static.md

@@ -5,6 +5,9 @@
 A widget which displays a static renderable content.
 Can be used for simple text labels, but can also contain more complex Rich renderables.
 
+- [ ] Focusable
+- [x] Container
+
 ## Example
 
 The example below shows how you can use a `Static` widget as a simple text label.

docs/widgets/text_input.md

@@ -1 +0,0 @@
-# TextInput

mkdocs.yml

@@ -91,7 +91,7 @@ nav:
     - "widgets/footer.md"
     - "widgets/header.md"
     - "widgets/static.md"
-    - "widgets/text_input.md"
+    - "widgets/input.md"
     - "widgets/tree_control.md"
   - Reference:
     - "reference/app.md"