modules

Documentation

Index

• type ConfigItem
• type ConfigWidgetGenerator
• type Constructor
• type State

Types

type ConfigItem

type ConfigItem struct {
	// The constructor function for the configuration item's widget.
	Constructor ConfigWidgetGenerator
	// Name is the name of this config item and will be displayed in the UI.
	Name string
}

ConfigItem describes a configuration item of a module. An instance can be generated with the contained generator.

This type is used by code autogenerated with qs-build.

type ConfigWidgetGenerator

type ConfigWidgetGenerator func(ctx server.Context) config.Widget

ConfigWidgetGenerator generates a config item's UI widget.

type Constructor

type Constructor func(data json.RawMessage, server web.Server) (State, error)

Constructor is a function that constructs a state from given JSON input and server/group environment.

type State

type State interface {
	askew.Component
}

State represents the module's state. A State acts independently, communicating with the server on its own to communicate changes. the only interface to the main application is the generation of its user interface that will be placed onto the state page.