Add dependencies on a Pod library

To add dependencies between a Kotlin project and a Pod library, you should complete the initial configuration. This allows you to add dependencies on different types of Pod libraries.

When you add a new dependency and re-import the project in IntelliJ IDEA, the new dependency will be added automatically. No additional steps are required.

To use your Kotlin project with Xcode, you should make changes in your project Podfile.

A Kotlin project requires the pod() function call in build.gradle.kts (build.gradle) for adding a Pod dependency. Each dependency requires its separate function call. You can specify the parameters for the dependency in the configuration block of the function.

You can find a sample project here.

From the CocoaPods repository

Specify the name of a Pod library in the pod() function.

In the configuration block, you can specify the version of the library using the version parameter. To use the latest version of the library, you can just omit this parameter altogether.

You can add dependencies on subspecs.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        ios.deploymentTarget = "13.5"

        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        pod("AFNetworking") {
            version = "~> 4.0.1"
        }
    }
}

Re-import the project.

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.AFNetworking.*

On a locally stored library

Specify the name of a Pod library in the pod() function.

In the configuration block, specify the path to the local Pod library: use the path() function in the source parameter value.

You can add local dependencies on subspecs as well. The cocoapods block can include dependencies to Pods stored locally and Pods from the CocoaPods repository at the same time.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        ios.deploymentTarget = "13.5"

        pod("pod_dependency") {
            version = "1.0"
            source = path(project.file("../pod_dependency"))
        }
        pod("subspec_dependency/Core") {
            version = "1.0"
            source = path(project.file("../subspec_dependency"))
        }
        pod("AFNetworking") {
            version = "~> 4.0.1"
        }
    }
}

Re-import the project.

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.pod_dependency.*
import cocoapods.subspec_dependency.*
import cocoapods.AFNetworking.*

From a custom Git repository

Specify the name of a Pod library in the pod() function.

In the configuration block, specify the path to the git repository: use the git() function in the source parameter value.

Additionally, you can specify the following parameters in the block after git():
- commit – to use a specific commit from the repository
- tag – to use a specific tag from the repository
- branch – to use a specific branch from the repository
The git() function prioritizes passed parameters in the following order: commit, tag, branch. If you don't specify a parameter, the Kotlin plugin uses HEAD from the master branch.

You can combine branch, commit, and tag parameters to get the specific version of a Pod.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        ios.deploymentTarget = "13.5"

        pod("AFNetworking") {
            source = git("https://github.com/AFNetworking/AFNetworking") {
                tag = "4.0.0"
            }
        }

        pod("JSONModel") {
            source = git("https://github.com/jsonmodel/jsonmodel.git") {
                branch = "key-mapper-class"
            }
        }

        pod("CocoaLumberjack") {
            source = git("https://github.com/CocoaLumberjack/CocoaLumberjack.git") {
                commit = "3e7f595e3a459c39b917aacf9856cd2a48c4dbf3"
            }
        }
    }
}

Re-import the project.

To work correctly with Xcode, you should specify the path to the Podspec in your Podfile. For example:

target 'ios-app' do
    # ... other pod depedencies ...
   pod 'JSONModel', :path => '../cocoapods/kmm-with-cocoapods-sample/kotlin-library/build/cocoapods/externalSources/git/JSONModel'
end

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.AFNetworking.*
import cocoapods.JSONModel.*
import cocoapods.CocoaLumberjack.*

From a zip, tar, or jar archive

Specify the name of a Pod library in the pod() function.

In the configuration block, specify the path to the archive: use the url() function with an arbitrary HTTP address in the source parameter value.

Additionally, you can specify the boolean flatten parameter as a second argument for the url() function. This parameter indicates that all the Pod files are located in the root directory of the archive.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        ios.deploymentTarget = "13.5"

        pod("pod_dependency") {
            source = url("https://github.com/Kotlin/kmm-with-cocoapods-sample/raw/cocoapods-zip/cocoapodSourcesZip.zip", flatten = true)
        }
    }
}

Re-import the project.

To work correctly with Xcode, you should specify the path to the Podspec in your Podfile. For example:

target 'ios-app' do
    # ... other pod depedencies ...
   pod 'podspecWithFilesExample', :path => '../cocoapods/kmm-with-cocoapods-sample/pod_dependency'
end

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.pod_dependency.*

From a custom Podspec repository

Specify the HTTP address to the custom Podspec repository using the url() inside the specRepos block.
Specify the name of a Pod library in the pod() function.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        ios.deploymentTarget = "13.5"

        specRepos {
            url("https://github.com/Kotlin/kotlin-cocoapods-spec.git")
        }
        pod("example")
    }
}

Re-import the project.

To work correctly with Xcode, you should specify the location of specs at the beginning of your Podfile. For example,

source 'https://github.com/Kotlin/kotlin-cocoapods-spec.git'`

You should also specify the path to the Podspec in your Podfile. For example:

target 'ios-app' do
    # ... other pod depedencies ...
   pod 'podspecWithFilesExample', :path => '../cocoapods/kmm-with-cocoapods-sample/pod_dependency'
end

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.example.*

With custom cinterop options

Specify the name of a Pod library in the pod() function.

In the configuration block, specify the cinterop options:
- extraOpts – to specify the list of options for a Pod library. For example, specific flags: extraOpts = listOf("-compiler-option")
- packageName – to specify the package name. If you specify this, you can import the library using the package name: import <packageName>.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        ios.deploymentTarget = "13.5"

        useLibraries()

        pod("YandexMapKit") {
            packageName = "YandexMK"
        }
    }
}

Re-import the project.

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.YandexMapKit.*

If you use the packageName parameter, you can import the library using the package name import <packageName>:

import YandexMK.YMKPoint
import YandexMK.YMKDistance

On a static Pod library

Specify the name of the library using the pod() function.
Call the useLibraries() function – it enables a special flag for static libraries.

Specify the minimum deployment target version for the Pod library.

kotlin {
    ios()

    cocoapods {
        summary = "CocoaPods test library"
        homepage = "https://github.com/JetBrains/kotlin"

        ios.deploymentTarget = "13.5"

        pod("YandexMapKit") {
            version = "~> 3.2"
        }
        useLibraries()
    }
}

Re-import the project.

To use these dependencies from the Kotlin code, import the packages cocoapods.<library-name>.

import cocoapods.YandexMapKit.*

Last modified: 07 April 2022

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/docs/native-cocoapods-libraries.html

Docs

Docs4dev

Title here

Add dependencies on a Pod library

From the CocoaPods repository

On a locally stored library

From a custom Git repository

From a zip, tar, or jar archive

From a custom Podspec repository

With custom cinterop options

On a static Pod library