Yoga is a cross-platform layout engine which implements Flexbox. Follow https://twitter.com/yogalayout for updates.
C++ JavaScript C# Java HTML Objective-C Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add issue template. Jan 30, 2017
YogaKit Also ban +new on YGLayout Jul 24, 2018
android Re-format BUCK to use recommended style. May 21, 2018
benchmark Fix warnings when building benchmark Jul 11, 2018
csharp Skylarkify yoga build defs. Jul 14, 2018
fbandroid/libraries/components/lib/yoga/src/main/cpp/yoga Move YGStyle to seperate file and add constructors Feb 20, 2018
fbcode/xplat/yoga/yoga Move YGStyle to seperate file and add constructors Feb 20, 2018
gentest Revert D9286928: [yoga] Solve width bug when the size is less than min Aug 16, 2018
gradle Modernize Android build system, bump dependencies Nov 8, 2017
java Back to JNI storage Aug 6, 2018
javascript Bump Prettier to 1.13.4 on xplat Jun 6, 2018
lib Fix Travis build (#800) Aug 2, 2018
mode Disable assert code in release builds (define DNDEBUG) Dec 18, 2017
scripts Re-enable matrix build for Java snapshots Apr 10, 2018
tests Fix parent height calculation in case of baseline alignment Aug 16, 2018
website update dependencies Jul 5, 2018
yoga Inline `YG_NODE_STYLE_PROPERTY_UNIT_IMPL` macro Aug 17, 2018
yogacore Update license headers for MIT license Feb 17, 2018
.buckconfig Modernize Android build system, bump dependencies Nov 8, 2017
.editorconfig Add .editorconfig May 27, 2017
.gitignore Add NDK build for libfb Apr 19, 2017
.gitmodules Add googletest submodule Nov 16, 2016
.swift-version Add podspec for C-Library. Jan 26, 2017
.travis.yml Fix Travis build (#800) Aug 2, 2018
BUCK Fix deprecated glob usage. Jun 24, 2018
CMakeLists.txt Update license headers for MIT license Feb 17, 2018
CODE_OF_CONDUCT.md Update CoC for various projects Aug 2, 2018
CONTRIBUTING.md Update CoC for various projects Aug 2, 2018
LICENSE Update to MIT license Feb 17, 2018
LICENSE-examples example license Dec 7, 2016
README.md Fix typo Aug 13, 2018
Yoga.podspec Feature podspec modules (#793) Jul 12, 2018
YogaKit.podspec Feature podspec modules (#793) Jul 12, 2018
build.gradle Modernize Android build system, bump dependencies Nov 8, 2017
enums.py Update license headers for MIT license Feb 17, 2018
gradle.properties 1.9.1-SNAPSHOT Jul 19, 2018
gradlew Bundle gradle wrapper Apr 19, 2017
settings.gradle Back to JNI storage Aug 6, 2018
yoga_defs.bzl Skylarkify yoga build defs. Jul 14, 2018

README.md

Yoga CocoaPods npm bintray NuGet

Building

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.

Testing

For testing we rely on gtest as a submodule. After cloning Yoga run git submodule init followed 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 tests directory. 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.rb to generate a test for you. You can write html which you want to verify in Yoga, in gentest/fixtures folder, such as the following.

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

Run gentest/gentest.rb to generate test code and re-run buck test //:yoga to validate the behavior. One test case will be generated for every root div in the input html.

You may need to install the latest watir-webdriver gem (gem install watir-webdriver) and ChromeDriver to run gentest/gentest.rb Ruby script.

.NET

.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, csharp/tests/Facebook.Yoga/test_macos.sh.

Benchmarks

Benchmarks are located in benchmark/YGBenchmark.c and 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.

JavaScript

Installing through NPM

npm install yoga-layout

By 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.

npm config set yoga-layout:platform standalone

This will now only run the standalone webpack build upon install.

Build Platforms

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.