Github url

yoga

by facebook

facebook /yoga

Yoga is a cross-platform layout engine which implements Flexbox. Follow https://twitter.com/yogalayo...

13.3K Stars 1.1K Forks Last release: 8 months ago (1.18.0) Other 2.0K Commits 46 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.

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

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

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.