Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/izolate/slugify

Converts a string to a slug, useful for URLs, filenames, IDs, and more
https://github.com/izolate/slugify

character converts-string dart slug slugify url

Last synced: about 2 months ago
JSON representation

Converts a string to a slug, useful for URLs, filenames, IDs, and more

Awesome Lists containing this project

README

        

# slugify

Converts any `String` to a **slug**. Useful for URLs, filenames, IDs, and more.

## Features

* Multi-language support
* Removes unfriendly characters
* Approximates replacements for characters not in the Latin alphabet
* Configurable options
* Null safe with Dart 2.12

## Usage

```dart
import 'package:slugify/slugify.dart';

// Use with default options.
var slug = slugify('Hello, World! Foo Bar');
print(slug); // hello-world-foo-bar

// Use with custom options.
var slug2 = slugify('Hello, World! Foo Bar', lowercase: false, delimiter: '๐Ÿ™‚');
print(slug2) // Hello๐Ÿ™‚World๐Ÿ™‚Foo๐Ÿ™‚Bar
```

### Options

Name | Type | Default | Description
--- | --- | --- | ---
`delimiter` | `String` | `"-"` | Separator between words
`lowercase` | `bool` | `true` | Convert text to lowercase