yoga-layout

An embeddable and performant flexbox layout engine with bindings for multiple languages

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
yoga-layout
17,033863.0.42 months ago7 years agoMinified + gzip package size for yoga-layout in KB

Readme

yoga-layout
This package provides prebuilt WebAssembly bindings for the Yoga layout engine.
See more at https://yogalayout.dev

Usage

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.
// Free a config
config.free();

// Free a tree of Nodes
node.freeRecursive();

// Free a single Node
node.free();

Requirements

yoga-layout requires a toolchain that supports ES Modules and top-level await.
If top-level-await is not supported, use the yoga-layout/load entry point instead. This requires to load yoga manually:
import {loadYoga, Align} from 'yoga-layout/load';

const node = (await loadYoga).Node.create();
node.setAlignContent(Align.Center);