layouts

Documentation

Overview

Package layouts lists all the broker UI layouts we support.

Index

• Constants
• Variables
• func OptionalItems(items ...string) string
• func ParseItems(items string) (string, []string)
• func RequiredItems(items ...string) string

Constants

const (
	// Form is the layout used by input forms UI layouts.
	Form = "form"
	// QrCode is the layout used by device authentication UI layouts.
	QrCode = "qrcode"
	// NewPassword the layout used by new password UI layouts.
	NewPassword = "newpassword"
)

const (
	// Required indicates that a layout item is required.
	Required = "required"
	// Optional indicates that a layout item is optional.
	Optional = "optional"
)

const (
	// True is a true boolean parameter for a layout.
	True = "true"
	// False is a false boolean parameter for a layout.
	False = "false"
)

const (
	// ID is the key for the layout id.
	ID = "id"
	// Type is the key for the layout type.
	Type = "type"
	// Label is the key for the layout label.
	Label = "label"
	// Entry is the key for the layout entry.
	Entry = "entry"
	// Button is the key for the layout button.
	Button = "button"
	// Wait is the key for the layout wait.
	Wait = "wait"
	// Content is the key for the layout content.
	Content = "content"
	// Code is the key for the layout code.
	Code = "code"
	// RendersQrCode is the key for the layout renders qrcode.
	RendersQrCode = "renders_qrcode"
)

Variables

var (
	// RequiredWithBooleans indicates that a layout item is required with boolean values.
	RequiredWithBooleans = RequiredItems(True, False)
	// OptionalWithBooleans indicates that a layout item is optional with boolean values.
	OptionalWithBooleans = OptionalItems(True, False)
)

Functions

func OptionalItems

func OptionalItems(items ...string) string

OptionalItems returns a formatted string of required entries.

func ParseItems

func ParseItems(items string) (string, []string)

ParseItems parses a string of items and returns its type and the list of items it contains.

func RequiredItems

func RequiredItems(items ...string) string

RequiredItems returns a formatted string of required entries.