figo

README

Figo

Figma Golang utility lib. This is a tool to help creating HTML and CSS from Figma designs. It does not generate clean HTML or CSS, user input/changes are still necessary for building the desired frontend.

Tokens

Create css variables based on figma tokens. Figma variables can't be converted to css tokens without enterprise account to be able to use the REST API for Variables.

CSS

Export components styles to help frontends creation, it can have repetition depending of how components are built in Figma, use the export as a helper or a guide to accelerate development.

HTML

Export components HTML to help frontends creation, the HTML generated gives a base structure for the component created in Figma.

Run tests

go test github.com/vpaulo/figo/figma

Documentation

Index

• type Figma
  • func (f *Figma) ComponentCSS(component fg.Element) (string, error)
  • func (f *Figma) ComponentHTML(component fg.Element) (string, error)
  • func (f *Figma) GenerateComponentCSS(component fg.Element) (string, error)
  • func (f *Figma) GenerateComponentHTML(component fg.Element) (string, error)
  • func (f *Figma) GenerateComponentsCSS(components map[string]fg.Element) (string, error)
  • func (f *Figma) GenerateComponentsHTML(components map[string]fg.Element) (string, error)
  • func (f *Figma) GenerateTokensCSS(tokens map[string]figma.Token) (string, error)
  • func (f *Figma) GetData() (figma.File, error)
  • func (f *Figma) GetDataFromFile(path string) (figma.File, error)
  • func (f *Figma) GetVariablesData() (figma.Variables, error)
  • func (f *Figma) GetVariablesFromFile(path string) (figma.Variables, error)
  • func (f *Figma) Pages(file figma.File) []figma.Node
  • func (f *Figma) ParseComponents(file figma.File, tokens map[string]figma.Token) map[string]fg.Element
  • func (f *Figma) ParseTokens(file figma.File) map[string]figma.Token
  • func (f *Figma) ParseVariables(variables figma.Variables) map[string]figma.Token

Types

type Figma

type Figma struct {
	FILE_KEY string
	API_KEY  string
	Prefix   string // Prefix for components tag
}

func (*Figma) ComponentCSS

func (f *Figma) ComponentCSS(component fg.Element) (string, error)

func (*Figma) ComponentHTML

func (f *Figma) ComponentHTML(component fg.Element) (string, error)

func (*Figma) GenerateComponentCSS

func (f *Figma) GenerateComponentCSS(component fg.Element) (string, error)

func (*Figma) GenerateComponentHTML

func (f *Figma) GenerateComponentHTML(component fg.Element) (string, error)

func (*Figma) GenerateComponentsCSS

func (f *Figma) GenerateComponentsCSS(components map[string]fg.Element) (string, error)

func (*Figma) GenerateComponentsHTML

func (f *Figma) GenerateComponentsHTML(components map[string]fg.Element) (string, error)

func (*Figma) GenerateTokensCSS

func (f *Figma) GenerateTokensCSS(tokens map[string]figma.Token) (string, error)

func (*Figma) GetData

func (f *Figma) GetData() (figma.File, error)

func (*Figma) GetDataFromFile

func (f *Figma) GetDataFromFile(path string) (figma.File, error)

func (*Figma) GetVariablesData

func (f *Figma) GetVariablesData() (figma.Variables, error)

func (*Figma) GetVariablesFromFile

func (f *Figma) GetVariablesFromFile(path string) (figma.Variables, error)

func (*Figma) Pages

func (f *Figma) Pages(file figma.File) []figma.Node

func (*Figma) ParseComponents

func (f *Figma) ParseComponents(file figma.File, tokens map[string]figma.Token) map[string]fg.Element

func (*Figma) ParseTokens

func (f *Figma) ParseTokens(file figma.File) map[string]figma.Token

func (*Figma) ParseVariables

func (f *Figma) ParseVariables(variables figma.Variables) map[string]figma.Token