Minor fixes, add examples (#46)

README.md

@@ -27,7 +27,8 @@ jpterm
 To run jpterm as a client to a Jupyter server, you need, well, jupyter-server :) You can install it through JupyterLab:
 
 ```bash
-pip install --pre jupyterlab
+pip install "jupyterlab>=4"
+pip install jupyter-collaboration
 ```
 
 Then launch it with:
@@ -49,9 +50,9 @@ jpterm --server http://127.0.0.1:8000/?token=972cbd440db4b35581b25f90c0a88e3a109
 # jpterm --server http://127.0.0.1:8000
 ```
 
-If JupyterLab and jpterm are launched with `--collaborative`, you can open a document in
+If jpterm is launched with `--collaborative`, you can open a document in
 JupyterLab (go to http://127.0.0.1:8000 in your browser), modify it, and see the changes live
-in jpterm.
+in jpterm. This also works the other way around.
 
 ## Development install
 

examples/demo.md

@@ -0,0 +1,129 @@
+# Textual Markdown Browser - Demo
+
+This page contains a lot of Markdown code we will use to test the MD browser.
+
+## Headers
+
+Headers levels 1 through 6 are supported.
+
+### This is H3
+
+Header level 3 content. Still fairly important, but we don't want it to be too distracting.
+
+#### This is H4
+
+Header level 4 content. Drilling down in to finer headings.
+
+##### This is H5
+
+Header level 5 content.
+
+###### This is H6
+
+Header level 6 content.
+
+## Typography
+
+The usual Markdown typography is supported. The exact output depends on your terminal, although most are fairly consistent.
+
+### Emphasis
+
+Emphasis is rendered with `*asterisks*`, and looks *like this*;
+
+### Strong
+
+Use two asterisks to indicate strong which renders in bold, e.g. `**strong**` render **strong**.
+
+### Strikethrough
+
+Two tildes indicates strikethrough, e.g. `~~cross out~~` render ~~cross out~~.
+
+### Inline code ###
+
+Inline cod is indicated by backticks. e.g. `import this`.
+
+## Fences
+
+Fenced code blocks are introduced with three back-ticks and the optional parser. Here we are rendering the code in a sub-widget with syntax highlighting and indent guides.
+
+In the future I think we could add controls to export the code, copy to the clipboard. Heck, even run it and show the output?
+
+```python
+@lru_cache(maxsize=1024)
+def split(self, cut_x: int, cut_y: int) -> tuple[Region, Region, Region, Region]:
+    """Split a region in to 4 from given x and y offsets (cuts).
+
+    ```
+                cut_x ↓
+            ┌────────┐ ┌───┐
+            │        │ │   │
+            │    0   │ │ 1 │
+            │        │ │   │
+    cut_y → └────────┘ └───┘
+            ┌────────┐ ┌───┐
+            │    2   │ │ 3 │
+            └────────┘ └───┘
+    ```
+
+    Args:
+        cut_x (int): Offset from self.x where the cut should be made. If negative, the cut
+            is taken from the right edge.
+        cut_y (int): Offset from self.y where the cut should be made. If negative, the cut
+            is taken from the lower edge.
+
+    Returns:
+        tuple[Region, Region, Region, Region]: Four new regions which add up to the original (self).
+    """
+
+    x, y, width, height = self
+    if cut_x < 0:
+        cut_x = width + cut_x
+    if cut_y < 0:
+        cut_y = height + cut_y
+
+    _Region = Region
+    return (
+        _Region(x, y, cut_x, cut_y),
+        _Region(x + cut_x, y, width - cut_x, cut_y),
+        _Region(x, y + cut_y, cut_x, height - cut_y),
+        _Region(x + cut_x, y + cut_y, width - cut_x, height - cut_y),
+    )
+```
+
+## Quote
+
+Quotes are introduced with a chevron, and render like this:
+
+> I must not fear.
+> Fear is the mind-killer.
+> Fear is the little-death that brings total obliteration.
+> I will face my fear.
+> I will permit it to pass over me and through me.
+> And when it has gone past, I will turn the inner eye to see its path.
+> Where the fear has gone there will be nothing. Only I will remain."
+
+Quotes nest nicely. Here's what quotes within quotes look like:
+
+> I must not fear.
+> > Fear is the mind-killer.
+> > Fear is the little-death that brings total obliteration.
+> > I will face my fear.
+> > > I will permit it to pass over me and through me.
+> > > And when it has gone past, I will turn the inner eye to see its path.
+> > > Where the fear has gone there will be nothing. Only I will remain.
+
+## Tables
+
+Tables are supported, and render with a DataTable.
+
+I would like to add controls to these widgets to export the table as CSV, which I think would be a nice feature. In the future we might also have sortable columns by clicking on the headers.
+
+
+| Name            | Type   | Default | Description                        |
+| --------------- | ------ | ------- | ---------------------------------- |
+| `show_header`   | `bool` | `True`  | Show the table header              |
+| `fixed_rows`    | `int`  | `0`     | Number of fixed rows               |
+| `fixed_columns` | `int`  | `0`     | Number of fixed columns            |
+| `zebra_stripes` | `bool` | `False` | Display alternating colors on rows |
+| `header_height` | `int`  | `1`     | Height of header row               |
+| `show_cursor`   | `bool` | `True`  | Show a cell cursor                 |

examples/plotext.ipynb

@@ -0,0 +1,82 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from ypywidgets_textual.plotext import Plotext\n",
+    "plt = Plotext()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plt"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plt.title('Scatter Plot')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "x = [0, 1, 2, 3, 4, 5]\n",
+    "y = [5, 6, 7, 1, 2, 3]\n",
+    "plt.scatter(x, y)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plt.title('Hello')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plt.clear_data()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/switch.ipynb

@@ -0,0 +1,80 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from ypywidgets_textual.switch import Switch\n",
+    "switch = Switch()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "switch"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "switch.toggle()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(switch.value)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print('hello')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print('world')"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

plugins/local_contents/txl_local_contents/components.py

@@ -16,6 +16,7 @@ async def get(
         path: str,
         is_dir: bool = False,
         type: str = "file",
+        format: str | None = None,
     ) -> Union[List, Y.YDoc]:
         p = Path(path)
         assert (await p.is_dir()) == is_dir

pyproject.toml

@@ -83,7 +83,8 @@ pre-install-commands = [
     "pip install -e ./plugins/launcher",
     "pip install -e ./plugins/widgets",
 
-    "pip install --pre jupyterlab",
+    'pip install "jupyterlab>=4"',
+    "pip install jupyter-collaboration",
 ]
 
 [tool.jupyter-releaser.options]

txl/pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
 ]
 dependencies = [
   "asphalt >=4.11.1,<5",
-  "textual >=0.38.1,<0.39",
+  "textual[syntax] >=0.40.0,<0.41.0",
   "y-py >=0.6.0,<1",
 ]
 dynamic = ["version"]

txl/txl/text_input.py

@@ -11,6 +11,8 @@ def __init__(self, ydoc, ytext, path=None, language=None):
         if language is None:
             if path is not None:
                 language = Syntax.guess_lexer(path, code=text)
+        if language == "default":
+            language = None
         super().__init__(text, language=language)
         ytext.observe(self.on_change)