solara-ui 1.45.0__py3-none-any.whl

solara/website/pages/documentation/components/layout/columns.py

@@ -0,0 +1,27 @@
+"""
+# Columns
+
+"""
+
+import solara
+import solara.lab
+from solara.website.utils import apidoc
+
+gutters = solara.reactive(True)
+gutters_dense = solara.reactive(True)
+
+
+@solara.component
+def Page():
+    with solara.Columns([1, 2, 1], gutters=gutters.value, gutters_dense=gutters_dense.value) as main:
+        with solara.Card("Left", margin=0):
+            solara.Checkbox(label="Gutters").connect(gutters)
+            solara.Checkbox(label="Dense gutters").connect(gutters_dense)
+        with solara.Card("Middle", margin=0):
+            solara.Markdown("This column has a relative width of 2, the columns to the left and right have a relative width of 1.")
+        with solara.Card("Right", margin=0):
+            solara.Markdown("This column has a relative width of 1, the columns to the left has a relative width of 2.")
+    return main
+
+
+__doc__ += apidoc(solara.Columns.f)  # type: ignore

solara/website/pages/documentation/components/layout/columns_responsive.py

@@ -0,0 +1,66 @@
+"""
+# ColumnsResponsive
+
+"""
+
+import solara
+import solara.lab
+from solara.website.utils import apidoc
+
+title = "ColumnsResponsive"
+
+gutters = solara.reactive(True)
+gutters_dense = solara.reactive(True)
+wrap = solara.reactive(True)
+
+children_count = solara.reactive(12)
+columns_default = solara.reactive(6)
+columns_small = solara.reactive(4)
+columns_medium = solara.reactive(3)
+columns_large = solara.reactive(2)
+columns_xlarge = solara.reactive(1)
+
+
+@solara.component
+def Page():
+    with solara.Card("Controls"):
+        solara.Checkbox(label="Wrap").connect(wrap)
+        solara.Checkbox(label="Gutters").connect(gutters)
+        solara.Checkbox(label="Dense gutters").connect(gutters_dense)
+        solara.IntSlider("Children", max=20).connect(children_count)
+
+        solara.Select("columns default", values=[1, 2, 3, 4, 6, 12]).connect(columns_default)  # type: ignore
+        solara.Select("columns small", values=[1, 2, 3, 4, 6, 12]).connect(columns_small)  # type: ignore
+        solara.Select("columns medium", values=[1, 2, 3, 4, 6, 12]).connect(columns_medium)  # type: ignore
+        solara.Select("columns large", values=[1, 2, 3, 4, 6, 12]).connect(columns_large)  # type: ignore
+        solara.Select("columns xlarge", values=[1, 2, 3, 4, 6, 12]).connect(columns_xlarge)  # type: ignore
+    # taken from https://v2.vuetifyjs.com/en/styles/display/#display
+    solara.HTML(
+        "h2", unsafe_innerHTML=f"Current screensize is xsmall/default, each child is {columns_default.value} points wide", class_="ma-2 d-flex d-sm-none ma"
+    )
+    solara.HTML(
+        "h2", unsafe_innerHTML=f"Current screensize is small, each child is {columns_small.value} points wide", class_="ma-2 d-none d-sm-flex d-md-none"
+    )
+    solara.HTML(
+        "h2", unsafe_innerHTML=f"Current screensize is medium, each child is {columns_medium.value} points wide", class_="ma-2 d-none d-md-flex d-lg-none"
+    )
+    solara.HTML(
+        "h2", unsafe_innerHTML=f"Current screensize is large, each child is {columns_large.value} points wide", class_="ma-2 d-none d-lg-flex d-xl-none"
+    )
+    solara.HTML("h2", unsafe_innerHTML=f"Current screensize is xlarge, each child is {columns_xlarge.value} points wide", class_="ma-2 d-none d-xl-flex")
+    solara.Markdown("Change the screen size to see the effect of the different columns sizes.")
+    with solara.ColumnsResponsive(
+        default=columns_default.value,
+        small=columns_small.value,
+        medium=columns_medium.value,
+        large=columns_large.value,
+        xlarge=columns_xlarge.value,
+        wrap=wrap.value,
+        gutters=gutters.value,
+        gutters_dense=gutters_dense.value,
+    ):
+        for i in range(children_count.value):
+            solara.Text(f"{i}")
+
+
+__doc__ += apidoc(solara.ColumnsResponsive.f)  # type: ignore

