Welcome to the XFCrystalKit documentation page! Here you will find detailed information about XFCrystalKit, a powerful iOS framework for creating stunning user interfaces with crystal-like effects. Whether you are a beginner or an experienced developer, this documentation will provide you with everything you need to successfully integrate and utilize XFCrystalKit in your iOS projects.


Installing XFCrystalKit in your iOS project is simple and straightforward. Follow the steps below to get started:

  • Open your project in Xcode.
  • Click on “File” in the menu bar, then select “Swift Packages” and choose “Add Package Dependency”.
  • In the search bar, enter the following URL: https://github.com/xfathi/XFCrystalKit
  • Select the latest version of XFCrystalKit and click on “Next”.
  • Choose the desired target(s) to add XFCrystalKit to, then click on “Finish”.

Getting Started

Now that you have XFCrystalKit installed, you’re ready to dive into using its features. Make sure to import the XFCrystalKit module before starting to use any of its classes or functions.

Here’s a simple example to get you started:

import XFCrystalKit

Next, you can start using XFCrystalKit in your project:

let crystalView = XFCrystalView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))

This code creates a new XFCrystalView instance with a size of 200×200. You can customize the crystal view by adjusting properties and calling various methods provided by XFCrystalKit.


XFCrystalKit offers a wide range of features to enhance your iOS user interfaces. Here are some of the key features:

  • Crystal-like effects: Create stunning crystal-like effects with various configurations and animations.
  • Customizable properties: Adjust the crystal view’s appearance by modifying properties such as colors, opacity, and shapes.
  • Touch interactions: Enable touch interactions to make the crystal react to user gestures.
  • Animation support: Easily animate the crystal view using preset animations or custom animations.
  • Integration with Core Animation: Seamlessly integrate XFCrystalKit with Core Animation for advanced animations and transitions.


For detailed information about XFCrystalKit’s classes, methods, and properties, please refer to the official documentation. The documentation provides comprehensive explanations and examples to help you make the most out of XFCrystalKit in your iOS projects.

You can find the official documentation here.

Example App

If you’re looking for inspiration or want to see XFCrystalKit in action, check out our example app. The example app showcases various use cases and demonstrates the capabilities of XFCrystalKit.

You can find the example app’s repository here.


If you encounter any issues or have questions regarding XFCrystalKit, feel free to reach out to our support team. We’re here to assist you and ensure a smooth development experience!


We appreciate your interest in contributing to XFCrystalKit! If you have any improvements, bug fixes, or new features to suggest, please submit a pull request on our GitHub repository. Together, we can make XFCrystalKit even better!


XFCrystalKit is released under the MIT license. You can find the full license text here.

Enjoy using XFCrystalKit and have fun creating mesmerizing user interfaces with crystal-like effects!