shithub: microui

ref: b53399a1815178d6a221f580be4e5bce9614474d
dir: /README.md/

View raw version
# microui
![screenshot](https://user-images.githubusercontent.com/3920290/56437823-c3dcdb80-62d8-11e9-978a-a0739f9e16f0.png)

A tiny, portable, immediate-mode UI library written in ANSI C

[**Browser Demo**](https://floooh.github.io/sokol-html5/sgl-microui-sapp.html)

## Features
* Tiny: around `1100 sloc` of ANSI C
* Works within a fixed-sized memory region: no additional memory is
  allocated
* Built-in controls: window, panel, button, slider, textbox, label,
  checkbox, wordwrapped text
* Easy to add custom controls
* Simple layout system

## Usage
* See [`doc/usage.md`](doc/usage.md) for usage instructions
* See the [`demo`](demo) directory for a usage example

## Notes
* The library expects the user to provide input and handle the resultant
  drawing commands, it does not do any drawing itself
* In contrast to other immediate mode ui libraries microui does not store
  window, panel, header or treenode state internally. It is up to the
  user to manage this data themselves

## Contributing
The library is designed to be lightweight, providing a foundation to which
you can easily add custom controls and UI elements; pull requests adding
additional features will likely not be merged. Bug reports are welcome.

## License
This library is free software; you can redistribute it and/or modify it
under the terms of the MIT license. See [LICENSE](LICENSE) for details.