iOS UIKit Installation Guide
Amity iOS UI Kit Migration Guide
To allow for more customization, we have now open sourced our UI Kits and will be deprecating the managed UI Kit version that was previously available.
With open-source, developers have more flexibility and greater customization options, allowing you to have complete control over the visual style. Open sourcing allows for more transparency and visibility and enables contributions from a greater developer community in terms of good design, implementation, code improvement, and fixes, translating into a better product and typical development.
To ensure that you continue to receive the latest features and updates, we encourage you to move off the managed UI Kit to the Open Source UI Kit. This guide will show you how to:
If you've never used UI Kit, you may skip this step and proceed to the next step.
If you're integrating the UI Kit with an existing project, you'll need to remove and unlink the packaged UI Kit from your project before proceeding with the integration.
There are several ways for you to migrate the open source iOS UI Kit into your projects, depending on your workflow. One way that we recommend is via Git Submodule. This instruction assumes that the app project is already set up with a Git repository.
- 1.Add git submodule of Amity UIKit open source into your git repository.
git submodule add https://github.com/AmityCo/Amity-Social-Cloud-UIKit-iOS-OpenSource
2. Create an Xcode Workspace, and then add both
AmityUIKit.xcodeprojtogether under the same workspace.
Xcode Workspace Project Structure
AmityUIKitlinks with other dependencies such as
SharedFrameworkswhich is a Swift Package.
Step 1: Reset Package Cache of your Application Target i.e YourApp.xcodeproj. [If you are installing AmityUIKit for the first time, you can skip this step]
Select App Target In Xcode Project -> Select File Menu for Xcode-> Packages -> Reset Package Cache
Step 2: Link
AmityUIKit.frameworkto YourApp.xcodeproj target as shown below.
MyApp.xcodeproj, let’s try importing AmityUIKit / AmitySDK and call some APIs. You should be able to compile and run the app.
You can modify the iOS open source UI Kit to customize behaviors to fit your needs. To modify the code, simply copy and paste it into your local machine.
We recommend that you first fork the repository before starting any customization work, so that it will be easier to merge the code with the next version update that we provide from the main repository.
To update to the latest version of the UI Kit, you can pull the latest commit of the git submodule.
git pull origin master
git add .
git commit -m “Update ios uikit opensource submodule”
git push origin master