Nodul LogoNodul Docs

NodulInput

Handling input parameters for custom nodes.


![Untitled](./nodulinput/untitled.png)

## **Node Description**

**NodulInput** - a node of the action type, necessary for creating a scenario of the **Nodul** type. This node serves as an entry point into the **Nodul** type scenario and defines the form of the scenario node, i.e., its parameters.

```<aside>```````````````````````
💡 See [Utilizing the NodulInput node to create a scenario of the Nodul type](../../introduction.md)



## **Node Configuration**

To configure the **NodulInput** node, it is necessary to fill in optional fields, including the creation of node parameters.

### Parameter Constructor

Adding parameters to the node is available by clicking the **Add parameter** button.

![Untitled 1](./nodulinput/untitled_1.png)

When adding a parameter, it is necessary to specify the **Parameter type** (e.g., string) and the **Parameter key** (e.g., Value) and then click the **Add** button.

![Untitled 2](./nodulinput/untitled_2.png)

After adding the parameter, it is necessary to define its **Name** in the respective field and, if needed, fill in optional parameters:

![Untitled 3](./nodulinput/untitled_3.png)

- Determine the requirement attribute by checking the **Required (1)** checkbox;
- Add a description of the parameter in the **Description (2)** field for subsequent tooltip display;

![Untitled 4](./nodulinput/untitled_4.png)

- Add a value in the **Default Value** field to display it in the parameter field when the node is initially opened.

### Parameter Constructor. Options

In the **Options** section, you can define additional characteristics of the parameter:

![Untitled 5](./nodulinput/untitled_5.png)

- **Min length** - the minimum allowable number of characters in the parameter's value. If the character count is less than this, the parameter will be highlighted;
- **Prefix;**
- **Fetch events** - the need to update the node's form when selecting a parameter value:

If **Change** is selected, the node's form will be updated every time the parameter is reselected.

If **Init** is selected, the node's form will be updated during the initial parameter input.

If both **Change** and **Init** are selected, the node's form will be updated every time the parameter is reselected and during the initial node opening.

### Personalization of Nodul

A scenario of the **Nodul** type, created using the **NodulInput** node, is displayed in the list of all nodes after pressing the add node buttons.

The icon of such a scenario can be personalized by filling in the fields of the **NodulInput** node:

- **Color (HEX) (1)** - color representation in HEX format;
- **Icon (svg)** **(2)** - icon representation in svg format.

![Untitled 6](./nodulinput/untitled_6.png)

Содержание

Нет заголовков