https://github.com/dwaring87/directus-extension-human-readable-id

A Directus v10+ extension (interface) for generating human-readable ids for text fields
https://github.com/dwaring87/directus-extension-human-readable-id

directus directus-extension directus-extension-interface human-readable-id

Last synced: 5 months ago
JSON representation

A Directus v10+ extension (interface) for generating human-readable ids for text fields

• Host: GitHub
• URL: https://github.com/dwaring87/directus-extension-human-readable-id
• Owner: dwaring87
• Created: 2022-07-19T21:39:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-05-30T23:58:46.000Z (about 1 year ago)
• Last Synced: 2025-10-22T10:54:14.739Z (8 months ago)
• Topics: directus, directus-extension, directus-extension-interface, human-readable-id
• Language: Vue
• Homepage:
• Size: 63.5 KB
• Stars: 17
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
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`**.

![Screenshot of the new item creation page showing the human-readable-id field](https://user-images.githubusercontent.com/7526014/183149483-a77b5f48-a574-485e-8f77-3f917dad21ce.png)

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

![Screenshot of the edit dialog showing how the different components of the id can be manually selected](https://user-images.githubusercontent.com/7526014/183149834-14643ba5-63c1-4a3f-b962-ed4f24947433.png)

This extension is inspired by the IDs generated by [coolaj86/human-readable-ids](https://git.coolaj86.com/coolaj86/human-readable-ids.js).

## 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](https://docs.directus.io/extensions/installing-extensions.html) 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**

![Screen Shot 2022-07-19 at 5 52 23 PM](https://user-images.githubusercontent.com/7526014/179855475-14a0c0c4-a0db-45f9-9a8e-0e2aada733f8.png)

**2. Set the type as either `String` or `Text`**

![Screen Shot 2022-07-19 at 5 53 27 PM](https://user-images.githubusercontent.com/7526014/179855494-54b79b19-2c7a-4939-a47e-0880288699a0.png)

**3. Select _Human Readable ID_ as the Interface**

![Screen Shot 2022-07-19 at 5 54 18 PM](https://user-images.githubusercontent.com/7526014/179855521-a64a5034-7c97-465d-9480-08ddc735e666.png)