6570e43a83
Summary: Pull Request resolved: https://github.com/facebook/yoga/pull/1330 This has been tripping folks up a bit. Add a blurb to the package README to call it out. Reviewed By: cortinico Differential Revision: D47370333 fbshipit-source-id: f07b2e4d0e23865e3554c7aaf6ec77dff71a7423
80 lines
2.1 KiB
Markdown
80 lines
2.1 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} 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} from 'yoga-layout/sync';
|
|
|
|
const node = Yoga.Node.create();
|
|
node.setAlignContent(Align.Center);
|
|
```
|
|
|
|
Objects created by `Yoga.<>.create()` are not automatically garbage collected and should be freed once they are no longer in use.
|
|
|
|
```ts
|
|
// Free a config
|
|
config.free();
|
|
|
|
// Free a tree of Nodes
|
|
node.freeRecursive();
|
|
|
|
// Free a single Node
|
|
node.free();
|
|
```
|
|
|
|
## 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.
|
|
|
|
Different entrypoints are exposed to choose a flavor explicitly.
|
|
|
|
```ts
|
|
import {loadYoga} from 'yoga-layout/wasm-async';
|
|
```
|
|
|
|
## Using TypeScript
|
|
|
|
This package provides out-of-the-box TypeScript typings so long as `tsc` is configured to support ESM resolution. It is recommended to set `moduleResolution: 'bundler'` or `moduleResolution: node16` in your `tsconfig.json` according to your environment.
|
|
|
|
## Contributing
|
|
|
|
### Requirements
|
|
|
|
1. Emscripten SDK
|
|
1. CMake >= 3.13
|
|
1. (Optional) ninja, for faster builds
|
|
|
|
### Building
|
|
|
|
```bash
|
|
git clone https://github.com/facebook/yoga.git
|
|
cd yoga/javascript
|
|
yarn install
|
|
yarn build
|
|
```
|
|
|
|
### Testing
|
|
|
|
```bash
|
|
# Build and test all entrypoints
|
|
yarn test
|
|
|
|
# Build and test a specific entrypoint
|
|
yarn test:asmjs-sync
|
|
```
|