Skip to content

Commit

Permalink
Adding documentation to details component (#644)
Browse files Browse the repository at this point in the history
* Commiting the changes after the updates

* Fixing the render line

* incorporate suggestions from code review

* docs: create docs page for details component

---------

Co-authored-by: Iisakki Rotko <iisakki.rotko@gmail.com>
  • Loading branch information
mikegiann01 and iisakkirotko committed Jun 6, 2024
1 parent 2c959a0 commit df5ef37
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
35 changes: 35 additions & 0 deletions solara/components/details.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,41 @@

@solara.component
def Details(summary="Summary", children=[], expand=False):
"""Creates an expandable/collapsible section with a summary and additional children content
```solara
import solara
show_message = solara.reactive(True)
disable = solara.reactive(False)
@solara.component
def Page():
summary_text = "Click to expand for more details"
additional_content = [
"Additional detail 1",
"Additional detail 2",
"Additional detail 3"
]
solara.Details(
summary=summary_text,
children=additional_content,
expand=False
)
```
## Arguments:
* summary: String showing the summary text for the expandable section: Defaults "Summary"
* children: List showing the children content of the expandable section: Defaults to an Empty list
* expand: Boolean showing if the section is expanded or collapsed: Defaults to False
"""

expand, set_expand = solara.use_state_or_update(expand)

def on_v_model(v_model):
Expand Down
13 changes: 13 additions & 0 deletions solara/website/pages/documentation/components/layout/details.py
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit df5ef37

Please sign in to comment.