stories

README

stories

Package stories is an interface for registering and viewing stories. Stories are predefined configurations of cy's UI components that may also describe a sequence of user inputs that are "played" into the story after it is loaded. This is similar to Storybook.

Documentation

Index

• Constants
• Variables
• func Register(name string, init InitFunc, config Config)
• func Send(s mux.Screen, msgs ...interface{})
• func Type(msgs ...string) (result []interface{})
• type Config
  • func (c *Config) HasInputs() bool
• type InitFunc
• type Story
• type WaitEvent
  • func Wait(duration time.Duration) WaitEvent

Constants

const (
	ABit = 300 * time.Millisecond
	Some = time.Second
	More = 3 * time.Second
	ALot = 5 * time.Second
)

const TYPE_DELAY = 100 * time.Millisecond

Variables

var Stories = make(map[string]Story)

Functions

func Register

func Register(name string, init InitFunc, config Config)

func Send

func Send(s mux.Screen, msgs ...interface{})

func Type

func Type(msgs ...string) (result []interface{})

Simulate typing.

Types

type Config

type Config struct {
	// If zero, the story will resize
	Size geom.Size
	// If true, the viewer captures the screen immediately and uses that
	// instead of a live view.
	IsSnapshot bool
	// A list of inputs that will be executed in order when the story
	// begins.
	Input []interface{}
}

func (*Config) HasInputs

func (c *Config) HasInputs() bool

type InitFunc

type InitFunc func(context.Context) (mux.Screen, error)

type Story

type Story struct {
	Name   string
	Init   InitFunc
	Config Config
}

type WaitEvent

type WaitEvent struct {
	Duration time.Duration
}

func Wait

func Wait(duration time.Duration) WaitEvent