Welcome to the documentation page for LWF!

LWF is a lightweight 2D animation framework for iOS, developed by the amazing team at CocoaDocs.org. It allows you to create and playback vector animations in your iOS apps with ease.


To install LWF, follow these simple steps:

  • Open your Xcode project.
  • Go to File > Swift Packages > Add Package Dependency.
  • In the “Enter package repository URL” field, enter https://github.com/goldze/MVVMHabit.git.
  • Click “Next” and select the desired version of LWF.
  • Click “Finish” to complete the installation process.

Getting Started

Before you can start animating with LWF, you need to:

  • Have a basic understanding of iOS development using Xcode and Swift.
  • Import the LWF module in your project file.
  • Create an instance of LWFView to use as your animation view.
  • Load an LWF file into your LWFView.
  • Play and control the animation using the provided methods.

Import LWF Module

To use LWF in your iOS project, you need to import the LWF module. Add the following line of code at the top of your Swift file:

import LWF

Create LWFView

To display an LWF animation, you need to create an instance of LWFView. This view will handle rendering and animating your LWF file. Add the following code snippet to your project:

// Initialize LWFView
let lwfView = LWFView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))

// Customize LWFView properties if needed
lwfView.playOnce = true
lwfView.loop = false

// Add LWFView to your view hierarchy

Loading LWF File

Now that you have your LWFView ready, it’s time to load an LWF file into it. Make sure you have the LWF file in your project directory, and add the following code snippet:

// Load LWF file
lwfView.loadLWF(name: "animation", fileExtension: "lwf")

Play and Control Animation

With your LWF file loaded, you can now play and control the animation. Use the following methods to control the playback:

  • Play: Start playing the animation loop.
  • Pause: Pause the current animation at its current position.
  • Stop: Stop the animation and reset its position to the beginning.
  • Resume: Resume playing the animation from where it was paused.
  • GoToAndStop(frame: Int): Go to the specified frame and stop the animation.

Here’s an example of using these methods:

// Play animation

// Pause animation

// Stop animation

// Resume animation

// Go to frame 50 and stop
lwfView.goToAndStop(frame: 50)


Congratulations! You have successfully installed LWF in your iOS project and learned how to create, load, and control LWF animations using LWFView. Now you can unleash your creativity and create amazing vector animations in your iOS apps!