Stipop UI SDK for Android

Stipop SDK provides over 150,000 .png and .gif stickers that can be easily integrated into mobile app chats, comment sections, live streams, video calls, and other features. Bring fun to your mobile app with stickers loved by millions of users worldwide.

Requirements

• Kotlin
• Android + (API level 16) or higher
• Java 7 or higher
• Support androidx only
• Gradle 3.4.0 or higher

Getting Started

1. Sign up to Stipop Dashboard
2. Create your application to get API Key.
3. Download 'Stipop.json' file.

Try Demo

1. Clone this repository.
   
2. Move Stipop.json into the assets folder you created.
3. Build and run 'sample' on your device.
   
   

Including in your project

Use Gradle:

allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

dependencies {
  // like 0.9.1.-beta.1 Please check latest release!
  /* If your application's min API level is under 21, use 0.7.4 version. */
  implementation 'com.github.stipop-development:stipop-android-sdk:{latest_version}' 
}

How do I use Stipop SDK?

1. Move Stipop.json into the assets folder you created.
2. Make or update your application class. (This operation initializes the SDK from 'Stipop.json' file)

class MyApplication : Application() {
   override fun onCreate() {
      super.onCreate()
      Stipop.configure(this)
   }
}

3. Update your 'AndroidManifest.xml' to specify application class.
   Check your application include 'INTERNET' permission to perform network operations.
   Please put 'tools:replace="android:theme" to avoid conflict theme file in the application setting area.

    <uses-permission android:name="android.permission.INTERNET" />

<application
android:name=".{YourApplicationClass}"
        ...
        tools:replace="android:theme">

4. Then implement 'StipopDelegate' interface and Call 'Stipop.connect' method wherever you want to use it. (like Activity or Fragment)

class YourActivity : Activity(), StipopDelegate {

   val stipopPickerImageView: StipopImageView by lazy { findViewById(R.id.stickerPickerImageView) }

   override fun onCreate() {
      super.onCreate()

      // If you want to custom your PickerView's position, add StickerPickerCustomFragment. or not, set stickerPickerCustomFragment to null.
      val fragment = supportFragmentManager.findFragmentById(R.id.picker_view_fragment) as StickerPickerCustomFragment
      Stipop.connect(
         activity = this,
         userId = "userID",
         delegate = this,
         stipopButton = stipopPickerImageView,
         stickerPickerCustomFragment = fragment
      )
   }


   override fun onStickerSingleTapped(sticker: SPSticker): Boolean {
      // Sticker will be received here.
      // sendSticker(sticker.stickerImg)
      return true
   }

   /* If you want to use double tap feature, change the json file and implement this function. */
   override fun onStickerDoubleTapped(sticker: SPSticker): Boolean {
      // Sticker will be received here.
      // sendSticker(sticker.stickerImg)
      return true
   }

   override fun onStickerPackRequested(spPackage: SPPackage): Boolean {
      // IMPORTANT
      // true -> the sticker package can be downloaded
      // false -> the sticker package can't be downloaded
      return true
   }

}

5. Choose one of the two supported UI components. a. Stipop.show() : Sticker Picker View b. Stipop.showSearch() : Sticker Search View

class YourActivity : Activity(), StipopDelegate {

   val stipopPickerImageView: StipopImageView by lazy { findViewById(R.id.stickerPickerImageView) }

   override fun onCreate() {
      super.onCreate()

      // If you want to custom your PickerView's position, add StickerPickerCustomFragment. or not, set stickerPickerCustomFragment to null.
      val fragment = supportFragmentManager.findFragmentById(R.id.picker_view_fragment) as StickerPickerCustomFragment
      Stipop.connect(
         activity = this,
         userId = "userID",
         delegate = this,
         stipopButton = stipopPickerImageView,
         stickerPickerCustomFragment = fragment
      )

      setListener()
   }

   fun setListener() {

      firstButton.setOnClickListener {
         Stipop.show() // Use Sticker SDK in keyboard
      }

      secondButton.setOnClickListener {
         Stipop.showSearch() // Use Sticker SDK in dialog with keyword search
      }

   }

   override fun onStickerSingleTapped(sticker: SPSticker): Boolean {
      // Sticker will be received here.
      return true
   }

   /* If you want to use double tap feature, change the json file and implement this function. */
   override fun onStickerDoubleTapped(sticker: SPSticker): Boolean {
      // Sticker will be received here.
      return true
   }

   override fun onStickerPackRequested(spPackage: SPPackage): Boolean {
      // IMPORTANT
      // true -> the sticker package can be downloaded
      // false -> the sticker package can't be downloaded
      return true
   }



}

Contact us

• For more information, visit Stipop Documentation.
• Email us at [email protected] if you need our help.