web

package

v0.25.0 Latest Latest Go to latest Published: Mar 25, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getzep/zep

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CodeHighlight(code string, lexer string) (string, error)
func HTMLEscapeMap(data map[string]interface{}) map[string]interface{}
func HTMLEscapeStruct(data interface{}) interface{}
func JSONSerializeHTML(data map[string]interface{}) (template.HTML, error)
func TemplateFuncs() template.FuncMap
type BreadCrumb
type Column
type CustomPreWrapper
- func (p *CustomPreWrapper) End(code bool) string
- func (p *CustomPreWrapper) Start(code bool, _ string) string
type ExternalPage
type MenuItem
type Page
- func NewPage(title, subTitle, path string, templates []string, breadCrumbs []BreadCrumb, ...) *Page
- func (p *Page) Render(w http.ResponseWriter, r *http.Request)
type Table
- func NewTable(id string, columns []Column) *Table

Constants ¶

View Source

const AdminPath = "/admin"

View Source

const CollectionsIcon = `` /* 545-byte string literal not displayed */

View Source

const DashboardIcon = `` /* 466-byte string literal not displayed */

View Source

const DefaultPageSize = 10

View Source

const DefaultSortAsc = false

View Source

const DefaultSortKey = "created_at"

View Source

const DocsIcon = `` /* 781-byte string literal not displayed */

View Source

const SessionsIcon = `` /* 630-byte string literal not displayed */

View Source

const SettingsIcon = `` /* 1568-byte string literal not displayed */

View Source

const UsersIcon = `` /* 771-byte string literal not displayed */

Variables ¶

View Source

var ExternalPages = map[string]ExternalPage{
	"website": {
		Title: "Website",
		URL:   "https://getzep.com",
	},
	"docs": {
		Title: "Documentation",
		URL:   "https://docs.getzep.com",
	},
	"github": {
		Title: "GitHub",
		URL:   "https://github.com/getzep/zep",
	},
}

View Source

var LayoutTemplates = []string{
	"templates/pages/index.html",
	"templates/components/layout/*.html",
	"templates/components/content/*.html",
}

View Source

var StaticFS embed.FS

View Source

var TemplatesFS embed.FS

Functions ¶

func CodeHighlight ¶

func CodeHighlight(code string, lexer string) (string, error)

CodeHighlight takes a string of code and a lexer name and returns a highlighted HTML string.

func HTMLEscapeMap ¶

func HTMLEscapeMap(data map[string]interface{}) map[string]interface{}

HTMLEscapeMap recursively walks a map and HTML escapes any string fields

func HTMLEscapeStruct ¶

func HTMLEscapeStruct(data interface{}) interface{}

HTMLEscapeStruct recursively walks a struct and any child structs and HTML escapes any string fields

func JSONSerializeHTML ¶

func JSONSerializeHTML(data map[string]interface{}) (template.HTML, error)

JSONSerializeHTML serializes a map to a JSON string and outputs as HTML

func TemplateFuncs ¶

func TemplateFuncs() template.FuncMap

Types ¶

type BreadCrumb struct {
	Title string
	Path  string
}

type Column ¶

type Column struct {
	Name       string
	Sortable   bool
	OrderByKey string
}

type CustomPreWrapper ¶

type CustomPreWrapper struct{}

func (*CustomPreWrapper) End ¶

func (p *CustomPreWrapper) End(code bool) string

End is called to write the end </pre> element.

func (*CustomPreWrapper) Start ¶

func (p *CustomPreWrapper) Start(code bool, _ string) string

Start is called to write a start <pre> element. The code flag tells whether this block surrounds highlighted code. This will be false when surrounding line numbers.

type ExternalPage ¶

type ExternalPage struct {
	Title string
	URL   string
}

type MenuItem ¶

type MenuItem struct {
	Name      string
	Path      string
	External  bool
	Icon      template.HTML // SVG icon as a string
	ContentID string
}

type Page ¶

type Page struct {
	Title       string
	SubTitle    string
	MenuItems   []MenuItem
	Templates   []string
	Path        string
	Slug        string
	BreadCrumbs []BreadCrumb
	Data        interface{}
}

func NewPage ¶

func NewPage(
	title, subTitle, path string,
	templates []string,
	breadCrumbs []BreadCrumb,
	data interface{},
) *Page

func (*Page) Render ¶

func (p *Page) Render(w http.ResponseWriter, r *http.Request)

type Table ¶

type Table struct {
	TableID     string
	Columns     []Column
	Rows        interface{}
	TotalCount  int
	RowCount    int
	Offset      int
	CurrentPage int
	PageSize    int
	PageCount   int
	OrderBy     string
	Asc         bool
}

func NewTable ¶

func NewTable(id string, columns []Column) *Table

func (*Table) GetAsc ¶

func (t *Table) GetAsc() bool

func (*Table) GetOffset ¶

func (t *Table) GetOffset() int

func (*Table) GetOrderBy ¶

func (t *Table) GetOrderBy() string

func (*Table) GetPageCount ¶

func (t *Table) GetPageCount() int

func (*Table) GetPageSize ¶

func (t *Table) GetPageSize() int

func (*Table) GetTablePath ¶

func (t *Table) GetTablePath(basePath string) string

func (*Table) ParseQueryParams ¶

func (t *Table) ParseQueryParams(r *http.Request)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func CodeHighlight ¶

func HTMLEscapeMap ¶

func HTMLEscapeStruct ¶

func JSONSerializeHTML ¶

func TemplateFuncs ¶

Types ¶

type BreadCrumb ¶

type Column ¶

type CustomPreWrapper ¶

func (*CustomPreWrapper) End ¶

func (*CustomPreWrapper) Start ¶

type ExternalPage ¶

type MenuItem ¶

type Page ¶

func NewPage ¶

func (*Page) Render ¶

type Table ¶

func NewTable ¶

func (*Table) GetAsc ¶

func (*Table) GetOffset ¶

func (*Table) GetOrderBy ¶

func (*Table) GetPageCount ¶

func (*Table) GetPageSize ¶

func (*Table) GetTablePath ¶

func (*Table) ParseQueryParams ¶

Source Files ¶