Skip to content

Commit

Permalink
missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanalvizo committed Dec 26, 2024
1 parent 4fc622b commit 75f56e6
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 2 deletions.
85 changes: 85 additions & 0 deletions plugins/ui/docs/components/disclosure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Disclosure

A collapsible section of content with a heading that toggles the visibility of a panel.

## Example

```python
from deephaven import ui

my_disclosure_basic = ui.disclosure(title="Heading", panel="Content")
```

## Events

Disclosure accepts an `on_expanded_change` prop which triggers when it is expanded or collapsed.

```python
from deephaven import ui


@ui.component
def ui_toggle_disclosure():
is_expanded, set_is_expanded = ui.use_state(False)

return ui.flex(
ui.disclosure(
title="Heading",
panel="Content",
on_expanded_change=lambda: set_is_expanded(
True if is_expanded == False else False
),
),
ui.text("Expanded" if is_expanded == True else "Collapsed"),
direction="column",
)


my_toggle_disclosure = ui_toggle_disclosure()
```

## Variants

```python
from deephaven import ui


@ui.component
def ui_disclosure_variants():

return [
ui.disclosure("Or", variant="or"),
ui.disclosure("And", variant="and"),
]


my_disclosure_variants = ui_disclosure_variants()
```

## Disabled state

```python
from deephaven import ui

my_disclosure_disabled = ui.disclosure(
title="Heading", panel="Content", is_disabled=True
)
```

## Quiet state

```python
from deephaven import ui

my_disclosure_disabled = ui.disclosure(title="Heading", panel="Content", is_quiet=True)
```

## Expanded state

```python
from deephaven import ui

my_disclosure_disabled = ui.disclosure(
title="Heading", panel="Content", default_expanded=True
)
```
4 changes: 4 additions & 0 deletions plugins/ui/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,10 @@
"label": "dialog_trigger",
"path": "components/dialog_trigger.md"
},
{
"label": "disclosure",
"path": "components/disclosure.md"
},
{
"label": "flex",
"path": "components/flex.md"
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/disclosure.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from .basic import component_element
from ..elements import Element

# TODO: create disclosure_title and disclosure_panel

def disclosure(
title: Any,
panel: Any,
Expand Down
2 changes: 1 addition & 1 deletion plugins/ui/src/deephaven/ui/components/disclosure_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
JustifySelf,
LayoutFlex,
Position,
HeadingLevel,
)
from .basic import component_element
from ..elements import Element
Expand Down Expand Up @@ -117,6 +116,7 @@ def disclosure_panel(
"""
return component_element(
"DisclosurePanel",
*children,
flex=flex,
flex_grow=flex_grow,
flex_shrink=flex_shrink,
Expand Down

0 comments on commit 75f56e6

Please sign in to comment.