Yoga is a cross-platform layout engine which implements Flexbox. Follow https://twitter.com/yogalayout for updates.
Yoga builds with buck. Make sure you install buck before contributing to Yoga. Yoga's main implementation is in C++, with bindings to supported languages and frameworks. When making changes to Yoga please ensure the changes are also propagated to these bindings when applicable.
For testing we rely on gtest as a submodule. After cloning Yoga run
git submodule initfollowed by
git submodule update.
For any changes you make you should ensure that all the tests are passing. In case you make any fixes or additions to the library please also add tests for that change to ensure we don't break anything in the future. Tests are located in the
testsdirectory. Run the tests by executing
buck test //:yoga.
Instead of manually writing a test which ensures parity with web implementations of Flexbox you can run
gentest/gentest.rbto generate a test for you. You can write html which you want to verify in Yoga, in
gentest/fixturesfolder, such as the following.
gentest/gentest.rbto generate test code and re-run
buck test //:yogato validate the behavior. One test case will be generated for every root
divin the input html.
You may need to install the latest watir-webdriver gem (
gem install watir-webdriver) and ChromeDriver to run
.NET testing is not integrated in buck yet, you might need to set up .NET testing environment. We have a script which to launch C# test on macOS,
Benchmarks are located in
benchmark/YGBenchmark.cand can be run with
buck run //benchmark:benchmark. If you think your change has affected performance please run this before and after your change to validate that nothing has regressed. Benchmarks are run on every commit in CI.
Installing through NPM
sh npm install yoga-layoutBy default this will install the library and try to build for all platforms (node, browser asm, and standalone webpack). You may receive errors if you do not have the required platform development tools already installed. To preset the platform you'd like to build for you can set a .npmrc property first.
sh npm config set yoga-layout:platform standaloneThis will now only run the standalone webpack build upon install.
| name | description | |----------------|-------------------------------------------------| | all (default) | Builds all of these platforms. | | browser | Builds asm js browser version. | | node | Builds node js version. | | standalone | Runs webpack. | | none | Does nothing. You can use the prepackaged libs. |
To publish a new release, follow these steps:
gradle.properties(don't forget to revert) or your global
# You get these from https://oss.sonatype.org/#profile;User%20Token mavenCentralRepositoryUsername= mavenCentralRepositoryPassword=
You can get the keyId (in GPG 1.4 format) by running
signing.secretKeyRingFile= signing.keyId= signing.password=
gradle.propertiesto a non-SNAPSHOT release.
gradle.propertiesback to a new SNAPSHOT release.