solara/website/pages/documentation/components/layout/details.py

@@ -0,0 +1,13 @@
+"""
+# Details
+"""
+
+import solara
+from solara.website.components import NoPage
+from solara.website.utils import apidoc
+
+title = "Details"
+
+Page = NoPage
+
+__doc__ += apidoc(solara.Details.f)  # type: ignore

solara/website/pages/documentation/components/layout/griddraggable.py

@@ -0,0 +1,62 @@
+"""
+# GridDraggable
+
+Child components are laid out on a grid, which can be dragged and resized.
+"""
+
+import pprint
+import textwrap
+
+import solara
+
+from ..common import ColorCard
+
+title = "GridDraggable"
+
+
+@solara.component
+def Page():
+    grid_layout_initial = [
+        {"h": 5, "i": "0", "moved": False, "w": 3, "x": 0, "y": 0},
+        {"h": 5, "i": "1", "moved": False, "w": 5, "x": 3, "y": 0},
+        {"h": 11, "i": "2", "moved": False, "w": 4, "x": 8, "y": 0},
+        {"h": 12, "i": "3", "moved": False, "w": 5, "x": 0, "y": 5},
+        {"h": 6, "i": "4", "moved": False, "w": 3, "x": 5, "y": 5},
+        {"h": 6, "i": "5", "moved": False, "w": 7, "x": 5, "y": 11},
+    ]
+
+    colors = "green red orange brown yellow pink".split()
+
+    # we need to store the state of the grid_layout ourselves, otherwise it will 'reset'
+    # each time we change resizable or draggable
+    grid_layout, set_grid_layout = solara.use_state(grid_layout_initial)
+
+    # some placeholders
+    items = [ColorCard(title=f"Child {i}", color=colors[i]) for i in range(len(grid_layout))]
+    with solara.VBox() as main:
+        resizable = solara.ui_checkbox("Allow resizing", value=True)
+        draggable = solara.ui_checkbox("Allow dragging", value=True)
+
+        def reset_layout():
+            set_grid_layout(grid_layout_initial)
+
+        solara.Button("Reset to initial layout", on_click=reset_layout)
+
+        solara.GridDraggable(items=items, grid_layout=grid_layout, resizable=resizable, draggable=draggable, on_grid_layout=set_grid_layout)
+
+        # some string kung fu to make this print nicely
+        grid_layout_formatted = pprint.pformat(grid_layout, indent=4)
+        grid_layout_formatted = textwrap.indent(grid_layout_formatted, " " * len("grid_layout = "))
+        grid_layout_formatted = grid_layout_formatted[len("grid_layout = ") :]
+        solara.Markdown(
+            f"""
+            # Resulting layout
+
+            This layout can be copy pasted to put in your code as an initial layout:
+
+            ```python
+            grid_layout = {grid_layout_formatted}
+            ```
+            """
+        )
+    return main

solara/website/pages/documentation/components/layout/gridfixed.py

@@ -0,0 +1,19 @@
+"""
+# GridFixed
+
+Lays out children in a grid with a fixed number of columns.
+"""
+
+import solara
+
+from ..common import ColorCard
+
+title = "GridFixed"
+
+
+@solara.component
+def Page():
+    colors = "green red orange brown yellow pink".split()
+    with solara.GridFixed(columns=3):
+        for color in colors:
+            ColorCard(color, color)

solara/website/pages/documentation/components/layout/hbox.py

@@ -0,0 +1,18 @@
+"""
+# HBox
+Lays out children in horizontal direction.
+"""
+
+import solara
+
+from ..common import ColorCard
+
+
+@solara.component
+def Page():
+    with solara.VBox() as main:
+        colors = "green red orange brown yellow pink".split()
+        with solara.HBox():
+            for color in colors:
+                ColorCard(color, color)
+    return main

