bootstrap

package module
v0.0.0-...-e639397 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 7, 2018 License: MIT Imports: 8 Imported by: 0

README

This package allows you to quickly create a one-window application using astilectron.

Check out the demo to see a working example with the bundler.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Run

func Run(o Options) (err error)

Run runs the bootstrap

func SendMessage

func SendMessage(w *astilectron.Window, name string, payload interface{}, cs ...CallbackMessage) error

SendMessage sends a message

Types

type Asset

type Asset func(name string) ([]byte, error)

Asset is a function that retrieves an asset content namely the go-bindata's Asset method

type CallbackMessage

type CallbackMessage func(m *MessageIn)

CallbackMessage represents a bootstrap message callback

type MessageHandler

type MessageHandler func(a *astilectron.Astilectron, w *astilectron.Window, m MessageIn) (payload interface{}, err error)

MessageHandler is a functions that handles messages

type MessageIn

type MessageIn struct {
	Name    string          `json:"name"`
	Payload json.RawMessage `json:"payload,omitempty"`
}

MessageIn represents a message going in

type MessageOut

type MessageOut struct {
	Name    string      `json:"name"`
	Payload interface{} `json:"payload,omitempty"`
}

MessageOut represents a message going out

type OnWait

OnWait is a function that executes custom actions before waiting

type Options

type Options struct {
	Asset              Asset
	AstilectronOptions astilectron.Options
	Debug              bool
	ResourcesPath      string
	Homepage           string
	MenuOptions        []*astilectron.MenuItemOptions
	MessageHandler     MessageHandler
	OnWait             OnWait
	RestoreAssets      RestoreAssets
	TrayMenuOptions    []*astilectron.MenuItemOptions
	TrayOptions        *astilectron.TrayOptions
	WindowOptions      *astilectron.WindowOptions
}

Options represents options

type RestoreAssets

type RestoreAssets func(dir, name string) error

RestoreAssets is a function that restores assets namely the go-bindata's RestoreAssets method

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL