- Convert emojis to descriptive text.
- Convert text back into emojis.
- XUnit tests are implemented
- Supports the latest Unicode version 16.0
Install the package via NuGet:
dotnet add package EmojiToTextOr install it via Visual Studio NuGet package manager
- Accessibility: Convert emojis to text for screen readers, improving content accessibility.
- Text Processing: Enhance sentiment analysis or content moderation by converting emojis to readable text.
- Debugging: Simplify logs with emojis by converting them to descriptive text for easier analysis.
using EmojiToText;
class Program
{
static void Main(string[] args)
{
// Use this if your console does not support UTF-8
Console.OutputEncoding = System.Text.Encoding.UTF8;
string input = "Hello 😀!";
string result = EmojiConverter.ToText(input);
Console.WriteLine(result); // Output: Hello grinning face!
}
}using EmojiToText;
class Program
{
static void Main(string[] args)
{
// Use this if your console does not support UTF-8
Console.OutputEncoding = System.Text.Encoding.UTF8;
string text = "grinning face";
string emoji = EmojiConverter.ToEmoji(text);
Console.WriteLine(emoji); // Output: 😀
}
}First clone the repository:
git clone https://github.com/MeritonAliu/EmojiToText.gitTo run the tests for this project, use the following command:
dotnet testThe roadmap can be fount at: ROADMAP
The following benchmarks apply to the current EmojiConverter methods. The mutlitple benchmarks are done with 1000 emojis/texts.
| Method | Mean | Error | StdDev | Allocated |
|---|---|---|---|---|
| ConvertSingleEmojiToText | 14.04 us | 0.111 us | 0.066 us | 48 B |
| ConvertSingleTextToEmoji | 10.61 us | 0.307 us | 0.203 us | 32 B |
| ConvertMultipleEmojiToText | 172.42 us | 0.436 us | 0.288 us | - |
| ConvertMultipleTextToEmoji | 500.84 us | 1.132 us | 0.749 us | 6032 B |
If you want to benchmark it yourself, clone the repo and use:
dotnet run --project Benchmark/EmojiToText.Benchmarks.csproj -c Release@MeritonAliu - 2024
Bug reports and contributions are welcome! Feel free to submit pull requests or file issues.
- The main project is licensed under the MIT License.
- Emoji data is governed by the Unicode License.
If you want to support me and my work, feel free to donate a coffee