solara/website/pages/documentation/components/layout/row.py

@@ -0,0 +1,30 @@
+"""
+# Row
+"""
+
+import solara
+import solara.lab
+from solara.website.utils import apidoc
+
+gap_size = solara.reactive("12px")
+justify = solara.reactive("space-around")
+
+
+@solara.component
+def Page():
+    with solara.Card("Row demo") as main:
+        with solara.Column():
+            solara.Text("Justify:")
+            solara.ToggleButtonsSingle(justify, values=["start", "center", "end", "space-around", "space-between", "space-evenly"])
+            solara.Select(
+                label="Gap size",
+                values=["0px", "4px", "8px", "12px", "16px", "20px", "24px"],
+            ).connect(gap_size)
+        with solara.Row(gap=gap_size.value, justify=justify.value):
+            colors = "green red orange brown yellow pink".split()
+            for color in colors:
+                solara.Button(label="Solara", color=color)
+    return main
+
+
+__doc__ += apidoc(solara.Row.f)  # type: ignore

solara/website/pages/documentation/components/layout/sidebar.py

@@ -0,0 +1,24 @@
+"""
+# Sidebar
+
+"""
+
+import solara
+import solara.lab
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    return solara.Markdown(
+        """
+
+    The sidebar can only be shown in embedded mode on this page.
+    Visit the [Scatter app demo](/apps/scatter) to see an example of a full sidebar used in Soalra server.
+
+    [![AppLayout screenshot](https://dxhl76zpt6fap.cloudfront.net/public/docs/app-layout.webp)](/apps/scatter)
+    """
+    )
+
+
+__doc__ += apidoc(solara.Sidebar.f)  # type: ignore

solara/website/pages/documentation/components/layout/vbox.py

@@ -0,0 +1,19 @@
+"""
+# VBox
+
+Lays out children in a vertical direction.
+"""
+
+import solara
+
+from ..common import ColorCard
+
+
+@solara.component
+def Page():
+    with solara.VBox() as main:
+        colors = "green red orange brown yellow pink".split()
+        with solara.VBox():
+            for color in colors:
+                ColorCard(color, color)
+    return main

solara/website/pages/documentation/components/output/__init__.py

@@ -0,0 +1,9 @@
+import solara
+from solara.website.components import NoPage, SubCategoryLayout
+
+Page = NoPage
+
+
+@solara.component
+def Layout(children=[]):
+    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/output/file_download.py

@@ -0,0 +1,11 @@
+"""# FileDownload"""
+
+import solara
+from solara.website.components import NoPage
+from solara.website.utils import apidoc
+
+Page = NoPage
+title = "FileDownload"
+
+
+__doc__ += apidoc(solara.FileDownload.f)  # type: ignore

solara/website/pages/documentation/components/output/html.py

@@ -0,0 +1,19 @@
+"""# HTML"""
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    html = """
+<h1>Custom html</h1>
+<ul>
+    <li>Item 1
+    <li>Item 2
+</ul>
+"""
+    solara.HTML(tag="div", unsafe_innerHTML=html)
+
+
+__doc__ += apidoc(solara.HTML.f)  # type: ignore

solara/website/pages/documentation/components/output/image.py

@@ -0,0 +1,11 @@
+"""# Image"""
+
+import solara
+from solara.website.components import NoPage
+from solara.website.utils import apidoc
+
+Page = NoPage
+title = "Image"
+
+
+__doc__ += apidoc(solara.Image.f)  # type: ignore

solara/website/pages/documentation/components/output/markdown.py

