Button¶
- class praw.models.Button(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])¶
Class to represent a single button inside a
ButtonWidget
.Typical Attributes
This table describes attributes that typically belong to objects of this class. Since attributes are dynamically provided (see Determine Available Attributes of an Object), there is not a guarantee that these attributes will always be present, nor is this list necessarily complete.
Attribute
Description
color
The hex color used to outline the button.
fillColor
The hex color for the background of the button.
height
Image height. Only present on image buttons.
hoverState
A
dict
describing the state of the button when hovered over. Optional.kind
Either
"text"
or"image"
.linkUrl
A link that can be visited by clicking the button. Only present on image buttons.
text
The text displayed on the button.
textColor
The hex color for the text of the button.
url
If the button is a text button, a link that can be visited by clicking the button.
If the button is an image button, the URL of a Reddit-hosted image.
width
Image width. Only present on image buttons.
- __init__(reddit: praw.Reddit, _data: Optional[Dict[str, Any]])¶
Initialize a PRAWModel instance.
- Parameters
reddit – An instance of
Reddit
.
- classmethod parse(data: Dict[str, Any], reddit: praw.Reddit) Any ¶
Return an instance of
cls
fromdata
.- Parameters
data – The structured data.
reddit – An instance of
Reddit
.