=====================================
Workflow Parameter Types
=====================================

This article describes the different ui widgets available through the :deco:`~artificial.workflows.decorators.parameter` decorator. These widgets will show up in the request form to allow a user to set the value of workflow parameters.

Text (default)
--------------
Defining the parameter as a string will result in the text field on the request module. There is no need to specify a uiWidget.

.. image:: _static/step_3/text_field.png


.. code-block:: python
   :caption: Usage

   from artificial.workflows.decorators import parameter, workflow


   @workflow("Text Field Workflow", "wf_text", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('text_field', {'required': True, 'uiTitle': 'Text Field'})
   async def wf_func_name(text_field: str) -> None:
       pass

Numeric
-------
Defining the parameter as an integer or float will result in the numeric field on the request module. There is no need to define a uiWidget.

.. image:: _static/step_3/numbers.png

.. code-block:: python
   :caption: Usage

   from artificial.workflows.decorators import parameter, workflow


   @workflow("Numeric Field Example", "wf_numeric", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('integer', {'required': True, 'uiTitle': 'Integer'})
   @parameter('float', {'required': True, 'uiTitle': 'Float'})
   async def wf_func_name(integer: int, float: float) -> None:
       pass

Array
-----
To create an array input, you do not need to define the UI widget. Instead, define the parameter as a ``List[str]``. Then, you can list your strings with commas.

.. image:: _static/step_3/array.png

.. code-block:: python
   :caption: Usage

   from typing import List

   from artificial.workflows.decorators import parameter, workflow


   @workflow("Array Workflow", "wf_array", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('array', {'required': False, 'uiTitle': 'Array'})
   async def wf_func_name(array: List[str]) -> None:
       pass

File Upload
-----------
To create a file upload option in the request module, the UI widget must be defined as ``'file'`` in the parameter decorator.

.. image:: _static/step_3/file_upload.png

.. code-block:: python
   :caption: Usage

   from typing import List

   from artificial.workflows.decorators import parameter, workflow


   @workflow("File Upload Workflow", "wf_file", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('files', {'required': False, 'uiTitle': 'File Upload', 'uiWidget': 'file'})
   async def wf_file(files: List[str]) -> None:
       pass

Checkbox
--------
By default, when a parameter argument is typed as a boolean, it will appear as a checkbox so no UI widget needs to be defined.

.. image:: _static/step_3/checkbox.png

.. code-block:: python
   :caption: Usage

   from artificial.workflows.decorators import parameter, workflow


   @workflow("Checkbox Workflow", "wf_checkbox", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('checkbox', {'required': False, 'uiTitle': "Checkbox"})
   async def wf_func_name(checkbox: bool) -> None:
       pass

Switch
------
By default, a boolean is a checkbox so to create a switch/toggle, you must specify the UI widget in the parameter function.

.. image:: _static/step_3/switch.png

.. code-block:: python
   :caption: Usage

   from artificial.workflows.decorators import parameter, workflow


   @workflow("Switch Workflow", "wf_switch", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('boolean_switch', {'required': False, 'uiTitle': "Boolean Switch", 'uiWidget': 'switch'})
   async def wf_func_name(boolean_switch: bool) -> None:
       pass

Select
------
To create a drop-down selection field in the request module, the UI widget does not need to be defined. Instead, defining the workflow function argument type as ``EnumOptions`` is sufficient.

.. image:: _static/step_3/select.png

.. code-block:: python
   :caption: Usage

   from enum import Enum

   from artificial.workflows.decorators import parameter, workflow


   class EnumOptions(Enum):
      _1: str = 'Option 1'
      _2: str = 'Option 2'
      _3: str = 'Option 3'
      _4: str = 'Option 4'
      _5: str = 'Option 5'


   @workflow("Select Workflow", "wf_select", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('select', {'required': False, 'uiTitle': "Select"})
   async def wf_func_name(select: EnumOptions) -> None:
       pass

Table
-----
You can create a table with set column names by defining the UI widget as ``'table'``.

.. image:: _static/step_3/table.png

.. code-block:: python
   :caption: Usage

   from dataclasses import dataclass
   from typing import List

   from artificial.workflows.decorators import parameter, workflow


   @dataclass
   class Table():
       column_1: int
       column_2: float


   @workflow("Table Workflow", "wf_table", "lab_e9ed9a16-1888-4050-a51d-9584caa0150f")
   @parameter('table', {'required': False, 'uiTitle': 'Table', 'uiWidget': 'table'})
   async def wf_func_name(table: List[Table]) -> None:
       pass