vide/README.md
2023-08-09 00:15:36 +01:00

43 lines
863 B
Markdown

<br>
<div align="center">
<img style="float: right;margin-top:50px" src="docs/vide.svg" width="110" />
</div>
<br>
### ⚠️ This library is in early stages of development with breaking changes being made often.
Vide is a reactive and declarative UI library.
- Uses Luau typechecking
- Declarative and concise syntax.
- Minimal imports.
- Reactive state driven.
## Getting started
Read the
[crash course](https://centau.github.io/vide/tut/crash-course/1-introduction)
for a quick introduction to the library.
## Code sample
```lua
local vide = require(path_to_vide)
local source = vide.source
local function Counter()
local count = source(0)
return create "TextButton" {
Text = function()
return "count: " .. count()
end,
Activated = function()
count(count() + 1)
end
}
end
```