Methods
-
<static> showUserPopout( target, user [, options ] )
-
Description
Shows the user popout for a user relative to a target element
Parameters
Name Type Attributes Description target
HTMLElement Element to show the popout in relation to
user
object Discord User object for the user to show
options
object <optional> Options to modify the request
Name Type Attributes Default Description guild
string <optional> "currentGuildId" Id of the guild (uses current if not specified)
channel
string <optional> "currentChannelId" Id of the channel (uses current if not specified)
position
string <optional> "right" Positioning relative to element
align
string <optional> "top" Positioning relative to element
Details
-
<static> openPopout( target [, options ] )
-
Description
Shows a react popout relative to a target element
Parameters
Name Type Attributes Description target
HTMLElement Element to show the popout in relation to
options
object <optional> Options to modify the request
Name Type Attributes Default Description position
string <optional> "right" General position relative to element
align
string <optional> "top" Alignment relative to element
animation
Popouts.AnimationTypes <optional> Popouts.AnimationTypes.TRANSLATE Animation type to use
autoInvert
boolean <optional> true Try to automatically adjust the position if it overflows the screen
nudgeAlignIntoViewport
boolean <optional> true Try to automatically adjust the alignment if it overflows the screen
spacing
number <optional> 8 Spacing between target and popout
Details