# `slug`

slug adds a text field to the schema that is restricted to producing strings strings acceptable as Apostrophe document slugs. All docs already have a slug with with the name "slug," as required by Apostrophe. It is therefore rare that developers have need to create additional fields of this type, but it is allowed.

Text entered in a slug field is immediately lower-cased and all spaces and punctuation are replaced by dashes (-).

# Module field definition

// Configuring the `secondSlug` field in a module's `fields.add` subsection:
projectSlug: {
  label: 'Enter a unique identifier for the project',
  type: 'slug'
}

# Settings

# Required

Property	Type	Default	Description
`label`	String	n/a	Sets the visible label for the field in the UI
`type`	String	n/a	Specifies the field type (`string` for this type)

# Optional

Property	Type	Default	Description
`def`	String	n/a	The default value for the field
`following`	String/Array	n/a	The name of a field or an array of field names that will be used to automatically generate this field's value. If this field is edited to no longer match the fields it is following, it will stop responding to edits in those fields.
`help`	String	n/a	Help text for the content editor
`htmlHelp`	String	n/a	Help text with support for HTML markup
`if`	Object	`{}`	Conditions to meet before the field is active. See the guide for details.
`page`	Boolean	`false`	If `true`, then slashes are allowed since the slug field is describing a page doc
`required`	Boolean	`false`	If `true`, the field is mandatory
`readOnly`	Boolean	`false`	If `true`, prevents the user from editing the field value

TIP

If you are overriding a piece type or page type's slug field and that doc type uses a slug prefix, the slug field should include 'archived' in the following option. It is used by the slug field type to manage prefixes, though its value is not included in the slug name.

slug: {
  type: 'slug',
  label: 'Slug',
  following: [ 'title', 'archived' ],
  required: true
}

Overriding the slug field is typically only necessary if you want to change the following string fields.

# Use in templates

If adding a new field with the slug type, it is most likely not going to be used in templates, but it is allowed as a string value.

{{ data.piece.projectSlug }}

← string time →