c51d7d82a6
Fixes https://github.com/facebook/yoga/issues/1417 This dramatically simplifies the matrix of Node vs web, ASM vs WASM, sync vs async compilation, or CommonJS vs ES Modules. We have one variant, using without, with ESModule top-level await to do async compilation. Web/node share the same binary, and we base64 encode the WASM into a wrapper JS file for compatibility with Node and bundlers. After this change we target: This has some downsides, like requiring an environment with top level await, but also has upsides, like a consistent, sync looking API compatible with older Yoga, and mitigating TypeScript issues with package exports and typings resolution. ## Test Plan 1. `yarn test` 2. `yarn lint` 3. `yarn tsc` 4. `yarn build` website-next 5. Locally test website 5. Examine package artifact created by GitHub
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# yoga-layout
|
|
|
|
This package provides prebuilt WebAssembly bindings for the Yoga layout engine.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import {Yoga, Align} from 'yoga-layout';
|
|
|
|
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();
|
|
```
|
|
|
|
## 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.
|
|
|
|
## ES Modules
|
|
|
|
`yoga-layout` is only provided as an ES Module, relying on top-level await. This allows providing a synchronous API, while still allowing async WebAssembly compilation in browsers, and will allow eventual usage of ESM/WASM interop.
|
|
|
|
## 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
|
|
```
|