progress

Documentation

Index

• Constants
• type Api
• type Circular
  • func NewCircular(id string, size int) *Circular
  • func (c *Circular) Close()
  • func (c *Circular) Colors(colors [4]string) *Circular
  • func (c *Circular) Determinate(d bool)
  • func (c *Circular) DeterminateSVG() string
  • func (c *Circular) IndeterminateCircleGraphicSVG(ratio float64, color string) string
  • func (c *Circular) Label(label string) *Circular
  • func (c *Circular) OnMount(ctx app.Context)
  • func (c *Circular) Open()
  • func (c *Circular) Render() app.UI
  • func (c *Circular) SetProgress(f float64)
  • func (c *Circular) WithOnMount(cb func(ctx app.Context)) *Circular
• type Linear
  • func NewLinear(id string) *Linear
  • func (b *Linear) Close()
  • func (b *Linear) Determinate(d bool)
  • func (b *Linear) Label(label string) *Linear
  • func (b *Linear) OnMount(ctx app.Context)
  • func (b *Linear) Open()
  • func (b *Linear) Render() app.UI
  • func (b *Linear) SetProgress(f float64)
  • func (b *Linear) WithOnMount(cb func(ctx app.Context)) *Linear

Examples

• NewCircular
• NewLinear

Constants

const RadiusRatio = float64(18) / float64(48)

const WidthRatio = float64(4) / float64(48)

const WidthRatioSmall = float64(3.2) / float64(48)

Types

type Api

type Api interface {
	Determinate(bool)
	Open()
	Close()
	SetProgress(float64)
}

Api defines the common api between circular and linear progress components.

type Circular

type Circular struct {
	app.Compo
	base.JsUtil
	// contains filtered or unexported fields
}

func NewCircular

func NewCircular(id string, size int) *Circular

Example

circular := NewCircular("largeCircularProgress", 48)
circular.WithOnMount(func(ctx app.Context) {
	ctx.Async(func() {
		circular.Determinate(true)
		circular.Open()
		for {
			var p float64
			for p = 0; p < 1; p += 0.01 {
				circular.SetProgress(p)
				time.Sleep(40 * time.Millisecond)
			}
			circular.SetProgress(1)
		}
	})
})

func (*Circular) Close

func (c *Circular) Close()

func (*Circular) Colors

func (c *Circular) Colors(colors [4]string) *Circular

func (*Circular) Determinate

func (c *Circular) Determinate(d bool)

func (*Circular) DeterminateSVG

func (c *Circular) DeterminateSVG() string

func (*Circular) IndeterminateCircleGraphicSVG

func (c *Circular) IndeterminateCircleGraphicSVG(ratio float64, color string) string

func (*Circular) Label

func (c *Circular) Label(label string) *Circular

func (*Circular) OnMount

func (c *Circular) OnMount(ctx app.Context)

func (*Circular) Open

func (c *Circular) Open()

func (*Circular) Render

func (c *Circular) Render() app.UI

func (*Circular) SetProgress

func (c *Circular) SetProgress(f float64)

func (*Circular) WithOnMount

func (c *Circular) WithOnMount(cb func(ctx app.Context)) *Circular

type Linear

type Linear struct {
	app.Compo
	base.JsUtil
	// contains filtered or unexported fields
}

func NewLinear

func NewLinear(id string) *Linear

Example

bar := NewLinear("linearProgress")
bar.WithOnMount(func(ctx app.Context) {
	ctx.Async(func() {
		bar.Open()
		//bar.Determinate(false)
		var p float64
		for p = 0; p < 1; p += 0.01 {
			bar.SetProgress(p)
			time.Sleep(40 * time.Millisecond)
		}
		bar.SetProgress(1)
		time.Sleep(1500 * time.Millisecond)
		bar.Close()
	})
})

func (*Linear) Close

func (b *Linear) Close()

func (*Linear) Determinate

func (b *Linear) Determinate(d bool)

func (*Linear) Label

func (b *Linear) Label(label string) *Linear

func (*Linear) OnMount

func (b *Linear) OnMount(ctx app.Context)

func (*Linear) Open

func (b *Linear) Open()

func (*Linear) Render

func (b *Linear) Render() app.UI

func (*Linear) SetProgress

func (b *Linear) SetProgress(f float64)

func (*Linear) WithOnMount

func (b *Linear) WithOnMount(cb func(ctx app.Context)) *Linear