Sidio.Text.Slugify 1.1.1

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Sidio.Text.Slugify --version 1.1.1

NuGet\Install-Package Sidio.Text.Slugify -Version 1.1.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Sidio.Text.Slugify" Version="1.1.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Sidio.Text.Slugify --version 1.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Sidio.Text.Slugify, 1.1.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Sidio.Text.Slugify as a Cake Addin
#addin nuget:?package=Sidio.Text.Slugify&version=1.1.1

// Install Sidio.Text.Slugify as a Cake Tool
#tool nuget:?package=Sidio.Text.Slugify&version=1.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Sidio.Text.Slugify

Sidio.Text.Slugify is a simple NuGet package that converts a string to an URL-friendly string, also called a slug.

For example, the string Hello, World! will be converted to hello-world.

Installation

Add the NuGet package to your project.

Usage

Dependency injection

services.AddSlugifier();
// - or -
services.AddSlugifier(options => {
    options.AddDefaultProcessors = false;
    options.Processors.Add(new LowerCaseProcessor());
});

public class MyClass()
{
    public MyClass(ISlugifier slugifier)
    {
        var slug = slugifier.Slugify("Hello, World!");
    }
}

Direct usage

var slugifier = Slugifier.Create();
var slug = slugifier.Slugify("Hello, World!");

Extensions

Using the extension method is not recommended because it creates a new instance of the Slugifier class every time it is called.

using Sidio.Text.Slugify.Extensions;

var slug = "Hello, World!".Slugify();

Extensibility

You can implement your own processors by implementing the SlugifyProcessor class. For example:

public sealed class RemoveExclamationMarkProcessor : SlugifyProcessor
{
    protected override string ProcessInput(string input)
    {
        return input.Replace("!", string.Empty);
    }

    // run this processor first
    public override int Order => 0; // or int.MaxValue for last
}

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.