diagrams

Documentation

Overview

Package diagrams provides template functions for generating diagrams.

Index

• type Namespace
  • func (d *Namespace) Goat(v any) SVGDiagram
• type SVGDiagram

Types

type Namespace

type Namespace struct {
	// contains filtered or unexported fields
}

Namespace provides template functions for the diagrams namespace.

func (*Namespace) Goat

func (d *Namespace) Goat(v any) SVGDiagram

Goat creates a new SVG diagram from input v.

type SVGDiagram

type SVGDiagram interface {
	// Wrapped returns the diagram as an SVG, including the <svg> container.
	Wrapped() template.HTML

	// Inner returns the inner markup of the SVG.
	// This allows for the <svg> container to be created manually.
	Inner() template.HTML

	// Width returns the width of the SVG.
	Width() int

	// Height returns the height of the SVG.
	Height() int
}