Introduction

A Directus extension for automatically calculating the value of a field based on other fields of the same item, on the client side.

Support templating, arithmetic operations. Concat strings, sum, subtract, multiply, modulo, convert to slug, currency, etc.
Can be used as an alias field.
Calculation is performed on the client side, so it would not work if the item is created/updated via direct API calls or hooks.
Lightweight. No third-party libraries.

Installation

npm i directus-extension-computed-interface

Get Started

Go to Settings, create a new field with type string or number.
In the Interface panel, choose Computed interface. There are 2 options:
1. Template: Similar to M2M interface, determine how the field is calculated. Learn more about syntax in the next section.
2. Field Mode: Choose how the value is displayed.
  - null: Default option. Show an input with the computed value but still allow manual editing.
  - Display Only: Show the computed value but will not save it to the database. Usually used for alias fields.
  - Read Only: Show an input with the computed value and disallow manual editing.
3. Prefix: a string to prefix the computed value.
4. Suffix: a string to suffix the computed value.
5. Custom CSS: an object for inline style binding. Only works with Display Only and Read Only mode. You can use this option to customize the appearance of the computed value such as font size, color, etc.

Syntax

The template consists of 2 elements: plain strings & expressions.

Plain strings are string literal, often used for text interpolation.
Expressions can contains operators, other fields & numbers. They must be enclosed by {{ and }}.

Examples

Sum 2 numbers:

{{ SUM(a, b) }}

Multiply 2 numbers:

{{ MULTIPLY(a, b) }}

Convert string to slug:

{{ SLUG(title) }}

Text interpolation:

/{{ SLUG(title) }}-{{ id }}

Complex calculation:

{{ SUM(MULTIPLY(2, x), b) }}

Available operators

Type conversion

Operator	Description
`INT(a)`	convert to integer
`FLOAT(a)`	convert to float
`STRING(a)`	convert to string
`DATE(a)`	convert to date

Format

Operator	Description
`SLUG(a)`	transform string to slug (e.g. "This is a title" → "this-is-a-title")
`CURRENCY(a)`	format number to currency (e.g. 3000 → "3,000")

Date

Operator	Description
`DATE_ISO(a)`	transform date or date-like object to ISO string
`DATE_UTC(a)`	transform date or date-like object to UTC string
`YEAR(a)`	get year of a date object, similar to `getFullYear`
`MONTH(a)`	get month of a date object, similar to `getMonth`
`GET_DATE(a)`	get date of a date object, similar to `getDate`
`DAY(a)`	get day of a date object, similar to `getDay`
`HOURS(a)`	get hours of a date object, similar to `getHours`
`MINUTES(a)`	get minutes of a date object, similar to `getMinutes`
`SECONDS(a)`	get seconds of a date object, similar to `getSeconds`
`TIME(a)`	get time of a date object, similar to `getTime`

Arithmetic

Operator	Description
`ABS(a)`	absolute
`SQRT(a)`	square root
`SUM(a)`	sum an array of numbers
`SUM(a, b)`	a + b
`AVERAGE(a)`	average value of an array of number
`SUBTRACT(a, b)`	a - b
`MULTIPLY(a, b)`	a * b
`DIVIDE(a, b)`	a / b
`REMAINDER(a, b)`	a % b
`ROUND(a, n)`	round number `a` to `n` number of decimals, similar to `toFixed`
`MAX(a, b)`	max value
`MIN(a, b)`	min value
`POWER(a, b)`	a^b

String

Operator	Description
`STR_LEN(a)`	length of string
`LOWER(a)`	to lower case
`UPPER(a)`	to upper case
`TRIM(a)`	removes whitespace at the beginning and end of string.
`CONCAT(a, b)`	concat 2 strings
`LEFT(a, b)`	extract `b` characters from the beginning of the string.
`RIGHT(a, b)`	extract `b` characters from the end of the string.

Boolean

Operator	Description
`NULL(a)`	check is null
`NOT_NULL(a)`	check is not null
`NOT(a)`	logical NOT
`EQUAL(a, b)`	a = b
`NOT_EQUAL(a, b)`	a <> b
`GT(a, b)`	a > b
`GTE(a, b)`	a >= b
`LT(a, b)`	a < b
`LTE(a, b)`	a <= b
`AND(a, b)`	logical AND
`OR(a, b)`	logical OR

Array

Operator	Description
`ARRAY_LEN(a)`	length of array

Relational

Operator	Description
`ASUM(a, b)`	Aggregated sum of O2M field. For example: calculate shopping cart total price with `ASUM(products, MULTIPLY(price, quantity))` where `products` is the O2M field in the shopping cart and `price` & `quantity` are 2 fields of `products`.

Condition

Operator	Description
`IF(A, B, C)`	return `B` if `A` is `true`, otherwise `C`

Dynamic Variables

There are 2 dynamic variables available that you can use in the expressions:

$NOW: return the current Date object. Example: {{ YEAR($NOW) }} returns the current year.
$CURRENT_USER: return the current user's id. Example: {{ EQUAL($CURRENT_USER, user) }} checks if the user field is the current user.

Limitation

Cannot parse literal strings ({{ 's' }}).

kylexyy / directus-extension-computed-interface Goto Github PK

directus-extension-computed-interface's Introduction