solara-ui 1.45.0__py3-none-any.whl

solara/website/pages/documentation/getting_started/content/05-fundamentals/00-overview.md

@@ -0,0 +1,11 @@
+---
+title: Fundamentals of Solara
+description: These articles dive deeper into the fundamental aspects of Soalra, like using components, hooks, and managing state.
+---
+# Fundamentals
+
+If you want to dive deeper into Solara, this section is for you. We will cover the following topics:
+
+  * [Components](/documentation/getting_started/fundamentals/components)
+  * Hooks (soon)
+  * [State management](/documentation/getting_started/fundamentals/state-management)

solara/website/pages/documentation/getting_started/content/05-fundamentals/10-components.md

@@ -0,0 +1,228 @@
+---
+title: Introduction to Solara components
+description: In Solara, components are the building blocks of your web application. They allow you to create modular, reusable, and maintainable user interface elements
+    that can be combined to create a complete and interactive application.
+---
+<!-- TODO: column auto -->
+
+# Introduction to Components
+
+In Solara, components are the building blocks of your web application. They allow you to create modular, reusable, and maintainable user interface (UI) elements that can be combined to create a complete and interactive application. Components can range from simple UI elements, such as buttons or text inputs, to more complex and custom visualizations or forms.
+
+The primary benefits of using components in Solara include:
+
+ * Modularity: Components can be designed independently and then combined to form more complex UIs. This modular approach promotes separation of concerns, making it easier to reason about and maintain each part of your application.
+ * Reusability: Components can be reused across different parts of your application or even across multiple projects. This can save time and effort by reducing the need to rewrite similar code and can lead to more consistent UIs.
+ * Maintainability: By breaking your application into smaller, self-contained components, it becomes easier to understand, debug, and update your code. This results in more maintainable and resilient applications.
+ * Performance: When a component instance depends on a specific state, and that state changes, only the render function of the affected component instance will be re-executed. This selective re-rendering ensures that other components or instances that do not depend on the changed state remain unaffected, leading to more efficient performance.
+
+## Types of Components
+
+In Solara, there are two main types of components: Widget Components and Function Components.
+
+## Widget components
+
+Widget Components correspond to ipywidgets and are responsible for rendering visual elements in the browser, such as buttons, sliders, or performing layout tasks. These components are the foundation of your user interface and provide the essential building blocks for creating interactive applications.
+
+Solara mainly uses the [ipyvuetify library](/documentation/advanced/understanding/ipyvuetify) for its widget components. It provides a set of high-level components that can be used to create rich, interactive user interfaces.
+
+See the [components page](/documentation/components) for a complete list of basic UI components.
+
+## Function Components
+
+Function Components (Components for short), on the other hand, are responsible for combining logic, state, and other components to create more complex and dynamic applications. These components serve as a way to create reusable and modular structures that can be easily integrated into your application.
+
+These are the components that you will be writing when building Solara applications.
+
+By utilizing both Widget Components and Function Components, you can create flexible and powerful applications that provide a rich user experience while maintaining a clean and organized codebase.
+
+## Creating New Components
+
+In Solara, users can create their own custom components without any special distinction from the built-in components provided by the framework, they are all components. These user-defined components have the same capabilities and can be composed seamlessly alongside Solara's components, allowing for the creation of highly customized and reusable user interfaces.
+
+# Defining Components
+To create a component in Solara, you'll start by defining a Python function decorated with `@solara.component`. Inside the function, you can create the component's structure by calling Solara's built-in components or creating custom components to suit your specific needs. If a single element is created, it's taken as the component's main element. If multiple elements are created, they are automatically wrapped in a [Column component](/documentation/components/layout/column).
+
+Here's an example of a simple Solara component that displays a button:
+
+```python
+import solara
+
+@solara.component
+def MyButton():
+    solara.Button("Click me!")
+```
+
+In this example, we create a component function named MyButton and apply the @solara.component decorator to it. Within the component function, a Button component from Solara is created, displaying the text "Click me!".
+
+## Using Components
+Once you've created your components, you can use them in your Solara app by calling the components to create elements. Elements, the lightweight representations of components, can be combined to build complex UIs. They can also be passed as arguments to other components, enabling a flexible and modular application structure.
+
+Here's an example of using the `MyButton` component we defined earlier:
+
+```python
+import solara
+
+@solara.component
+def MyApp():
+    MyButton()
+    MyButton()
+```
+
+In this example, we create a `MyApp` function decorated with `@solara.component`. The function creates two MyButton elements, resulting in two buttons (or two component instances).
+
+## Handling User Interactions
+Components in Solara can capture user input and respond to events, such as button clicks or form submissions. To handle user interactions, you'll define callback functions and connect them to your components using Solara's event handling system.
+
+Here's an example of a Solara component that displays a button and responds to click events:
+
+```python
+import solara
+
+def on_button_click(event):
+    print("Button clicked!")
+
+@solara.component
+def MyInteractiveButton():
+    solara.Button("Click me!", on_click=on_button_click)
+```
+
+In this example, we define a function called `on_button_click` that will be executed when the button is clicked. In the `MyInteractiveButton` function, we create a Button component and set the `on_click` argument to the `on_button_click` function.
+
+By following these steps, you can create and use components to build rich, interactive applications with Solara.
+
+
+## Component Arguments and State
+In Solara, components can accept arguments and maintain internal state to manage their behavior and appearance. This section will explain how to use arguments and state in your Solara components and provide code examples to demonstrate their usage.
+
+### Component Arguments
+Arguments are the values that you pass to a component when you call it, allowing you to customize its behavior and appearance. You can define the arguments your component accepts by specifying them as parameters in the component function. This makes your components more reusable and flexible, as you can easily modify their behavior by passing different argument values.
+
+Here's an example of a Solara component that accepts an argument:
+
+```python
+import solara
+
+@solara.component
+def MyButton(text):
+    solara.Button(text)
+```
+
+In this example, we define a function called MyButton that takes a single argument, text. The render function creates a Button component from Solara with the specified text.
+
+### Using Application state in Components
+To manage the state of a component in Solara, you can use the [`solara.reactive()`](/documentation/api/utilities/reactive) function to create reactive variables. Reactive variables are used to store values that can change over time and automatically trigger component updates when their values change. This allows you to create components that respond to changes in data and user interactions.
+
+Here's an example that demonstrates the use of reactive variables in Solara components:
+```solara
+import solara
+
+counter = solara.reactive(0)
+
+
+def increment():
+    counter.value += 1
+
+
+@solara.component
+def CounterDisplay():
+    solara.Info(f"Counter: {counter.value}")
+
+
+@solara.component
+def IncrementButton():
+    solara.Button("Increment", on_click=increment)
+
+
+@solara.component
+def Page():
+    IncrementButton()
+    CounterDisplay()
+```
+
+In this example, we create a reactive variable counter with an initial value of 0. We define two components: `CounterDisplay` and `IncrementButton`. `CounterDisplay` renders the current value of counter, while `IncrementButton` increments the value of counter when clicked. Whenever the counter value changes, `CounterDisplay` automatically updates to display the new value.
+
+By using arguments and state in your Solara components, you can create more dynamic and interactive applications that respond to user input and changes in data.
+
+### Internal State in Components
+
+In addition to using reactive variables for global or application-wide state, you can also manage internal or component-specific state using the [`use_reactive`](/documentation/api/hooks/use_reactive) hook in Solara. The `use_reactive` hook allows you to define reactive variables which are local to a component, and automatically trigger updates when their values change.
+
+To use the `use_reactive` hook, call the solara.use_reactive() function inside your component function. This function takes an initial value as an argument and returns a the same reactive variable on each render.
+
+Here's an example that demonstrates the use of the use_reactive hook to manage internal state in a Solara component:
+
+```solara
+import solara
+
+
+@solara.component
+def Counter():
+    count = solara.use_reactive(0)
+
+    def increment():
+        count.value += 1
+
+    solara.Button("Increment", on_click=increment)
+    solara.Info(f"Counter: {count.value}")
+
+
+@solara.component
+def Page():
+    Counter()
+```
+
+In this example, we define a Counter component that uses the `use_reactive` hook to manage its internal state. We create a reactive variable called `count` with an initial value of 0 and a function `increment` to update the state. The increment function increments the value of count when the button is clicked. Whenever the count value changes, the component automatically updates to display the new value.
+
+By using the `use_reactive` hook, you can manage the internal state of your components and create more dynamic and interactive applications that respond to user input and changes in data.
+
+## Lazy Rendering in Solara Components
+
+In Solara, understanding the relationship between components, elements, and instances is essential to grasp the rendering process. Components serve as a blueprint or template for defining the structure and behavior of a part of the user interface. Elements are lightweight virtual representations of components, created when the components are invoked. Instances, on the other hand, represent the function body of the component and its state.
+
+Solara employs a "lazy rendering" approach, where the rendering of a component's children is deferred until it is necessary. When a component is invoked, an element is created immediately, representing that particular instance of the component. However, the actual rendering of the component's children is postponed until the component is rendered within the virtual tree, either as a child of another component or as the root component. This allows Solara to optimize the rendering process and update only the necessary components when the application state or component arguments change.
+
+Lazy rendering in Solara ensures that the render function is executed only when necessary, improving the application's performance. To illustrate this concept, let's consider the following example:
+
+
+```solara
+import solara
+
+counter = solara.reactive(0)
+
+@solara.component
+def CounterDisplay():
+    solara.Info(f"Counter: {counter.value}")
+
+@solara.component
+def IncrementButton():
+    def increment():
+        counter.value += 1
+
+    solara.Button("Increment", on_click=increment)
+
+@solara.component
+def RandomText():
+    import random
+    solara.Info(f"Random number: {random.random()}")
+
+@solara.component
+def Page():
+    IncrementButton()
+    CounterDisplay()
+    RandomText()
+```
+
+In this example, we define several components: `IncrementButton`, `CounterDisplay`, and `RandomText`. The `IncrementButton` component increments the value of the counter reactive variable when clicked. The `CounterDisplay` component displays the current value of the counter. The `RandomText` component displays a random number but does not depend on any state or reactive variables.
+
+When the user clicks the `IncrementButton`, the counter reactive variable is updated, and the `CounterDisplay` component re-renders to show the new value. The RandomText component does not re-render in this scenario because it does not depend on any state or reactive variables.
+
+This example demonstrates Solara's lazy rendering, where only the relevant components are instantiated and rendered based on changes in their arguments or internal state. This ensures that the render function is executed only when necessary, improving the application's performance.
+
+
+## Conclusions
+In conclusion, understanding components, their arguments, and how to manage their internal state is crucial for building Solara applications. To create more advanced components, you need to have a deeper understanding of hooks, such as the `use_reactive` hook we have already discussed.
+
+In the next fundamentals article, we will explore more hooks available in Solara, which will enable you to build more sophisticated components that cater to a wide range of use cases. By learning about hooks, you can create powerful components that can manage state, interact with other components, and respond to user input.
+
+To summarize, components are the building blocks of Solara applications, and they can accept arguments to customize their behavior and appearance. Managing state in components can be done either through local (component) state or application-wide state, each with its advantages and disadvantages. By striking a balance between reusable components and application-specific code, you can create scalable and maintainable applications in Solara. With a solid understanding of components and their state management, you are well on your way to creating powerful and interactive web applications with Solara.

