53 lines
1.6 KiB
Markdown
53 lines
1.6 KiB
Markdown
# yoga-layout
|
|
|
|
This package provides prebuilt JavaScript bindings for the Yoga layout engine. Both WebAssembly and asm.js variants are packaged, with the optimal loaded based on platform.
|
|
|
|
## Usage
|
|
|
|
The default entrypoint provides an asynchronous loader function to return a Yoga instance.
|
|
|
|
```ts
|
|
import { loadYoga, ALIGN_CENTER } from "yoga-layout";
|
|
|
|
const Yoga = await loadYoga();
|
|
|
|
const node = Yoga.Node.create();
|
|
node.setAlignContent(ALIGN_CENTER);
|
|
```
|
|
|
|
An alternative synchronous API is provided for compatibility, but requires using asm.js in browsers instead of WebAssembly, leading to worse performance and larger assets.
|
|
|
|
```ts
|
|
import Yoga, { ALIGN_CENTER } from "yoga-layout/sync";
|
|
|
|
const node = Yoga.Node.create();
|
|
node.setAlignContent(ALIGN_CENTER);
|
|
```
|
|
|
|
## Selecting WebAssembly or asm.js
|
|
|
|
For better performance and smaller packages, WebAssembly is preferred to asm.js where available. `yoga-layout` tries to provide the right default using [export maps](https://webpack.js.org/guides/package-exports/#conditional-syntax) so that platforms which can take advantage of WebAssembly use it by default.
|
|
|
|
A specific entrypoint may be specified on platforms which do not understand export conditions.
|
|
|
|
```ts
|
|
import { loadYoga } from "yoga-layout/entrypoint/wasm-async";
|
|
```
|
|
|
|
|
|
## Contributing
|
|
|
|
`yoga-layout` may be locally built by running the following set of commands. The build requires that some dependencies be installed first.
|
|
|
|
```bash
|
|
git clone https://github.com/facebook/yoga.git
|
|
cd yoga/javascript
|
|
yarn install
|
|
yarn build
|
|
```
|
|
|
|
### Requirements
|
|
|
|
1. CMake >= 3.13
|
|
1. (Optional) ninja, for faster builds
|