Browse Source

Correct supported types in docs for modal components

pull/10307/head
Soheab_ 4 weeks ago
parent
commit
cdebeefb28
  1. 1
      discord/components.py
  2. 7
      discord/ui/label.py
  3. 3
      discord/ui/text_display.py
  4. 2
      discord/ui/text_input.py

1
discord/components.py

@ -133,6 +133,7 @@ class Component:
- :class:`FileComponent`
- :class:`SeparatorComponent`
- :class:`Container`
- :class:`LabelComponent`
- :class:`FileUploadComponent`
This class is abstract and cannot be instantiated.

7
discord/ui/label.py

@ -50,6 +50,8 @@ V = TypeVar('V', bound='BaseView', covariant=True)
class Label(Item[V]):
"""Represents a UI label within a modal.
This is a top-level layout component that can only be used on :class:`Modal`.
.. versionadded:: 2.6
Parameters
@ -60,7 +62,7 @@ class Label(Item[V]):
description: Optional[:class:`str`]
The description text to display right below the label text.
Can only be up to 100 characters.
component: Union[:class:`discord.ui.TextInput`, :class:`discord.ui.Select`]
component: :class:`Item`
The component to display below the label.
id: Optional[:class:`int`]
The ID of the component. This must be unique across the view.
@ -74,8 +76,7 @@ class Label(Item[V]):
The description text to display right below the label text.
Can only be up to 100 characters.
component: :class:`Item`
The component to display below the label. Currently only
supports :class:`TextInput` and :class:`Select`.
The component to display below the label.
"""
__item_repr_attributes__: Tuple[str, ...] = (

3
discord/ui/text_display.py

@ -43,7 +43,8 @@ __all__ = ('TextDisplay',)
class TextDisplay(Item[V]):
"""Represents a UI text display.
This is a top-level layout component that can only be used on :class:`LayoutView` or :class:`Section`.
This is a top-level layout component that can only be used on :class:`LayoutView`,
:class:`Section`, :class:`Container`, or :class:`Modal`.
.. versionadded:: 2.6

2
discord/ui/text_input.py

@ -53,6 +53,8 @@ V = TypeVar('V', bound='BaseView', covariant=True)
class TextInput(Item[V]):
"""Represents a UI text input.
This a top-level layout component that can only be used in :class:`Label`.
.. container:: operations
.. describe:: str(x)

Loading…
Cancel
Save