Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ui.footer #1100

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: ui.footer #1100

wants to merge 5 commits into from

Conversation

ericlln
Copy link
Contributor

@ericlln ericlln commented Jan 29, 2025

Closes #878

@ericlln ericlln requested a review from mofojed January 29, 2025 21:08
@ericlln ericlln self-assigned this Jan 29, 2025
@ericlln ericlln marked this pull request as ready for review January 30, 2025 23:20
Comment on lines 16 to 17
variant="info",
footer=ui.link("Download support logs"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd group the footer together with the heading/content, rather than having the variant in the middle.

Suggested change
variant="info",
footer=ui.link("Download support logs"),
footer=ui.link("Download support logs"),
variant="info",


## 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`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.
`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.

Comment on lines 21 to 34
```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]"
),
)
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example is weird, because we're not using a dialog like a dialog (triggering it and opening it), it's just appearing in a panel.
I'd just get rid of this example, it's fine to refer to Dialog/ContextualHelp for other examples.

Suggested change
```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]"
),
)
```

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: ui.footer
2 participants