Categorygithub.com/necroforger/dgwidgets
modulepackage
0.0.0-20190131052008-56c8c1ca33e0
Repository: https://github.com/necroforger/dgwidgets.git
Documentation: pkg.go.dev

# README

dg-widgets

Make widgets with embeds and reactions

img

Example usage

func (s *discordgo.Session, m *discordgo.Message) {
	p := dgwidgets.NewPaginator(s, m.ChannelID)

	// Add embed pages to paginator
	p.Add(&discordgo.MessageEmbed{Description: "Page one"}, 
		  &discordgo.MessageEmbed{Description: "Page two"},
		  &discordgo.MessageEmbed{Description: "Page three"})

	// Sets the footers of all added pages to their page numbers.
	p.SetPageFooters()

	// When the paginator is done listening set the colour to yellow
	p.ColourWhenDone = 0xffff

	// Stop listening for reaction events after five minutes
	p.Widget.Timeout = time.Minute * 5

	// Add a custom handler for the gun reaction.
	p.Widget.Handle("🔫", func(w *dgwidgets.Widget, r *discordgo.MessageReaction) {
		s.ChannelMessageSend(m.ChannelID, "Bang!")
	})

	p.Spawn()
}

# Functions

EmbedsFromString splits a string into a slice of MessageEmbeds.
NewPaginator returns a new Paginator ses : discordgo session channelID: channelID to spawn the paginator on.
NewWidget returns a pointer to a Widget object ses : discordgo session channelID: channelID to spawn the widget on.

# Constants

emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.
emoji constants.

# Variables

error vars.
error vars.
error vars.
error vars.
error vars.

# Structs

Paginator provides a method for creating a navigatable embed.
Widget is a message embed with reactions for buttons.

# Type aliases

WidgetHandler ...