1 API Documentation

Jakub Sobon edited this page 2019-02-24 15:07:15 -05:00

Table of Contents

• API Documentation
• API Maturity

API Documentation

This section provides documentation for the public API surface of Termdash. You can also refer to the generated godoc.

Not all packages in this repository are public. Private packages can be identified by the presence of the /internal/ directory in their import path. Stability of the private packages isn't guaranteed and changes won't be backward compatible.

API Maturity

There might still be breaking changes to the public API, at least until the project reaches version 1.0.0. Any breaking changes will be published in the changelog.

• Home
• Introduction
• Release notes

Help

• Talk to us

API Documentation

Terminal layer

• Cell
• Keyboard
• Mouse
• Terminal
  • Tcell
  • Termbox (not maintained)

Infrastructure layer

• Align
• Linestyle
• Termdash

Container layer

• Container
  • Binary tree layout
  • Grid layout
  • Dynamic layout
  • Margin and padding
  • Keyboard focus
  • Placing widgets
  • Container style

Widgets layer

• Widget
  • BarChart

Tips and tricks

• Debugging

See a typo, something missing or outright wrong? Feel free to edit the Wiki pages directly, alternatively talk to us.