Directus Extension: Human Readable ID

A Directus v10+ Interface for generating a human-readable ID for a text or string field in a collection. The ID takes the form of {adjective}-{color}-{animal}, such as spicy-blue-eagle or mean-pink-starfish.

The different components of the ID can be manually selected from all of the possible values or a custom value can be entered.

This extension is inspired by the IDs generated by coolaj86/human-readable-ids and the word lists from imsky/wordlists.

Use Case

The idea is that this provides a realtively large set of random combinations that can be used as easily-remembered codes or IDs.

Installation

View the Directus Docs for the most up to date information on installing extensions.

Usage

To use the interface, create a standard text or string field and select "Human Readable ID" as the interface for the field.

1. Create a new Standard Field in a Collection

2. Set the type as either String or Text

3. Select Human Readable ID as the Interface

4. Customize word list

You can optionally customize the delimiter used to separate the componets of the ID and the word lists for each component of the ID (adjectives, colors, and animals). You can select which words from the provided lists to include and/or add your own words to the lists.

After selecting Human Readable ID as the Interface for the field, you can set the options for the interface. By default, the delimiter is set to '-' and if no items are selected for the word lists, then all of the possible options are used.