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

solara/website/pages/{docs/content/50-enterprise → documentation/advanced/content/30-enterprise}/10-oauth.md

@@ -1,3 +1,7 @@
+---
+title: Using OAuth in your Solara app
+description: Open Authorization can be readily integrated into your Solara applications via the Solara-Enterprise package.
+---
 # OAuth: authentication and authorization support
 
 ## What is OAuth
@@ -8,7 +12,7 @@ You have probably used OAuth without realizing it when signing into various onli
 
 ## Installing
 
-To install Solara with OAuth support, make sure you have [Solara Enterprise](/docs/enterprise) install by run the following command:
+To install Solara with OAuth support, make sure you have [Solara Enterprise](/documentation/advanced/enterprise) install by run the following command:
 
 ```bash
 $ pip install solara solara-enterprise[auth]
@@ -152,8 +156,8 @@ ZgrzSLUyft-JvnNMNJ2LgbCFVqcxPOatANAQhMD5EYU
 
 Solara provides two convenient components for creating a user interface for login and logout:
 
- 1. [Avatar](/api/avatar): This component shows the user's avatar.
- 2. [AvatarMenu](/api/avatar_menu): This component shows a menu with the user's avatar and a logout button.
+ 1. [Avatar](/documentation/components/enterprise/avatar): This component shows the user's avatar.
+ 2. [AvatarMenu](/documentation/components/enterprise/avatar_menu): This component shows a menu with the user's avatar and a logout button.
 
  ## Python version support
 

solara/website/pages/{docs/content/10-howto → documentation/advanced/content/40-development}/01-contribute.md

@@ -1,3 +1,7 @@
+---
+title: Contributing to Solara
+description: You do not need to be a developer to contribute to Solara. We welcome all contributions, bug reports, documentation improvements and code contributions.
+---
 # Contributing to Solara
 
 You do not need to be a developer to contribute to Solara. We welcome all contributions, bug reports, documentation improvements and code contributions.
@@ -7,8 +11,8 @@ You do not need to be a developer to contribute to Solara. We welcome all contri
 
 We use [GitHub to manage issues](https://github.com/widgetti/solara/issues/new) and you should not hesitate to report any bug you find. Please include as much information as possible for us to be able to reproduce the bug. Yes, reporting a bug/issue is a contribution!
 
-It might take a while for us to get back to you. If the bug is urgent, and you are able to provide financial support for its rapid resolution, please [contact us](/docs/contact).
-If you can fix the bug yourself, please consider submitting a pull request instead, see [the development guide](/docs/development) for more information.
+It might take a while for us to get back to you. If the bug is urgent, and you are able to provide financial support for its rapid resolution, please [contact us](/contact).
+If you can fix the bug yourself, please consider submitting a pull request instead, see [the development guide](/documentation/advanced/development/setup) for more information.
 
 If you are unable to address the bug yourself and find it challenging to provide financial support, please be assured we are still committed to rectifying bugs and resolving issues. However, please understand that our ability to address these issues may be impacted by our resources at hand, as sustaining this project also entails financial obligations. Your patience and understanding in this matter is highly appreciated 🙇.
 
@@ -16,7 +20,7 @@ If you are unable to address the bug yourself and find it challenging to provide
 
 The documentation is mostly written in Markdown, and can be found at [in the main repository](https://github.com/widgetti/solara/tree/master/solara/website/pages).
 
-You can use the GitHub web interface to edit the files, or clone the repository and edit them locally. See [the development guide](/docs/development) for more information.
+You can use the GitHub web interface to edit the files, or clone the repository and edit them locally. See [the development guide](/documentation/advanced/development/setup) for more information.
 
 If you locally want to render the documentation, run:
 
@@ -26,10 +30,10 @@ $ solara run solara.website.pages
 
 ## Examples or showcase
 
-If you have a complete program you want to share, and you think it would be cool to be listed at [our showcase page](/showcase), [please contact us](/docs/contact).
+If you have a complete program you want to share, and you think it would be cool to be listed at [our showcase page](/showcase), [please contact us](/contact).
 
 If you want to show a particular way of using Solara that you think is very useful
-for others, but it is not a complete program, consider adding to [the examples](/docs/examples). See [the development guide](/docs/development) for more information.
+for others, but it is not a complete program, consider adding to [the examples](/documentation/examples/). See [the development guide](/documentation/advanced/development/setup) for more information.
 
 ## Share your experiences and ideas
 

solara/website/pages/{docs/content/90-development → documentation/advanced/content/40-development}/10-setup.md

@@ -1,9 +1,13 @@
+---
+title: Development setup for Solara
+description: Learn how to set up your installation for developing on the Solara itself.
+---
 # Development
 
-See also [the contributing guide](/docs/howto/contribute) for more information on how to contribute to Solara.
+See also [the contributing guide](/documentation/advanced/development/contribute) for more information on how to contribute to Solara.
 ## Development setup
 
-Assuming you have created a virtual environment as described in [the installation guide](/docs/installing), you can install a development install of Solara using:
+Assuming you have created a virtual environment as described in [the installation guide](/documentation/getting_started/installing), you can install a development install of Solara using:
 
     $ git clone git@github.com:widgetti/solara.git
     $ cd solara

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)