Flow

KO | EN

gitlite — search

#javascript #android #rust #deep-learning #docker #nodejs #windows #cli #vue #awesome-list #pytorch #mcp #ios #open-source

(★ 56)

🌊 A Flexbox layouting engine for Lua.

Flow Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `🌊 Flow`

**A Flexbox layouting engine for Lua**

[![CI](https://github.com/grilme99/Flow/actions/workflows/ci.yml/badge.svg)](https://github.com/grilme99/Flow/actions/workflows/ci.yml) [![Wally](https://img.shields.io/badge/Wally-v1.0.0-AD4646)](https://wally.run/package/grilme99/flow)

</div>

## About

Flow aims to be a high-performance Flexbox layout engine that adheres closely to the Flexbox specification. It is based
on Meta's [Yoga](https://github.com/facebook/yoga) library. For more details, refer to the
[Acknowledgements](#acknowledgements) section.

## Testing

### Adding Tests

Flow generates many of its tests automatically from HTML fixtures. These fixtures describe the node structure and are
rendered in Chrome to get expected layout outcomes. To add new fixtures, place them in the `scripts/gentest/fixtures`
directory.

```html
<div id="my_test" style="width: 100px; height: 100px; align-items: center;">
  <div style="width: 50px; height: 50px;"></div>
</div>
```

To generate new tests:

1. Navigate to the `scripts/gentest` directory and run `npm install` to set up the test generator.
2. Execute `node index.js` in the same directory.

### Running Tests

Roblox Studio is required to execute Flow's benchmarks unit tests. See
[this issue](https://github.com/grilme99/Flow/issues/3) for more details.

To run tests in Roblox Studio:

1. Use `just install-packages` to set up required packages.
2. Build the project via `rojo build --output Flow.rbxl`.
3. Open the generated Roblox file and toggle the `RunBench` or `RunTests` scripts as needed (found under
   `ServerScriptService`).
4. Run the game and the results will be printed to the output.

## Benchmarks

TODO: Add benchmarks here

## Acknowledgements

Flow is a Lua adaptation of [Typeflex](https://github.com/dead/typeflex), a Typescript port of Yoga. It also
incorporates some work by [Roblox](https://www.roblox.com/) for Flexbox exploration in Lua.

As time goes on, it's likely Flow will deviate from Typeflex and align more closely with upstream Yoga. See
[this issue](https://github.com/grilme99/Flow/issues/2) for more details.

Flow

Flow Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Flow

Flow Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README