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

fix: contextual_help uses heading, content, footer props #945

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

wusteven815
Copy link
Contributor

@wusteven815 wusteven815 commented Oct 18, 2024

BREAKING CHANGE: ui.contextual_help's signature replaces the *children prop with heading, content, and footer props, in that order. In parity with React Spectrum docs, the heading and content props are required and footer is optional.

Here are some examples of usages and how they might change:

# This is still valid
old = ui.contextual_help(
    ui.heading("My Heading"),
    ui.content("My content"),
    ui.footer("My footer")
)
# This is invalid
old = ui.contextual_help(ui.content("My content"))
# You must explicitly set heading to None
new = ui.contextual_help(ui.content(None, "My content"))

@wusteven815 wusteven815 self-assigned this Oct 18, 2024
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.

ui.contextual_help content not rendering properly
1 participant