PHPackages                             webworkerjoshua/laravel-nanoid - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. webworkerjoshua/laravel-nanoid

ActiveLibrary[Utility & Helpers](/categories/utility)

webworkerjoshua/laravel-nanoid
==============================

A Laravel package for generating and managing Nano ID values.

v1.0.0(4w ago)027MITPHPPHP ^8.2CI passing

Since May 11Pushed 4w agoCompare

[ Source](https://github.com/webworkerJoshua/laravel-nanoid)[ Packagist](https://packagist.org/packages/webworkerjoshua/laravel-nanoid)[ RSS](/packages/webworkerjoshua-laravel-nanoid/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (6)Versions (2)Used By (0)

Laravel Nano ID
===============

[](#laravel-nano-id)

`webworkerJoshua/laravel-nanoid` is a Laravel package for generating and assigning Nano ID values.

The generator follows the secure API from Nano ID 5 where it maps cleanly to PHP:

- secure random bytes from `random_bytes()`
- the official URL-friendly `urlAlphabet`
- default size of 21 characters
- custom alphabets with rejection sampling to avoid modulo bias
- custom random byte generators for tests or advanced integrations

The JavaScript package also ships a `non-secure` API based on `Math.random()`. This package intentionally exposes only the secure generator.

References:

- Official collision calculator:
- Official Nano ID repository:

Installation
------------

[](#installation)

Requirements:

- PHP 8.2+
- Laravel 11, 12, or 13

```
composer require webworkerjoshua/laravel-nanoid
```

Publish the config when you want to change defaults:

```
php artisan vendor:publish --tag=nanoid-config
```

Usage
-----

[](#usage)

```
use WebworkerJoshua\LaravelNanoid\Facades\Nanoid;

$id = Nanoid::generate();
$shortId = Nanoid::generate(10);
```

The package also provides a helper:

```
$id = nanoid();
```

For custom alphabets:

```
use WebworkerJoshua\LaravelNanoid\Nanoid;

$generator = new Nanoid;
$hex = $generator->customAlphabet('0123456789abcdef', 10);

$id = $hex();
$shortId = $hex(5);
```

For a custom random byte source:

```
use WebworkerJoshua\LaravelNanoid\Nanoid;

$generator = new Nanoid;
$custom = $generator->customRandom(
    alphabet: 'abcdef',
    defaultSize: 10,
    random: fn (int $bytes): string => random_bytes($bytes),
);

$id = $custom();
```

The random callback must accept the requested byte count and return either a binary string or an iterable of integers from 0 to 255.

API Notes
---------

[](#api-notes)

- `Nanoid::generate()` and `nanoid()` generate 21 characters by default.
- `Nanoid::generate(0)` returns an empty string.
- ID sizes must be between 0 and 1024 characters.
- Custom alphabets must be non-empty and contain 256 symbols or less.
- `customAlphabet($alphabet, $size)` returns a callable that also accepts a per-call size override.
- `customRandom($alphabet, $size, $random)` follows Nano ID's rejection-sampling algorithm to avoid modulo bias.

Eloquent
--------

[](#eloquent)

Add the `HasNanoids` trait to a model to fill the configured attribute when the model is created:

```
use Illuminate\Database\Eloquent\Model;
use WebworkerJoshua\LaravelNanoid\Eloquent\HasNanoids;

class Post extends Model
{
    use HasNanoids;

    protected $fillable = [
        'title',
    ];
}
```

When the Nano ID attribute is the model key, the trait sets `$incrementing = false` and `$keyType = 'string'` during model initialization. Primary keys use a model prefix by default, so a `User` model receives IDs like `user_V1StGXR8_Z5jdHi6B-myT`.

Use a string column long enough for the prefix plus the generated ID, and add a unique index for non-primary Nano ID columns:

```
Schema::create('posts', function (Blueprint $table): void {
    $table->string('id', 64)->primary();
    $table->string('public_id', 64)->unique()->nullable();
    $table->string('title');
    $table->timestamps();
});
```

Models can override the attribute, size, alphabet, or prefix:

```
class Post extends Model
{
    use HasNanoids;

    protected $fillable = [
        'title',
    ];

    protected string $nanoidAttribute = 'public_id';

    protected int $nanoidSize = 10;

    protected string $nanoidAlphabet = '0123456789abcdef';

    protected string $nanoidPrefix = 'post_';
}
```

You can generate Nano IDs for multiple columns and configure each column independently:

```
class Session extends Model
{
    use HasNanoids;

    protected $fillable = [
        'name',
    ];

    protected array $nanoidAttributes = ['id', 'user_id'];

    protected array $nanoidPrefix = [
        'id' => 'session_',
        'user_id' => 'user_',
    ];

    protected array $nanoidSize = [
        'id' => 21,
        'user_id' => 12,
    ];

    protected array $nanoidAlphabet = [
        'user_id' => '0123456789abcdef',
    ];
}
```

Each per-column option may also define a `'*'` fallback key.

Existing attribute values are preserved. The trait does not query the database to retry collisions; enforce uniqueness with primary or unique indexes.

Configuration
-------------

[](#configuration)

```
return [
    'alphabet' => env('NANOID_ALPHABET', Nanoid::DEFAULT_ALPHABET),
    'size' => (int) env('NANOID_SIZE', Nanoid::DEFAULT_SIZE),
    'prefix' => env('NANOID_PREFIX'),
    'use_model_prefix' => filter_var(env('NANOID_USE_MODEL_PREFIX', true), FILTER_VALIDATE_BOOLEAN),
    'model_attribute' => env('NANOID_MODEL_ATTRIBUTE', 'id'),
];
```

Use the official collision calculator before reducing size or alphabet length for high-volume IDs.

Available environment variables:

- `NANOID_ALPHABET`
- `NANOID_SIZE`
- `NANOID_PREFIX`
- `NANOID_USE_MODEL_PREFIX`
- `NANOID_MODEL_ATTRIBUTE`

Testing
-------

[](#testing)

```
composer test
composer larastan
composer format
```

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance94

Actively maintained with recent releases

Popularity10

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

29d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/44984072?v=4)[Joshua Hennig](/maintainers/webworkerJoshua)[@webworkerJoshua](https://github.com/webworkerJoshua)

---

Top Contributors

[![webworkerJoshua](https://avatars.githubusercontent.com/u/44984072?v=4)](https://github.com/webworkerJoshua "webworkerJoshua (3 commits)")

---

Tags

laravelnanoidnano-idid-generator

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/webworkerjoshua-laravel-nanoid/health.svg)

```
[![Health](https://phpackages.com/badges/webworkerjoshua-laravel-nanoid/health.svg)](https://phpackages.com/packages/webworkerjoshua-laravel-nanoid)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3325.1M337](/packages/psalm-plugin-laravel)[laravel/ai

The official AI SDK for Laravel.

9782.1M153](/packages/laravel-ai)[moonshine/moonshine

Laravel administration panel

1.3k239.9k72](/packages/moonshine-moonshine)[linkxtr/laravel-qrcode

A clean, modern, and easy-to-use QR code generator for Laravel

3614.9k](/packages/linkxtr-laravel-qrcode)[tomshaw/electricgrid

A feature-rich Livewire package designed for projects that require dynamic, interactive data tables.

119.2k](/packages/tomshaw-electricgrid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)