manifest

README

manifest

Utilities for dealing with web manifests.

Style

Please take a look at the style guidelines if you'd like to make a pull request.

Sponsors

Cedric Fung	Scott Rayapoullé	Eduard Urbach

Want to see your own name here?

Documentation

Index

• type Icon
• type Manifest
  • func FromFile(fileName string) (*Manifest, error)
  • func New() *Manifest
• type ScreenShot
• type ServiceWorker

Types

type Icon

type Icon struct {
	Source string `json:"src"`
	Sizes  string `json:"sizes"`
	Type   string `json:"type,omitempty"`
}

Icon represents a single icon in the web manifest.

type Manifest

type Manifest struct {
	Name            string         `json:"name"`
	ShortName       string         `json:"short_name"`
	Description     string         `json:"description,omitempty"`
	Icons           []Icon         `json:"icons,omitempty"`
	StartURL        string         `json:"start_url"`
	Display         string         `json:"display"`
	Orientation     string         `json:"orientation,omitempty"`
	Language        string         `json:"lang,omitempty"`
	ThemeColor      string         `json:"theme_color,omitempty"`
	BackgroundColor string         `json:"background_color,omitempty"`
	TextDirection   string         `json:"dir,omitempty"`
	ServiceWorker   *ServiceWorker `json:"serviceworker,omitempty"`
	ScreenShots     []ScreenShot   `json:"screenshots,omitempty"`
}

Manifest represents a web manifest

func FromFile

func FromFile(fileName string) (*Manifest, error)

FromFile creates a new manifest.

func New

func New() *Manifest

New creates a new manifest.

type ScreenShot

type ScreenShot = Icon

ScreenShot represents a screenshot definition in the web manifest.

type ServiceWorker

type ServiceWorker struct {
	Source         string `json:"src"`
	Scope          string `json:"scope"`
	UpdateViaCache string `json:"update_via_cache"`
}

ServiceWorker represents a service worker definition in the web manifest.