When creating designs and assets in Lightwell, eventually you may want to hand those off to a developer to implement. The LightwellKit SDK streamlines this process, allowing developers to quickly and easily pull out the layers and animations you've created, and quickly implement them directly in code.

When preparing a Lightwell project for SDK export, there are a few best practices to be aware of.

First off, when naming various assets, you want to make sure the names are somewhat descriptive, and unique. Developers will be using the layer and animation names as keys to access the assets via the SDK:

Naming and renaming assets using the hierarchies on the left side of the editor is quick and easy, so managing your elements is painless. The primary thing to keep in mind is keeping the names unique. It may be helpful to keep some documentation of which names tie to what in order to assist further in the developer hand-off.

Once you're at a point where your designs are looking finalized, it's time to actually export to the SDK. The top right of the Lightwell editor has two buttons for export and publish. The export button is the one you want.

After clicking export you'll be presented with the developer hand-off screen:

The main thing here is the export project folder button. Clicking this will allow you to select a name and location for the folder that's generated. This is the folder that you'll actually be handing off to the developer.

That's it! Exporting to the Lightwell SDK is quick and painless. At the bottom of the export screen is a link to the detailed developer documentation around implementing the SDK in code. If you'd like to know more about how a developer will actually utilize the SDK, this is the place to look:


Did this answer your question?