Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dulajdeshan/strapi-advanced-uuid

UUID field type support to Strapi with custom regular expressions
https://github.com/dulajdeshan/strapi-advanced-uuid

Last synced: 3 days ago
JSON representation

UUID field type support to Strapi with custom regular expressions

Host: GitHub
URL: https://github.com/dulajdeshan/strapi-advanced-uuid
Owner: Dulajdeshan
License: mit
Created: 2023-05-02T02:29:56.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-11-07T00:41:25.000Z (6 days ago)
Last Synced: 2024-11-08T07:05:35.274Z (5 days ago)
Language: TypeScript
Homepage:
Size: 2.24 MB
Stars: 15
Watchers: 2
Forks: 5
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Bootstrap Icons

Strapi Advanced UUID

Custom Field plugin for Strapi to generate UUID based on your regular expressions

The Strapi Advanced UUID Plugin is a custom plugin for Strapi that automatically generates a unique UUID for your content. It also allows you to generate UUID based on your regular expressions.

## ⚠️ Compatibility with Strapi versions

Starting from version 2.0.0, the Strapi Advanced UUID plugin is compatible with Strapi 5 and can't be used in Strapi 4.4+.

| Plugin version | Strapi version |
| -------------- | -------------- |
| 2.x.x | ≥ 5.0.0 |
| 1.x.x | ≥ 4.4 |

## ⚙️ Installation

To install the Strapi Advanced UUID Plugin, simply run one of the following command:

```
npm install strapi-advanced-uuid
```

```
yarn add strapi-advanced-uuid
```

## ⚡️ Usage

### How to Setup Advanced UUID Field

After installation you will find the `Advanced UUID` at the custom fields section of the content-type builder.

![strapi advanced uuid](./docs/screenshots/screenshot-1.png)

Now you can define the field attributes. `Advanced UUID` field allows you to define the custom regular expression (`UUID format`) for your field. Default UUID format will be [`UUID V4`](https://www.npmjs.com/package/uuid#uuidv4options-buffer-offset).

![strapi advanced uuid](./docs/screenshots/screenshot-2.png)

### How to Use Custom Regular Expression

![strapi advanced uuid](./docs/screenshots/screenshot-3.png)

Now You can create new records via the Admin panel, API or GraphQL, and the plugin will automatically generate a UUID for each new record created.

![strapi advanced uuid](./docs/screenshots/screenshot-4.png)

## 👍 Contribute

If you want to say **Thank You** and/or support the active development of `Strapi Advanced UUID`:

1. Add a [GitHub Star](https://github.com/Dulajdeshan/strapi-advanced-uuid/stargazers) to the project.
2. Support the project by donating a [cup of coffee](https://buymeacoff.ee/dulajdeshan).

## 🧾 License

This plugin is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for more information.