solara/website/pages/documentation/getting_started/content/05-fundamentals/50-state-management.md

@@ -0,0 +1,278 @@
+---
+title: Introduction to state management in Solara
+description: State management is a crucial aspect of building data-focused web applications with Solara. By effectively managing state, you can create interactive
+    and responsive applications that react to changes in data and user input.
+---
+# Introduction
+
+State management is a crucial aspect of building data-focused web applications with Solara. By effectively managing state, you can create interactive and responsive applications that react to changes in data and user input. In Solara, there are two primary ways to define state: global application state using [`solara.reactive`](/documentation/api/utilities/reactive) and local component state using [`solara.use_state`](/documentation/api/hooks/use_state) or [`solara.use_reactive`](/documentation/api/hooks/use_reactive). This article will discuss these two approaches and provide examples of how to use them in your Solara applications.
+
+## Two main ways of defining state in Solara
+
+### Global application state using solara.reactive
+
+Using [`solara.reactive`](/documentation/api/utilities/reactive) allows you to create global state variables that can be accessed and modified from any component within your application. This approach is useful when you need to manage state that is shared across multiple components or when you want to maintain consistency throughout your application.
+
+Example:
+
+```solara
+import solara
+
+color = solara.reactive("red")
+
+@solara.component
+def SomeAppSpecificComponent():
+    solara.Select(label="Color", values=["red", "green", "blue", "orange"], value=color)
+    solara.Markdown("### Solara is awesome", style={"color": color.value})
+
+@solara.component
+def Page():
+    SomeAppSpecificComponent()
+
+```
+
+In this case, the `SomeAppSpecificComponent` is not reusable in the sense that a second component has a different state. The `color` variable is global and shared across all components. This component is meant to be used only once, and mainly helps to organize the code.
+
+You may have heard that globals are considered a bad practice. As with many things, it depends on the context. A possible downside of using a global is that it does not
+allow you to create multiple instances of the same component with different states. But if the state reflects application state, there is by definition only one instance
+of it needed.
+
+### Local component state using solara.use_reactive
+
+If you do need state that is specific to a component, you should use [`solara.use_reactive`](/documentation/api/hooks/use_reactive) hook. This hook allow you to create local state variables that are scoped to a specific component. This approach is useful when you want to encapsulate state within a component, making it self-contained and modular. Local state management is suitable for situations where state changes only affect the component and do not need to be shared across the application.
+
+
+```solara hl_lines="6 8"
+import solara
+
+
+@solara.component
+def ReusableComponent():
+    color = solara.use_reactive("red")  # local state (instead of top level solara.reactive)
+    solara.Select(label="Color",values=["red", "green", "blue", "orange"],
+                  value=color)
+    solara.Markdown("### Solara is awesome", style={"color": color.value})
+
+
+@solara.component
+def Page():
+    # this component is used twice, but each instance has its own state
+    ReusableComponent()
+    ReusableComponent()
+
+```
+
+### Local component state using solara.use_state (not recommended)
+
+[`solara.use_state`](/documentation/api/hooks/use_state) is a hook that might be a bit more familiar to React developers. It also allows you to create local state variables that are scoped to a specific component, however, instead of using reactive variables, it uses a tuple of a value and a setter function.
+
+We generally recommend using `use_reactive` over `use_state` as it is more easy to refactor between global application state and local component state by switching between `use_reactive` and `reactive`. There is no equivalent for `use_state` at the global level.
+
+If we take the previous example and replace `use_reactive` by `use_state`, we get:
+
+Example:
+```solara hl_lines="6 9"
+import solara
+
+
+@solara.component
+def ReusableComponent():
+    # color = solara.use_reactive("red")  # instead of use_reactive (not recommended)
+    color, set_color = solara.use_state("red")  # local state
+    solara.Select(label="Color",values=["red", "green", "blue", "orange"],
+                    value=color, on_value=set_color)
+    solara.Markdown("### Solara is awesome", style={"color": color})
+
+
+@solara.component
+def Page():
+    # this component is used twice, but each instance has its own state
+    ReusableComponent()
+    ReusableComponent()
+
+```
+
+## Mutation pittfalls
+
+In Python, strings, numbers, and tuples are immutable. This means that you cannot change the value of a string, number, or tuple in place.
+Instead, you need to create a new object and assign that to a variable.
+
+```python
+a = 1
+b = a
+# a.value = 2  # ERROR: numbers are immutable
+a = 2  # instead, re-assign a new value, the number 1 will not change
+assert b == 1 # b is still 1
+```
+However, many objects in Python are mutable, including lists and dictionaries or potentially user defined classes. This means that you can change the value of a list, dictionary, or user defined class in place without creating a new object.
+```python
+a = [1, 2, 3]
+b = a  # b points to the same list as a
+a.append(4)  # a is now [1, 2, 3, 4]
+assert b == [1, 2, 3, 4]  # b is also [1, 2, 3, 4]
+```
+
+### Not mutating lists
+
+However, mutations in Python are not observable. **This means that if you change the value of a list, dictionary, or user defined class, Solara does not know that the value has changed and does not know it needs to re-render a component that uses that value.**
+
+```python
+import solara
+
+reactive_list = solara.reactive([1, 2, 3])
+# The next line will not trigger a re-render of a component
+reactive_list.value.append(4)  # ERROR: mutating a list is not observable in Python
+```
+
+Although Solara could potentially track mutations of lists and dictionaries, that would be difficult to do for user defined classes, since we would need to know which methods mutate the object and which do not. Therefore, we have chosen not to include
+any magic tracking of mutations in Solara, and instead require you to re-assign a new value to a reactive variable if you want to trigger a re-render.
+
+```python hl_lines="5"
+import solara
+
+reactive_list = solara.reactive([1, 2, 3])
+# Instead, re-assign a new value
+reactive_list.value = [*reactive_list.value, 4]  # GOOD: re-assign a new list
+```
+
+### Not mutating dictionaries
+
+A similar pattern applies to dictionaries.
+
+```python
+import solara
+
+reactive_dict = solara.reactive({"a": 1, "b": 2})
+reactive_dict.value = {**reactive_dict.value, "c": 3}  # GOOD: re-assign a new dictionary
+# deleting a key
+reactive_dict.value = {k: v for k, v in reactive_dict.value.items() if k != "a"}  # GOOD: re-assign a new dictionary
+# deleting a key (method 2)
+dict_copy = reactive_dict.value.copy()
+del dict_copy["b"]
+reactive_dict.value = dict_copy  # GOOD: re-assign a new dictionary
+```
+
+### Not mutating user defined classes
+
+Or user defined classes, like a Pandas DataFrame.
+
+```python
+import solara
+import pandas as pd
+
+reactive_df = solara.reactive(pd.DataFrame({"a": [1, 2, 3], "b": [4, 5, 6]}))
+# reactive_df.value.append({"a": 4, "b": 7})  # BAD: mutating a DataFrame is not observable in Python
+df_copy = reactive_df.value.copy(deep=True)  # for Pandas 3, deep=True is not necessary
+df_copy = df_copy.append({"a": 4, "b": 7}, ignore_index=True)
+reactive_df.value = df_copy  # GOOD: re-assign a new DataFrame
+```
+
+
+## Creating a store
+
+Using reactive variables is a powerful way to manage state in your Solara applications. However, as your application grows, you may find that you need a more structured way to manage your state.
+
+In larger applications, you may want to create a store to manage your application's state. A store is a regular Python class where all attributes are reactive variables.
+
+In your Python class you are free to expose the reactive variables as attributes, or you can create properties to make certain attributes read-only or to add additional logic when setting an attribute.
+
+A complete TODO application demonstrates this below.
+
+```solara
+import uuid
+from typing import Callable
+
+import solara
+
+
+# this todo item is only a collection of reactive values
+class TodoItem:
+    def __init__(self, text: str, done: bool = False):
+        self.text = solara.reactive(text)
+        self.done = solara.reactive(done)
+        self._uuid = solara.reactive(str(uuid.uuid4()))
+        self._dirty = solara.reactive(True)
+
+    def __str__(self) -> str:
+        return f"{self.text.value} ({'done' if self.done else 'not done'})"
+
+
+# However, this class really adds some logic to the todo items
+class TodoStore:
+    def __init__(self, items: list[TodoItem]):
+        # we keep the items as a protected attribute
+        self._items = solara.reactive(items)
+        self.add_item_text = solara.reactive("")
+
+    @property
+    def items(self):
+        # and make the items read only for a property
+        return self._items.value
+
+    def add_item(self, item):
+        self._items.value = [*self._items.value, item]
+        # reset the new text after adding a new item
+        self.add_item_text.value = ""
+
+    def add(self):
+        self.add_item(TodoItem(text=self.add_item_text.value))
+
+    def remove(self, item: TodoItem):
+        self._items.value = [k for k in self.items if k._uuid.value != item._uuid.value]
+
+    @property
+    def done_count(self):
+        return len([k for k in self.items if k.done.value])
+
+    @property
+    def done_percentage(self):
+        if len(self.items) == 0:
+            return 0
+        else:
+            return self.done_count / len(self.items) * 100
+
+
+@solara.component
+def TodoItemCard(item: TodoItem, on_remove: Callable[[TodoItem], None]):
+    with solara.Card():
+        solara.InputText("", value=item.text)
+        solara.Switch(label="Done", value=item.done)
+        solara.Button("Remove", on_click=lambda: on_remove(item))
+
+
+# The TodoApp component is reusable, so in the future
+# we could have multiple TodoApp components if needed
+# (e.g. multiple lists of todos)
+
+default_store = TodoStore(
+    [
+        TodoItem(text="Write a blog post", done=False),
+        TodoItem(text="Take out the trash", done=True),
+        TodoItem(text="Do the laundry", done=False),
+    ]
+)
+
+
+@solara.component
+def TodoApp(store: TodoStore = default_store):
+    for item in store.items:
+        TodoItemCard(item, on_remove=store.remove)
+
+    with solara.Card("New item"):
+        solara.InputText(label="Text", value=store.add_item_text)
+        solara.Button("Add new", on_click=store.add)
+    solara.ProgressLinear(value=store.done_percentage)
+
+
+@solara.component
+def Page():
+    TodoApp()
+```
+
+
+
+
+## Conclusion
+Understanding the advantages and disadvantages of reusable components and application-specific code can help you strike the right balance between modularity and simplicity when building your Solara applications.
+
+By understanding the trade-offs between local and application state, as well as reusable components and application-specific code, you can make better decisions when designing and building your Solara applications. Both approaches have their benefits and drawbacks, but choosing the right method for your specific use case will help you create more efficient, maintainable, and scalable applications.

solara/website/pages/documentation/getting_started/content/07-deploying/00-overview.md

@@ -0,0 +1,7 @@
+---
+title: Overview of how to deploy your Solara application or dashboard
+description: Solara apps can be easily either self hosted, or hosted on a variety of cloud platforms.
+---
+# Deploying a solara app
+
+A Solara app can be [self hosted](/documentation/getting_started/deploying/self-hosted) or [cloud hosted](/documentation/getting_started/deploying/cloud-hosted).