component

Documentation

Index

• Constants
• type BaseInfo
• type Content
  • func NewContent() *Content
  • func (c *Content) HandleDatabaseSelection(ctx context.Context, db, coll string) error
  • func (c *Content) Render(setFocus bool)
  • func (c *Content) UpdateDao(dao *mongo.Dao)
• type Database
  • func NewDatabase() *Database
  • func (d *Database) Render()
  • func (d *Database) SetSelectFunc(f func(ctx context.Context, db string, coll string) error)
• type DatabaseTree
  • func NewDatabaseTree() *DatabaseTree
  • func (t *DatabaseTree) RefreshStyle()
  • func (t *DatabaseTree) Render(ctx context.Context, dbsWitColls []mongo.DBsWithCollections, expand bool)
  • func (t *DatabaseTree) SetSelectFunc(f func(ctx context.Context, db string, coll string) error)
• type DocModifier
  • func NewDocModifier() *DocModifier
  • func (d *DocModifier) Duplicate(ctx context.Context, db, coll string, rawDocument string) (primitive.ObjectID, error)
  • func (d *DocModifier) Edit(ctx context.Context, db, coll string, _id interface{}, jsonDoc string) (string, error)
  • func (d *DocModifier) Insert(ctx context.Context, db, coll string) (primitive.ObjectID, error)
• type Header
  • func NewHeader() *Header
  • func (h *Header) Render()
  • func (h *Header) SetBaseInfo() BaseInfo
  • func (h *Header) UpdateKeys() ([]config.Key, error)
• type InputBar
  • func NewInputBar(barId tview.Identifier, label string) *InputBar
  • func (i *InputBar) DoneFuncHandler(accept func(string), reject func())
  • func (i *InputBar) EnableAutocomplete()
  • func (i *InputBar) EnableHistory()
  • func (i *InputBar) LoadNewKeys(keys []string)
  • func (i *InputBar) SetDefaultText(text string)
  • func (i *InputBar) Toggle(text string)
• type Peeker
  • func NewPeeker() *Peeker
  • func (p *Peeker) MoveToBottom()
  • func (p *Peeker) MoveToTop()
  • func (p *Peeker) Render(ctx context.Context, state *mongo.CollectionState, _id interface{}) error
  • func (p *Peeker) SetDoneFunc(doneFunc func())
• type ViewType

Constants

const (
	ContentComponent   = "Content"
	JsonViewComponent  = "JsonView"
	QueryBarComponent  = "QueryBar"
	SortBarComponent   = "SortBar"
	ContentDeleteModal = "ContentDeleteModal"
)

const (
	DatabaseComponent = "Database"
	FilterBarView     = "FilterBar"
)

const (
	InputModalView        = "InputModal"
	ConfirmModalView      = "ConfirmModal"
	DatabaseTreeComponent = "DatabaseTree"
	DatabaseDeleteModal   = "DatabaseDeleteModal"
)

const (
	DocModifierView = "DocModifier"
)

const (
	HeaderComponent = "Header"
)

const (
	PeekerComponent = "Peeker"
)

Types

type BaseInfo

type BaseInfo map[order]info

type Content

type Content struct {
	*core.BaseElement
	*core.Flex
	// contains filtered or unexported fields
}

Content is a view that displays documents in a table

func NewContent

func NewContent() *Content

func (*Content) HandleDatabaseSelection

func (c *Content) HandleDatabaseSelection(ctx context.Context, db, coll string) error

HandleDatabaseSelection is called when a database/collection is selected in the DatabaseTree

func (*Content) Render

func (c *Content) Render(setFocus bool)

func (*Content) UpdateDao

func (c *Content) UpdateDao(dao *mongo.Dao)

type Database

type Database struct {
	*core.BaseElement
	*core.Flex

	DbTree *DatabaseTree
	// contains filtered or unexported fields
}

Database is flex container for DatabaseTree and InputBar

func NewDatabase

func NewDatabase() *Database

func (*Database) Render

func (d *Database) Render()

func (*Database) SetSelectFunc

