Skip to content
pixi-silk
GitHub repository
Docs

Learn

Install pixi-silk, pick the entry points you need and build a first widget and a first editor canvas.

View as Markdown

Start here if pixi-silk is new to you. Getting started installs it and draws a first scene.

The two tutorials build a button and an editor canvas from scratch. The migration page maps Graphics calls to SilkGraphics.

Questions

What is pixi-silk?

An MIT-licensed TypeScript library for PixiJS v8. Its SilkGraphics display object has a Graphics-like API and draws each shape as a distance field, anti-aliased per pixel in the shader.

Is pixi-silk a replacement for Graphics?

For UI, chart and icon drawing, yes: SilkGraphics keeps the active path, fill() and stroke(). It has no texture fills and no svg() import (svgPath(d) reads one path string), and both classes work side by side.

Which entry point do I import?

The root pixi-silk import holds SilkGraphics, gradients, createSilkApp and batching. Text, layout, glass, glow, WebGPU and every UI widget are separate entry points, such as pixi-silk/text or pixi-silk/ui/gizmo, so an app bundles only what it imports.

Can I use pixi-silk in React, Vue or Svelte?

Yes. Create the app in a mount hook with createSilkApp({ parent: element }) and call its destroy() on unmount.

What license is pixi-silk under?

MIT, for commercial and open-source use.

All questions