Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 4.25 KB

README.md

File metadata and controls

107 lines (71 loc) · 4.25 KB
Raw

JoyPixels Logo

Release

Emoji Toolkit Android to help users find and replace native system emojis with JoyPixels in their Android app.

What's Included?

  • This project includes a Java library used to convert emoji into various formats, including conversion to JoyPixels emoji images.
  • The library included here are available free under the MIT license. Please check the LICENSE.md file for more details.

License to Use JoyPixels Images

JoyPixels Version 3+

JoyPixels has several licensing options available. PNG 32px, 64px, and 128px as well as 32px and 64px sprites are available for digital use, with attribution. See joypixels.com/liceses/free for more information on usage and attribution requirements.

Premium Licenses are available for larger PNG assets and SVG assets, for digital and print use. See joypixels.com/licenses/premium for more information or to obtain a Premium License.

Installation

emoji-toolkit-android is available through JitPack. To install it, simply add the following line to your build.gradle:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}
dependencies {
    implementation 'com.github.joypixels:emoji-toolkit-android:v8.0.12'
    implementation("com.squareup.okhttp3:okhttp:4.12.0") //required for remote files
}

and in your manifest add:

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

Internet is required to download the converted emoji.

Contributing

Please see CONTRIBUTING.md for more info on contributing to the JoyPixels project. For artwork comments and questions please see the emoji-assets repo.

Usage

You'll find links to usage demos in USAGE.md, and a sample project included in the JoyPixelsExamples directory here.

For Kotlin implementations, implement v8.0.12+ and use the syntax below in place of the Java syntax utilized in the example.

override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setContentView(R.layout.activity_main)

        val client = Client(this)
        client.setAscii(false) // convert ascii smileys? =)
        client.setShortcodes(true) // convert shortcodes? :joy:
        client.setGreedyMatch(true) // true enables less strict unicode matching
        client.setRiskyMatchAscii(true) // match ascii without leading/trailing space character

        val editText: EditText = findViewById(R.id.editText)
        editText.setText("Hello! \uD83D\uDE04 <3 :joy:")

        val textView: TextView = findViewById(R.id.textView)

        val toImage = findViewById(R.id.btnToImage) as Button
        toImage.setOnClickListener { // Convert native unicode emoji and shortnames to images on a spannable string
            client.toImage(editText.text.toString(), 128, object : Callback {
                override fun onFailure(e: IOException) {
                    textView.text = e.message
                }

                override fun onSuccess(ssb: SpannableStringBuilder) {
                    textView.text = ssb
                }
            })
        }
    }

Information

Bug reports

If you discover any bugs, feel free to create an issue on GitHub. We also welcome the open-source community to contribute to the project by forking it and issuing pull requests.

Contact

If you have any questions, comments, or concerns you are welcome to contact us.

Consideration

The library's unicodeRegexp value was generated using s9e\RegexpBuilder.