@@ -0,0 +1,57 @@
+"""# Markdown"""
+
+import solara
+from solara.alias import rv
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    markdown_initial = """
+# Large
+## Smaller
+
+## List items
+
+    * item 1
+    * item 2
+
+
+## Code highlight support
+```python
+code = "formatted" and "supports highlighting"
+```
+
+
+## Mermaid support!
+See [Mermaid docs](https://mermaid-js.github.io/)
+
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```
+
+
+    """.strip()
+
+    markdown_text, set_markdown_text = solara.use_state(markdown_initial)
+    # with solara.GridFixed(columns=2) as main:
+    with solara.HBox(grow=True) as main:
+        with solara.VBox():
+            solara.Markdown("# Input text")
+            with solara.Padding(2):
+                with rv.Sheet(elevation=2):
+                    rv.Textarea(v_model=markdown_text, on_v_model=set_markdown_text, rows=30)
+        with solara.VBox():
+            solara.Markdown("# Renders like")
+            with solara.Padding(2):
+                with rv.Sheet(elevation=2):
+                    solara.Markdown(markdown_text)
+
+    return main
+
+
+__doc__ += apidoc(solara.Markdown.f)  # type: ignore

solara/website/pages/documentation/components/output/markdown_editor.py

@@ -0,0 +1,51 @@
+"""# MarkdownEditor"""
+
+import solara
+from solara.alias import rv
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    markdown_initial = """
+# Large heading
+## Medium heading
+### Small heading
+
+
+## List items
+
+   * item 1
+   * item 2
+
+## Numbered items
+
+   1. item 1
+   2. item 2
+
+
+**bold** and *italic*, [GitHub link](https://github.com/widgetti/solara/)
+
+
+```
+preformatted code
+which respecs spaces
+and line breaks
+```
+
+    """.strip()
+
+    markdown_text, set_markdown_text = solara.use_state(markdown_initial)
+    with solara.HBox(grow=True) as main:
+        with solara.VBox():
+            with solara.Padding(2):
+                with rv.Sheet(elevation=2):
+                    solara.MarkdownEditor(markdown_text, on_value=set_markdown_text)
+                with rv.Sheet(elevation=2):
+                    solara.Markdown("# Raw markdown")
+                    solara.Preformatted(markdown_text)
+
+    return main
+
+
+__doc__ += apidoc(solara.MarkdownEditor.f)  # type: ignore

solara/website/pages/documentation/components/output/sql_code.py

@@ -0,0 +1,83 @@
+"""
+# SqlCode
+"""
+
+import os
+import sqlite3
+import threading
+from typing import Optional, cast
+
+import pandas as pd
+
+try:
+    import vaex.datasets
+except ImportError:
+    vaex = None
+
+import solara
+from solara.website.utils import apidoc
+
+if vaex is not None:
+    df_iris = vaex.datasets.iris().to_pandas_df()
+    df_titanic = vaex.datasets.titanic().to_pandas_df()
+
+    def create_db():
+        conn = sqlite3.connect(filename)
+        df_iris.to_sql("iris", conn, if_exists="replace", index=False)
+        df_titanic.to_sql("titanic", conn, if_exists="replace", index=False)
+        conn.close()
+
+    filename = "solara-sql.db"
+    if not os.path.exists(filename):
+        create_db()
+
+    conn = sqlite3.connect(filename)
+    conn.row_factory = sqlite3.Row
+    table_names = [k[0] for k in conn.execute("SELECT name FROM sqlite_master WHERE type='table' ORDER BY name").fetchall()]
+    table_hints = {table_name: conn.execute(f"SELECT * from {table_name} LIMIT 1").fetchone().keys() for table_name in table_names}
+
+
+@solara.component
+def Page():
+    if vaex is None:
+        return solara.Error("Vaex is not installed, run pip install vaex-core vaex-hdf5")
+    query, set_query = solara.use_state("SELECT * from titanic")  # noqa: SH101
+    query_executed, set_query_executed = solara.use_state(cast(Optional[str], None))  # noqa: SH101
+
+    def run_query(cancel: threading.Event) -> pd.DataFrame:
+        if not query_executed:
+            return
+        conn = sqlite3.connect(filename)
+        cursor = conn.cursor()
+        cursor.execute(query_executed)
+
+        df = pd.DataFrame(cursor.fetchall(), columns=[k[0] for k in cursor.description])
+        return df
+
+    result: solara.Result[pd.DataFrame] = solara.use_thread(run_query, dependencies=[query_executed])  # noqa: SH101
+
+    solara.SqlCode(query=query, tables=table_hints, on_query=set_query)
+    enable_execute = (query != query_executed) or result.error is not None
+
+    def execute():
+        set_query_executed(query)
+        if query == query_executed and result.error:
+            result.retry()  # type: ignore
+
+    solara.Button("Execute", on_click=execute, disabled=not enable_execute)
+    if result.error:
+        solara.Error(f"Ooops {result.error}")
+    elif not query:
+        solara.Info("No query")
+
+    elif result.value is not None:
+        solara.Markdown(f"Result for query: `{query_executed}`")
+        df = result.value
+        solara.DataFrame(df)
+    elif query_executed is not None:
+        with solara.Div():
+            solara.Text("Loading data...")
+            solara.v.ProgressCircular(indeterminate=True, class_="solara-progress")
+
+
+__doc__ += apidoc(solara.SqlCode.f)  # type: ignore

