update docstrings for Dialog components (#2608)

This commit is contained in:
Thomas Brandého 2024-02-14 19:29:09 +01:00 committed by GitHub
parent eadbf1d3db
commit 4232767b69
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,4 +1,5 @@
"""Interactive components provided by @radix-ui/themes.""" """Interactive components provided by @radix-ui/themes."""
from types import SimpleNamespace from types import SimpleNamespace
from typing import Any, Dict, Literal from typing import Any, Dict, Literal
@ -12,7 +13,7 @@ from ..base import (
class DialogRoot(RadixThemesComponent): class DialogRoot(RadixThemesComponent):
"""Trigger an action or event, such as submitting a form or displaying a dialog.""" """Root component for Dialog."""
tag = "Dialog.Root" tag = "Dialog.Root"
@ -32,19 +33,19 @@ class DialogRoot(RadixThemesComponent):
class DialogTrigger(RadixThemesComponent): class DialogTrigger(RadixThemesComponent):
"""Trigger an action or event, such as submitting a form or displaying a dialog.""" """Trigger an action or event, to open a Dialog modal."""
tag = "Dialog.Trigger" tag = "Dialog.Trigger"
class DialogTitle(RadixThemesComponent): class DialogTitle(RadixThemesComponent):
"""Trigger an action or event, such as submitting a form or displaying a dialog.""" """Title component to display inside a Dialog modal."""
tag = "Dialog.Title" tag = "Dialog.Title"
class DialogContent(el.Div, RadixThemesComponent): class DialogContent(el.Div, RadixThemesComponent):
"""Trigger an action or event, such as submitting a form or displaying a dialog.""" """Content component to display inside a Dialog modal."""
tag = "Dialog.Content" tag = "Dialog.Content"
@ -68,13 +69,13 @@ class DialogContent(el.Div, RadixThemesComponent):
class DialogDescription(RadixThemesComponent): class DialogDescription(RadixThemesComponent):
"""Trigger an action or event, such as submitting a form or displaying a dialog.""" """Description component to display inside a Dialog modal."""
tag = "Dialog.Description" tag = "Dialog.Description"
class DialogClose(RadixThemesComponent): class DialogClose(RadixThemesComponent):
"""Trigger an action or event, such as submitting a form or displaying a dialog.""" """Close button component to close an open Dialog modal."""
tag = "Dialog.Close" tag = "Dialog.Close"