Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.1 KB

readme.md

File metadata and controls

72 lines (51 loc) · 2.1 KB

Decap CMS ID Widget

Decap CMS Widget that allows you to create permanent IDs for your content.

Widgets are inputs for the Decap CMS editor interface. It's a React component that receives user input and outputs a serialized value.

This widget allows you to create custom permalinks that can be used to generate pathnames for Decap CMS based websites. The widget mimics the behaviour of WordPress permalink input field automatically outputting correct slugs.

ID widget

Installation

  1. Install the widget
npm install decap-cms-widget-id
yarn add decap-cms-widget-id
  1. Import the Permalink widget to your Netlify CMS setup file
import { Widget as IdWidget } from 'decap-cms-widget-id';
  1. Register the widget for use
CMS.registerWidget(IdWidget);

Usage details

Inside the YML collecitons file you should uuid as new widget

collections:
  - name: "example"
    label: "Example"
    folder: "/path/to/your/folder"
    create: true
    slug: "{{slug}}"
    fields:
      - label: "ID",
        name: "id",
        widget: "uuid",
        prefix: 'post', // This allows to add a prefix to the ID

You can also use it as a JS object using Netlify CMS Manual Initialization

Example:

{
  label: 'ID',
  name: 'id',
  widget: 'uuid'
  prefix: 'post', // This allows to add a prefix to the ID
},

This widget fields:

  • prefix -> is used when you want to prefix IDs within the collection

Additional guides