Skip to content

Node user interface elements#

n8n provides a set of predefined UI components (based on a JSON file) that allows users to input all sorts of data types. The following UI elements are available in n8n.

String#

Basic configuration:

1
2
3
4
5
6
7
8
{
    displayName: Name, // The value the user sees in the UI
    name: name, // The name used to reference the element UI within the code
    type: string,
    required: true, // Whether the field is required or not
    default: 'n8n',
    description: 'The name of the user',
}

String

String field for inputting passwords:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    displayName: 'Password',
    name: 'password',
    type: 'string',
    required: true,
    typeOptions: {
        password: true,
    },
    default: '',
    description: `User's password`,
}

Password

String field with more than one row:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    displayName: 'Description',
    name: 'description',
    type: 'string',
    required: true,
    typeOptions: {
        rows: 4,
    },
    default: '',
    description: 'Description',
}

Multiple rows

Number#

Basic configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
    displayName: 'Age',
    name: 'age',
    type: 'number',
    required: true,
    typeOptions: {
        maxValue: 10,
        minValue: 0,
        numberStepSize: 1,
    },
    default: 10,
    description: 'Your current age',
}

Number

Number field with decimal points:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    displayName: 'Amount',
    name: 'amount',
    type: 'number',
    required: true,
    typeOptions: {
        numberPrecision: 2,
    },
    default: 10.00,
    description: 'Your current amount',
}

Decimal

Collection#

Use the collection type when you need to display optional fields.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    displayName: 'Filters',
    name: 'filters',
    type: 'collection',
    placeholder: 'Add Field',
    default: {},
    options: [
        {
            displayName: 'Type',
            name: 'type',
            type: 'options',
            options: [
                {
                    name: 'Automated',
                    value: 'automated',
                },
                {
                    name: 'Past',
                    value: 'past',
                },
                {
                    name: 'Upcoming',
                    value: 'upcoming',
                },
            ],
            default: '',
        },
    ],
}

Collection

DateTime#

The dateTime type provides a date picker.

1
2
3
4
5
6
7
{
    displayName: 'Modified Since',
    name: 'modified_since',
    type: 'dateTime',
    default: '',
    description: 'The date and time when the file was last modified',
}

DateTime

Boolean#

The boolean type adds a toggle for entering true or false.

1
2
3
4
5
6
7
{
    displayName: 'Wait for Image',
    name: 'waitForImage',
    type: 'boolean',
    default: true, // Initial state of the toggle
    description: 'Whether to wait for the image or not',
}

Boolean

Color#

The color type provides a color selector.

1
2
3
4
5
6
{
    displayName: 'Background Color',
    name: 'backgroundColor',
    type: 'color',
    default: '', // Initially selected color
}

Color

Options#

The options type adds an options list. Users can select a single value.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
    displayName: 'Resource',
    name: 'resource',
    type: 'options',
    options: [
        {
            name: 'Image',
            value: 'image',
        },
        {
            name: 'Template',
            value: 'template',
        },
    ],
    default: 'image', // The initially selected option
    description: 'Resource to consume',
}

Options

Multi options#

The multiOptions type adds an options list. Users can select more than one value.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
    displayName: 'Events',
    name: 'events',
    type: 'multiOptions',
    options: [
        {
            name: 'Plan Created',
            value: 'planCreated',
        },
        {
            name: 'Plan Deleted',
            value: 'planDeleted',
        },
    ],
    default: [], // Initially selected options
    description: 'The events to be monitored',
}

Multioptions

Fixed collection#

Use the fixedCollection type to group fields that are semantically related.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    displayName: 'Metadata',
    name: 'metadataUi',
    placeholder: 'Add Metadata',
    type: 'fixedCollection',
    default: '',
    typeOptions: {
        multipleValues: true,
    },
    description: '',
    options: [
        {
            name: 'metadataValues',
            displayName: 'Metadata',
            values: [
                {
                    displayName: 'Name',
                    name: 'name',
                    type: 'string',
                    default: 'Name of the metadata key to add.',
                },
                {
                    displayName: 'Value',
                    name: 'value',
                    type: 'string',
                    default: '',
                    description: 'Value to set for the metadata key.',
                },
            ],
        },
    ],
}

Fixed collection

JSON#

1
2
3
4
5
6
7
{
    displayName: 'Content (JSON)',
    name: 'content',
    type: 'json',
    default: '',
    description: '',
}

JSON