https://github.com/facebook/yoga

Yoga is an embeddable layout engine targeting web standards.
https://github.com/facebook/yoga

Last synced: 11 days ago
JSON representation

Yoga is an embeddable layout engine targeting web standards.

• Host: GitHub
• URL: https://github.com/facebook/yoga
• Owner: facebook
• License: mit
• Created: 2014-04-07T01:37:37.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T05:20:02.000Z (7 months ago)
• Last Synced: 2024-04-11T06:29:50.689Z (7 months ago)
• Language: C++
• Homepage: https://yogalayout.dev/
• Size: 23.9 MB
• Stars: 16,869
• Watchers: 394
• Forks: 1,398
• Open Issues: 81
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - facebook/yoga - Yoga is an embeddable layout engine targeting web standards. (C++)
• pure-awesomeness - yoga
• awesome-game-engine-dev - Yoga - Cross-platform [flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox) layout engine by _Facebook_. [[Website](https://yogalayout.com/)] (Libraries / C++)
• awesome-github-star - yoga - platform layout engine which implements Flexbox. Follow https://twitter.com/yogalayout for updates. | facebook | 16448 | (C++)
• Awesome-iOS - Yoga - Yoga is a cross-platform layout engine which implements Flexbox. (UI Frameworks)
• awesome-list - yoga - platform layout engine which implements Flexbox. Follow https://twitter.com/yogalayout for updates. | facebook | 14551 | (C++)
• awesome-desktop-js - Yoga - a layout engine which implements Flexbox to build cross-platform (node, browser asm, and standalone) apps (GUI Frameworks / Flexbox)
• awesome-ios-1 - facebook / yoga
• awesome-2d-graphics-rendering - yoga - platform layout engine which implements Flexbox. (Graphic Layout Engine / Rust 2D renderer)

README

        
# Yoga [![CocoaPods](https://img.shields.io/cocoapods/v/Yoga.svg)](http://cocoapods.org/pods/Yoga) [![npm](https://img.shields.io/npm/v/yoga-layout.svg)](https://www.npmjs.com/package/yoga-layout) [![Maven Central](https://img.shields.io/maven-central/v/com.facebook.yoga/yoga)](https://search.maven.org/artifact/com.facebook.yoga/yoga) ![SPM](https://img.shields.io/badge/SPM-Supported-blue.svg)

Yoga is an embeddable and performant flexbox layout engine with bindings for multiple languages.

## Building

Yoga's main implementation targets C++ 20 with accompanying build logic in CMake. A wrapper is provided to build the main library and run unit tests.

```sh

./unit_tests 

```

While not required, this script will use [ninja](https://ninja-build.org/) if it is installed for faster builds.

Yoga is additionally part of the [vcpkg](https://github.com/Microsoft/vcpkg/) collection of ports maintained by Microsoft and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.

## Adding Tests

Many of Yoga's tests are automatically generated, using HTML fixtures describing node structure. These are rendered in Chrome to generate an expected layout result for the tree. New fixtures can be added to `gentest/fixtures`.

```html



  




```


To generate new tests from added fixtures:

1. Ensure you have [yarn classic](https://classic.yarnpkg.com) installed.

2. Run `yarn install` to install dependencies for the test generator.

3. Run `yarn gentest` in the `yoga` directory.

## Debugging

Yoga provides a VSCode "launch.json" configuration which allows debugging unit tests. Simply add your breakpoints, and run "Debug C++ Unit tests (lldb)" (or "Debug C++ Unit tests (vsdbg)" on Windows).