Properties

Properties are the characteristics of your entities. For example, a Product can have properties like name, description, price...

Syntax

You can add the properties to your entities in the backend.yml file

manifest/backend.yml

name: Blog about cats
entities:
  📝 Post:
    properties:
      - name # Short syntax for string type.
      - { name: content, type: text } # Property type specified.
      - { name: publishedAt, type: date }
      - { name: authorEmail, type: email, hidden: true } # Extra options.

Property params

You can pass arguments using the long syntax:

Option	Default	Type	Description
type	"string"	PropType	The Property type (text, number, email, location...)
hidden	false	boolean	If the property should be hidden in the API response
options	-	Object	Specific options depending on property type
validation	-	Object	The property validators that each request compares against

Property types

Manifest vision of property types goes beyond software development typing and is already built-in for real world usages. For example, the Money PropType is handier than Number for managing amounts as it comes with a currency option that only allows 2 digits after the comma.

Each PropType comes with built-in type validation.

Some of them have specific options. Here is a list of the available types:

String

A simple string.

- { name: firstName, type: string }

# Short syntax, same as above.
- firstName

Textarea

Textarea field for medium-size texts.

- { name: description, type: text }

Rich text

Rich text field for HTML content. The admin panel input can generate basic HTML tags like bold, italic, headings, links and bullet lists.

- { name: description, type: richText }

Number

A numerical value.

- { name: age, type: number }

Link

An URL that links to an external page.

- { name: website, type: link }

Money

A money field with a currency. Money properties can have up to 2 digits after the comma.

- { name: price, type: money, options: { currency: 'EUR' } }

Parameters

Option	Default	Type	Description
currency	USD	string	ISO 4217 currency code

Date

Basic date field.

- { name: startDate, type: date }

Timestamp

Timestamp field.

- { name: acquiredAt, type: timestamp }

Email

- { name: email, type: email }

Boolean

For any field with a "true or false" value.

- { name: isActive, type: boolean }

File

A file upload. Read more in the file upload doc.

- { name: document, type: file }

note

Manifest stores the absolute paths of uploaded files. Use the BASE_URL environment variable to adapt it to your domain.

Image

An image upload. The different sizes should be provided to generate several sizes of it. Read more in the image upload doc.

- {
    name: photo,
    type: image,
    options:
      { sizes: { small: { height: 90, width: 90 }, large: { width: 200 } } }
  }

note

Manifest stores the absolute paths of uploaded images. Use the BASE_URL environment variable to adapt it to your domain.

Parameters

Option	Default	Type	Description
sizes	thumbnail (80x80) medium (160x160)	ImageSizesObject	An object with each key being the name of each size and with width, height and fit optional props. The fit options works as in Sharp

Password

Password field. Most of the time you do not need to implement passwords manually as authenticable entities have built-in email and password fields to log in.

- { name: password, type: password }

warning

When setting the type as password, Manifest hashes automatically the value before storing it. Passwords should never be stored as clear text.

Choice

A given choice of options.

- { name: sex, type: choice, options: { values: [male, female] } }

# Sequential if the values are ordered in a logical sense..
- {
    name: status,
    type: choice,
    options: { values: [draft, submitted, published], sequential: true }
  }

Parameters

Option	Default	Type	Description
values	(empty)	String[]	An array of strings representing the available choices
sequential	false	boolean	Specifies if the values are ordered in a logical sense

Location

The location type consists in a object with lat and lng coordinates.

- { name: location, type: location }