Skip to content

Commit

Permalink
docs improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ericlln committed Jan 31, 2025
1 parent 8239d57 commit e5b43e9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 17 deletions.
2 changes: 1 addition & 1 deletion plugins/ui/docs/components/contextual_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ from deephaven import ui
my_contextual_help_basic = ui.contextual_help(
heading="Need Help",
content="If you are having issues accessing your account, contact our customer support team for help.",
variant="info",
footer=ui.link("Download support logs"),
variant="info",
)
```

Expand Down
17 changes: 1 addition & 16 deletions plugins/ui/docs/components/footer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,7 @@ The footer component represents a footer that inherits styling from its parent c

## Slots

`ui.footer` is intended to be used in container components with layouts that provide a slot for `ui.footer` (and other supported elements). These components handle the layout and styling of such elements for you. See [`ui.dialog`](./dialog.md#content) and [`ui.contextual_help`](./contextual_help#example) for more detailed examples.

```python
from deephaven import ui


my_footer_order_example = ui.dialog(
ui.heading("Customer Support Request"),
ui.content(
"We have received your support request and are currently reviewing it. Our team will get back to you soon."
),
ui.footer(
"Ticket ID: #123456 | Status: In Progress | Support email: [email protected]"
),
)
```
`ui.footer` is intended to be used in container components with layouts that provide a slot for `ui.footer` (and other supported elements). These components handle the layout and styling of such elements for you. See [`ui.dialog`](./dialog.md#content) and [`ui.contextual_help`](./contextual_help#example) for examples of a footer used in the context of a container.

## API reference

Expand Down

0 comments on commit e5b43e9

Please sign in to comment.