Mojee 1.0.0

Welcome to Mojee 🤪

What is Mojee?

Mojee is a lightning ⚡ fast Emoji library for .NET & TypeScript (.ts is coming soon).

Mojee's big party trick is the ultra-high-performance parse and replacement of emoji :short-codes: within a block of text. Pass a string of text to Mojee, and Mojee will convert any emoji :short-codes: found with actual emoji character instances. Here's a basic Mojee Replace sample:

// Replace all shortcodes with an emoji
var result = Mojee.Replace("Hello, world :smile:");

Console.WriteLine(result);

The console output from the above sample would be:

Hello, world 😄

Mojee is also amazing at Emoji search. Search for any term and Mojee will hand back a collection of emoji results. The following sample demonstrates a basic emoji search using Mojee.

// Search for emojis
Mojee.Search("smile").ToList()
     .ForEach(emoji => Console.Write(emoji));

The console output from the above sample would be:

😄 😸 😃 😺 😅

Getting Started

Within seconds, Mojee can be added to any .NET Core project using NuGet.

# Install using dotnet CLI
dotnet add package Mojee

# or,

# Instal using NuGet CLI
Install-Package Mojee

The following sequence of commands could be used to create a new .NET Console project using the dotnet CLI, then add Mojee, and finally open the new project in Visual Studio Code.

mkdir MojeeDemo          # Make a new folder
cd MojeeDemo             # Move into the new folder
dotnet new console       # Create a new .NET Console app
dotnet add package Mojee # Add Mojee to your new project
code .                   # Open in Visual Studio Code

The MojeeIO API is now available within your app. The following sample demonstrates a basic Console app scenario with Mojee.

using System;
using MojeeIO;

namespace MojeeDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            // Search for emojis
            Mojee.Search("smile").ToList()
                .ForEach(emoji => Console.Write(emoji));

            Console.ReadKey();
        }
    }
}

Licensing

Mojee is free to use in both open-source and commercial applications, although with support for a limited set of emojis unless a license key is purchased.

Todays most 100 most popular emojis are supported for free, which covers approximately 80% of all emojis used. The following table documents the 100 emojis currently supported in the free (no license key) version of Mojee.

Please see the License Key Configuration guide for instructions on how to add your Mojee License key to a project.

Purchasing a Pro or Team license key will unlock the full power of Mojee with support for all 1743 emojis.