mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2025-11-20 17:48:34 +00:00
291 lines
5.0 KiB
Markdown
291 lines
5.0 KiB
Markdown
# 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:
|
|
|
|
```typescript
|
|
{
|
|
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 field for inputting passwords:
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Password',
|
|
name: 'password',
|
|
type: 'string',
|
|
required: true,
|
|
typeOptions: {
|
|
password: true,
|
|
},
|
|
default: '',
|
|
description: `User's password`,
|
|
}
|
|
```
|
|
|
|

|
|
|
|
|
|
String field with more than one row:
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Description',
|
|
name: 'description',
|
|
type: 'string',
|
|
required: true,
|
|
typeOptions: {
|
|
rows: 4,
|
|
},
|
|
default: '',
|
|
description: 'Description',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## Number
|
|
|
|
Basic configuration:
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Age',
|
|
name: 'age',
|
|
type: 'number',
|
|
required: true,
|
|
typeOptions: {
|
|
maxValue: 10,
|
|
minValue: 0,
|
|
numberStepSize: 1,
|
|
},
|
|
default: 10,
|
|
description: 'Your current age',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
Number field with decimal points:
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Amount',
|
|
name: 'amount',
|
|
type: 'number',
|
|
required: true,
|
|
typeOptions: {
|
|
numberPrecision: 2,
|
|
},
|
|
default: 10.00,
|
|
description: 'Your current amount',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## Collection
|
|
|
|
Use the `collection` type when you need to display optional fields.
|
|
|
|
```typescript
|
|
{
|
|
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: '',
|
|
},
|
|
],
|
|
}
|
|
```
|
|
|
|

|
|
|
|
|
|
## DateTime
|
|
|
|
The `dateTime` type provides a date picker.
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Modified Since',
|
|
name: 'modified_since',
|
|
type: 'dateTime',
|
|
default: '',
|
|
description: 'The date and time when the file was last modified',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## Boolean
|
|
|
|
The `boolean` type adds a toggle for entering true or false.
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Wait for Image',
|
|
name: 'waitForImage',
|
|
type: 'boolean',
|
|
default: true, // Initial state of the toggle
|
|
description: 'Whether to wait for the image or not',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## Color
|
|
|
|
The `color` type provides a color selector.
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Background Color',
|
|
name: 'backgroundColor',
|
|
type: 'color',
|
|
default: '', // Initially selected color
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## Options
|
|
|
|
The `options` type adds an options list. Users can select a single value.
|
|
|
|
```typescript
|
|
{
|
|
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',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## Multi options
|
|
|
|
The `multiOptions` type adds an options list. Users can select more than one value.
|
|
|
|
```typescript
|
|
{
|
|
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',
|
|
}
|
|
```
|
|
|
|

|
|
|
|
|
|
## Fixed collection
|
|
|
|
Use the `fixedCollection` type to group fields that are semantically related.
|
|
|
|
```typescript
|
|
{
|
|
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.',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
}
|
|
```
|
|
|
|

|
|
|
|
## JSON
|
|
|
|
```typescript
|
|
{
|
|
displayName: 'Content (JSON)',
|
|
name: 'content',
|
|
type: 'json',
|
|
default: '',
|
|
description: '',
|
|
}
|
|
```
|
|
|
|
 |