solara/website/pages/documentation/components/output/tooltip.py

@@ -0,0 +1,11 @@
+"""# Tooltip"""
+
+import solara
+from solara.website.components import NoPage
+from solara.website.utils import apidoc
+
+Page = NoPage
+title = "Tooltip"
+
+
+__doc__ += apidoc(solara.Tooltip.f)  # type: ignore

solara/website/pages/documentation/components/page/__init__.py

@@ -0,0 +1,9 @@
+import solara
+from solara.website.components import NoPage, SubCategoryLayout
+
+Page = NoPage
+
+
+@solara.component
+def Layout(children=[]):
+    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/page/head.py

@@ -0,0 +1,15 @@
+"""# Head"""
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    solara.Info("A Head component does not render somesome visual on the page, but it is used to avoid duplicate tags, such as titles.")
+    with solara.Head():
+        # title should always occur inside a Head component
+        solara.Title("Custom title")
+
+
+__doc__ += apidoc(solara.Head.f)  # type: ignore

solara/website/pages/documentation/components/page/title.py

@@ -0,0 +1,25 @@
+"""# Title"""
+
+from typing import Optional, cast
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    title = solara.use_reactive(cast(Optional[str], "Custom title!"))
+
+    solara.ToggleButtonsSingle(value=title, values=[None, "Custom title!", "Different custom title"])
+
+    if title is not None:
+        # if the title is not set in a child component, the parent's title will be used
+        with solara.Head():
+            # title should always occur inside a Head component
+            solara.Title(title)
+        solara.Info(f"Your browser tab title should say {title}", classes=["mt-4"])
+    else:
+        solara.Warning("If no title is set, the parent title is used.", classes=["mt-4"])
+
+
+__doc__ += apidoc(solara.Title.f)  # type: ignore

solara/website/pages/documentation/components/status/__init__.py

@@ -0,0 +1,9 @@
+import solara
+from solara.website.components import NoPage, SubCategoryLayout
+
+Page = NoPage
+
+
+@solara.component
+def Layout(children=[]):
+    SubCategoryLayout(children=children)

solara/website/pages/documentation/components/status/error.py

@@ -0,0 +1,39 @@
+"""# Error
+
+Solara has 4 types of alerts:
+
+ * [Success](/documentation/components/status/success)
+ * [Info](/documentation/components/status/info)
+ * [Warning](/documentation/components/status/warning)
+ * Error (this page)
+
+
+
+"""
+
+import solara
+from solara.website.utils import apidoc
+
+
+@solara.component
+def Page():
+    icon = solara.use_reactive(True)
+    dense = solara.use_reactive(False)
+    outlined = solara.use_reactive(True)
+    text = solara.use_reactive(True)
+
+    with solara.GridFixed(4):
+        solara.Checkbox(label="Use icon", value=icon)
+        solara.Checkbox(label="Show dense", value=dense)
+        solara.Checkbox(label="Show as text", value=text)
+        solara.Checkbox(label="Show outlined", value=outlined)
+    solara.Error(
+        f"This is solara.Error(label='...', text={text.value}, dense={dense.value}, outlined={outlined.value}, icon={icon.value})",
+        text=text.value,
+        dense=dense.value,
+        outlined=outlined.value,
+        icon=icon.value,
+    )
+
+
+__doc__ += apidoc(solara.Error.f)  # type: ignore