solara 1.29.1__py2.py3-none-any.whl → 1.30.0__py2.py3-none-any.whl

solara/website/pages/documentation/api/__init__.py

@@ -0,0 +1,19 @@
+"""
+# Overview
+Click on one of the items on the left.
+"""
+
+import solara
+from solara.website.components import CategoryLayout, Gallery
+
+_title = "API"
+
+
+@solara.component
+def Page(route_external=None):
+    Gallery(route_external)
+
+
+@solara.component
+def Layout(children=[]):
+    CategoryLayout(children=children)

solara/website/pages/documentation/api/cross_filter/__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/api/hooks/__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/{api → documentation/api/hooks}/use_effect.md

@@ -8,7 +8,7 @@ def use_effect(
     ...
 ```
 
-Execute non-declarative code within a callback, for instance to add event handlers. `effect` is executed *after* page render, letting us fetch the actual underlying widget object using `solara.get_widget` on an element. `dependencies` should be a list of variables, which when changed trigger re-execution of `effect`. If left empty, `effect` will never re-execute. 
+Execute non-declarative code within a callback, for instance to add event handlers. `effect` is executed *after* page render, letting us fetch the actual underlying widget object using `solara.get_widget` on an element. `dependencies` should be a list of variables, which when changed trigger re-execution of `effect`. If left empty, `effect` will never re-execute.
 
 `effect` can return a cleanup function, which will be called before re-execution of `effect`, or when the component containing `use_effect` is removed.
 
@@ -34,10 +34,10 @@ def use_event(el: solara.Element, callback: Callable):
 def Page():
     def function():
         #Do something...
-    
+
     input = solara.InputText():
     use_event(input, function)
     ...
 ```
 
-See also the [Reacton docs](https://reacton.solara.dev/en/latest/api/#use_effect).
+See also the [Reacton docs](https://reacton.solara.dev/en/latest/api/#use_effect).

solara/website/pages/{api → documentation/api/hooks}/use_effect.py

@@ -1,5 +1,6 @@
 from pathlib import Path
-from . import NoPage
+
+from solara.website.components import NoPage
 
 HERE = Path(__file__).parent
 __doc__ = open(HERE / "use_effect.md").read()

solara/website/pages/{api → documentation/api/hooks}/use_memo.md

@@ -11,6 +11,6 @@ def use_memo(
 
 `use_memo` stores ([memoize](https://en.wikipedia.org/wiki/Memoization)) the function return on first render, and then excludes it from being re-executed, except when one of the `dependencies` changes. `dependencies` can take the value `None`, in which case dependencies are automatically obtained from nonlocal variables. If an empty list is passed as `dependencies` instead, the function is only executed once over the entire lifetime of the component.
 
-Not to be confused with [memorize](https://solara.dev/api/memoize) which can cache multiple return values and which can be used outside of component.
+Not to be confused with [memorize](https://solara.dev/documentation/api/utilities/memoize) which can cache multiple return values and which can be used outside of component.
 
-See also the [Reacton docs](https://reacton.solara.dev/en/latest/api/#use_memo).
+See also the [Reacton docs](https://reacton.solara.dev/en/latest/api/#use_memo).

solara/website/pages/{api → documentation/api/hooks}/use_memo.py

@@ -1,5 +1,6 @@
 from pathlib import Path
-from . import NoPage
+
+from solara.website.components import NoPage
 
 HERE = Path(__file__).parent
 __doc__ = open(HERE / "use_memo.md").read()

solara/website/pages/{api → documentation/api/hooks}/use_reactive.py

@@ -3,10 +3,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "use_reactive"
 
 

solara/website/pages/{api → documentation/api/hooks}/use_state.py

@@ -3,10 +3,9 @@
 """
 import solara
 import solara.autorouting
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "use_state"
 Page = NoPage
 __doc__ += apidoc(solara.use_state)  # type: ignore

solara/website/pages/documentation/api/routing/__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/{api → documentation/api/routing}/generate_routes.py

@@ -3,10 +3,9 @@
 """
 import solara
 import solara.autorouting
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "generate_routes"
 Page = NoPage
 __doc__ += apidoc(solara.autorouting.generate_routes)  # type: ignore

solara/website/pages/{api → documentation/api/routing}/generate_routes_directory.py

@@ -3,10 +3,9 @@
 """
 import solara
 import solara.autorouting
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "generate_routes_directory"
 Page = NoPage
 __doc__ += apidoc(solara.autorouting.generate_routes_directory)  # type: ignore

solara/website/pages/{api → documentation/api/routing}/use_route.py

@@ -29,9 +29,9 @@ def Fruit():
                 with solara.Link(solara.resolve_path(route_fruit)):
                     solara.Button(route_fruit.path)
 
-            with solara.Link("/api/use_route/fruit/nofruit", nofollow=True):
+            with solara.Link("/documentation/api/routing/use_route/fruit/nofruit", nofollow=True):
                 solara.Button("Wrong fruit")
-            with solara.Link("/api/use_route/not-routed", nofollow=True):
+            with solara.Link("/documentation/api/routing/use_route/not-routed", nofollow=True):
                 solara.Button("Wrong url")
         solara.Success(f"You chose {route.path}")
     return main

solara/website/pages/{api → documentation/api/routing}/use_router.py

@@ -3,10 +3,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "use_router"
 
 

solara/website/pages/documentation/api/utilities/__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/{api → documentation/api/utilities}/component_vue.py

@@ -3,10 +3,9 @@
 """
 import solara
 import solara.autorouting
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "component_vue"
 Page = NoPage
 __doc__ += apidoc(solara.component_vue)  # type: ignore

solara/website/pages/{api → documentation/api/utilities}/computed.py

@@ -2,11 +2,11 @@
 # computed
 
 """
+
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "computed"
 
 

solara/website/pages/{api → documentation/api/utilities}/display.py

@@ -3,10 +3,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "display"
 
 

solara/website/pages/{api → documentation/api/utilities}/get_kernel_id.py

@@ -2,11 +2,11 @@
 # get_kernel_id
 
 """
+
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "get_kernel_id"
 
 

solara/website/pages/{api → documentation/api/utilities}/get_session_id.py

@@ -2,11 +2,11 @@
 # get_session_id
 
 """
+
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "get_session_id"
 
 

solara/website/pages/{api → documentation/api/utilities}/on_kernel_start.py

@@ -4,7 +4,8 @@
 Run a function when a virtual kernel (re)starts and optionally run a cleanup function on shutdown.
 
 ```python
-def on_kernel_start(f: Callable[[], Optional[Callable[[], None]]]):
+def on_kernel_start(f: Callable[[], Optional[Callable[[], None]]]) -> Callable[[], None]:
+    ...
 ```
 
 `f` will be called on each virtual kernel (re)start. This (usually) happens each time a browser tab connects to the server
@@ -12,10 +13,15 @@ def on_kernel_start(f: Callable[[], Optional[Callable[[], None]]]):
 The (optional) function returned by `f` will be called on kernel shutdown.
 
 Note that the cleanup functions are called in reverse order with respect to the order in which they were registered
-(e.g. the cleanup function of the last call to `on_kernel_start` will be called first on kernel shutdown)
+(e.g. the cleanup function of the last call to `on_kernel_start` will be called first on kernel shutdown).
+
+The return value of on_kernel_start is a cleanup function that will remove the callback from the list of callbacks to be called on kernel start.
+
+During hot reload, the callbacks that are added from scripts or modules that will be reloaded will be removed before the app is loaded
+again. This can cause the order of the callbacks to be different than at first run.
 """
 
-from . import NoPage
+from solara.website.components import NoPage
 
 title = "on_kernel_start"
 Page = NoPage

solara/website/pages/{api → documentation/api/utilities}/reactive.py

@@ -3,10 +3,9 @@
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "reactive"
 
 

solara/website/pages/{api → documentation/api/utilities}/widget.py

@@ -21,7 +21,7 @@ widget = solara.FileDownload.widget(data="some text data", filename="solara-demo
 ```
 
 This is very useful if you are migrating your application from a classic
-ipywidget to solara. See [also the ipywidgets tutorial](/docs/tutorial/ipywidgets).
+ipywidget to solara. See [also the ipywidgets tutorial](/documentation/getting_started/tutorials/ipywidgets).
 
 The `ipywidgets.ValueWidget` is used to enable the use of the widget in
 interact, or interactive. The `ipywidgets.VBox` is used to enable
@@ -98,7 +98,7 @@ def Page():
 
 """
 
-from . import NoPage
+from solara.website.components import NoPage
 
 Page = NoPage
 title = "widget"

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

@@ -0,0 +1,12 @@
+import solara
+from solara.website.components import CategoryLayout, Gallery
+
+
+@solara.component
+def Page(route_external=None):
+    Gallery(route_external)
+
+
+@solara.component
+def Layout(children=[]):
+    CategoryLayout(children=children)

solara/website/pages/documentation/components/advanced/__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/data/__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/enterprise/__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/{api → documentation/components/enterprise}/avatar.py

@@ -6,10 +6,9 @@ try:
     from solara_enterprise import auth
 except ImportError:
     auth = None
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "Avatar"
 
 Page = NoPage

solara/website/pages/{api → documentation/components/enterprise}/avatar_menu.py

@@ -6,10 +6,9 @@ try:
     from solara_enterprise import auth
 except ImportError:
     auth = None
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "AvatarMenu"
 
 Page = NoPage

solara/website/pages/documentation/components/input/__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/{api → documentation/components/input}/checkbox.py

@@ -3,10 +3,9 @@
 """
 
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 
 

solara/website/pages/documentation/components/input/file_drop.py

@@ -0,0 +1,75 @@
+"""
+# FileDrop components
+
+FileDrop comes in two flavours:
+
+   * `FileDrop` for a single file upload
+   * `FileDropMultiple` which allows for multiple file upload
+
+
+"""
+import textwrap
+from typing import List, cast
+
+import solara
+from solara.components.file_drop import FileInfo
+from solara.website.utils import apidoc
+
+
+@solara.component
+def FileDropMultipleDemo():
+    content, set_content = solara.use_state(cast(List[bytes], []))
+    filename, set_filename = solara.use_state(cast(List[str], []))
+    size, set_size = solara.use_state(cast(List[int], []))
+
+    def on_file(files: List[FileInfo]):
+        set_filename([f["name"] for f in files])
+        set_size([f["size"] for f in files])
+        set_content([f["file_obj"].read(100) for f in files])
+
+    solara.FileDropMultiple(
+        label="Drag and drop files(s) here to read the first 100 bytes.",
+        on_file=on_file,
+        lazy=True,  # We will only read the first 100 bytes
+    )
+    if content:
+        solara.Info(f"Number of uploaded files: {len(filename)}")
+        for f, s, c in zip(filename, size, content):
+            solara.Info(f"File {f} has total length: {s}\n, first 100 bytes:")
+            solara.Preformatted("\n".join(textwrap.wrap(repr(c))))
+
+
+@solara.component
+def FileDropDemo():
+    content, set_content = solara.use_state(b"")
+    filename, set_filename = solara.use_state("")
+    size, set_size = solara.use_state(0)
+
+    def on_file(f: FileInfo):
+        set_filename(f["name"])
+        set_size(f["size"])
+        set_content(f["file_obj"].read(100))
+
+    solara.FileDrop(
+        label="Drag and drop a file here to read the first 100 bytes.",
+        on_file=on_file,
+        lazy=True,  # We will only read the first 100 bytes
+    )
+    if content:
+        solara.Info(f"File {filename} has total length: {size}\n, first 100 bytes:")
+        solara.Preformatted("\n".join(textwrap.wrap(repr(content))))
+
+
+@solara.component
+def Page():
+    with solara.Row():
+        with solara.Card(title="FileDrop"):
+            FileDropDemo()
+        with solara.Card(title="FileDropMultiple"):
+            FileDropMultipleDemo()
+
+
+__doc__ += "# FileDrop"
+__doc__ += apidoc(solara.FileDrop.f)  # type: ignore
+__doc__ += "# FileDropMultiple"
+__doc__ += apidoc(solara.FileDropMultiple.f)  # type: ignore

solara/website/pages/{api → documentation/components/input}/input.py

@@ -5,10 +5,9 @@ This page contains all the input fields available in Solara.
 # InputText
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 
 

solara/website/pages/{api → documentation/components/input}/select.py

@@ -9,10 +9,9 @@ Select comes in two flavours:
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 
 

solara/website/pages/{api → documentation/components/input}/slider.py

@@ -6,10 +6,9 @@ To support proper typechecks, we have multiple slider (all wrapping the ipyvueti
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 
 __doc__ += "# SliderInt"

solara/website/pages/{api → documentation/components/input}/switch.py

@@ -3,10 +3,9 @@
 """
 
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 Page = NoPage
 
 

solara/website/pages/{api → documentation/components/input}/togglebuttons.py

@@ -6,10 +6,9 @@ ToggleButtons are in two flavours, for single, and for multiple selections.
 
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "ToggleButtons"
 
 Page = NoPage

solara/website/pages/documentation/components/lab/__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/{api → documentation/components/lab}/chat.py

@@ -5,15 +5,14 @@ These are the components available in Solara to build chat interfaces.
 Although they can be used together to create a pre-built chat interface, inserting custom components is also possible.
 For an example of how to use a custom message component, see the bottom of the page.
 
-Also check out the [Chatbot](/examples/ai/chatbot) example.
+Also check out the [Chatbot](/documentation/examples/ai/chatbot) example.
 
 # ChatBox
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "Chat Components"
 
 

solara/website/pages/{api → documentation/components/lab}/cookies_headers.py

@@ -42,7 +42,7 @@ def Page():
 
 """
 
-from . import NoPage
+from solara.website.components import NoPage
 
 title = "Cookies and Headers"
 Page = NoPage

solara/website/pages/{api → documentation/components/lab}/input_date.py

@@ -6,10 +6,9 @@ This page contains the two variants of datepickers available in solara
 # InputDate
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "InputDate"
 
 

solara/website/pages/{api → documentation/components/lab}/menu.py

@@ -6,10 +6,9 @@ This page contains the various kinds of menu elements available to use in solara
 # Menu
 """
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "Menus"
 
 

solara/website/pages/{api → documentation/components/lab}/task.py

@@ -4,10 +4,9 @@
 import solara
 import solara.autorouting
 import solara.lab
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "Task"
 Page = NoPage
 __doc__ += apidoc(solara.lab.task)  # type: ignore

solara/website/pages/{api → documentation/components/lab}/theming.py

@@ -64,10 +64,9 @@ responds to the theme variant change.
 """
 
 import solara
+from solara.website.components import NoPage
 from solara.website.utils import apidoc
 
-from . import NoPage
-
 title = "Themes"
 Page = NoPage
 __doc__ += apidoc(solara.lab.ThemeToggle)  # type: ignore