func (d *Database) SetSelectFunc(f func(ctx context.Context, db string, coll string) error)

type DatabaseTree

type DatabaseTree struct {
	*core.BaseElement
	*core.TreeView
	// contains filtered or unexported fields
}

func NewDatabaseTree

func NewDatabaseTree() *DatabaseTree

func (*DatabaseTree) RefreshStyle

func (t *DatabaseTree) RefreshStyle()

func (*DatabaseTree) Render

func (t *DatabaseTree) Render(ctx context.Context, dbsWitColls []mongo.DBsWithCollections, expand bool)

func (*DatabaseTree) SetSelectFunc

func (t *DatabaseTree) SetSelectFunc(f func(ctx context.Context, db string, coll string) error)

type DocModifier

type DocModifier struct {
	*core.BaseElement
}

DocModifier is a view that allows editing JSON documents

func NewDocModifier

func NewDocModifier() *DocModifier

func (*DocModifier) Duplicate

func (d *DocModifier) Duplicate(ctx context.Context, db, coll string, rawDocument string) (primitive.ObjectID, error)

Duplicate opens the editor with the document and saves it as a new document

func (*DocModifier) Edit

func (d *DocModifier) Edit(ctx context.Context, db, coll string, _id interface{}, jsonDoc string) (string, error)

Edit opens the editor with the document and saves it if it was changed

func (*DocModifier) Insert

func (d *DocModifier) Insert(ctx context.Context, db, coll string) (primitive.ObjectID, error)

type Header

type Header struct {
	*core.BaseElement
	*core.Table
	// contains filtered or unexported fields
}

Header is a view that displays basic information and keybindings in the header

func NewHeader

func NewHeader() *Header

NewHeader creates a new header view

func (*Header) Render

func (h *Header) Render()

Render renders the header view

func (*Header) SetBaseInfo

func (h *Header) SetBaseInfo() BaseInfo

SetBaseInfo sets the basic information about the database connection

func (*Header) UpdateKeys

func (h *Header) UpdateKeys() ([]config.Key, error)

UpdateKeys updates the keybindings for the current focused element

type InputBar

type InputBar struct {
	*core.BaseElement
	*core.InputField
	// contains filtered or unexported fields
}

func NewInputBar

func NewInputBar(barId tview.Identifier, label string) *InputBar

func (*InputBar) DoneFuncHandler

func (i *InputBar) DoneFuncHandler(accept func(string), reject func())

DoneFuncHandler sets DoneFunc for the input bar It accepts two functions: accept and reject which are called when user accepts or rejects the input

func (*InputBar) EnableAutocomplete

func (i *InputBar) EnableAutocomplete()

EnableAutocomplete enables autocomplete

func (*InputBar) EnableHistory

func (i *InputBar) EnableHistory()

EnableHistory enables history modal

func (*InputBar) LoadNewKeys

func (i *InputBar) LoadNewKeys(keys []string)

LoadNewKeys loads new keys for autocomplete It is used when switching databases or collections

func (*InputBar) SetDefaultText

func (i *InputBar) SetDefaultText(text string)

SetDefaultText sets default text for the input bar

func (*InputBar) Toggle

func (i *InputBar) Toggle(text string)

Draws default text if input is empty

type Peeker

type Peeker struct {
	*core.BaseElement
	*core.ViewModal
	// contains filtered or unexported fields
}

Peeker is a view that provides a modal view for peeking at a document

func NewPeeker

func NewPeeker() *Peeker

NewPeeker creates a new Peeker view

func (*Peeker) MoveToBottom

func (p *Peeker) MoveToBottom()

func (*Peeker) MoveToTop

func (p *Peeker) MoveToTop()

func (*Peeker) Render

func (p *Peeker) Render(ctx context.Context, state *mongo.CollectionState, _id interface{}) error

func (*Peeker) SetDoneFunc

func (p *Peeker) SetDoneFunc(doneFunc func())

type ViewType

type ViewType int

const (
	TableView ViewType = iota
	JsonView
	SingleLineView
)