aboutdialog

Documentation

Overview

Package aboutdialog provides a menu item element that is used in the header menu of the web UI, to display an "About" dialog.

Index

• func New(entryText, dialog, class string, config map[string]string) Element
• type AboutMenuItemDef
  • func AboutMenuItem(p AboutMenuItemProps) *AboutMenuItemDef
  • func (a *AboutMenuItemDef) Props() AboutMenuItemProps
  • func (a *AboutMenuItemDef) Render() Element
• type AboutMenuItemProps

Functions

func New

func New(entryText, dialog, class string,
	config map[string]string) Element

New returns the menu item element. It should be used as the entry point, to create the needed react element.

config is the web UI config that was fetched from the server.

entryText is the text for this menu item, displayed in the menu.

dialog is the text that appears in the dialog that is created when this menu item is clicked on.

class is the CSS class for this item.

Types

type AboutMenuItemDef

type AboutMenuItemDef struct {
	ComponentDef
}

func AboutMenuItem

func AboutMenuItem(p AboutMenuItemProps) *AboutMenuItemDef

func (*AboutMenuItemDef) Props

func (a *AboutMenuItemDef) Props() AboutMenuItemProps

func (*AboutMenuItemDef) Render

func (a *AboutMenuItemDef) Render() Element

type AboutMenuItemProps

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