Doc (#278)

* add new action url redirect * Add action internal redirect * Add new actions - internalRed/SqlComm/JSscript * add -overview- to all actions + view/delete/update files * New Action update * Options Action update * Export Action update * Import Action update * Refresh Action update * Caption Action update * Sort Action update * Detailed filters Action update * Audit Log Action update * Update info Log Action * Update overview files * Update Save Action * Update Cancel Action * Update Back Action * merge resolve * New text component add * Commit doc * Correcao ExpressionTagHelper * Update numeric components * fix conflict option_action * Update calendar component * Update Boolean component + toc.yml correction * Update Data Item component
JJConsulting · Nov 14, 2024 · 656156e · 656156e
1 parent 64ea625
commit 656156e
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 1 deletion.
diff --git a/doc/Documentation/articles/components/boolean_component.md b/doc/Documentation/articles/components/boolean_component.md
@@ -14,4 +14,4 @@ The Check Box allows the user to check or uncheck an option, indicating a true (
 
 #### Additional Settings
 
-- Layout: Allows changing the appearance of the button created for *CheckBox*, *Switch*, and *Button*.
+- **Layout**: Allows changing the appearance of the button created for *CheckBox*, *Switch*, and *Button*.
diff --git a/doc/Documentation/articles/components/dataitem_component.md b/doc/Documentation/articles/components/dataitem_component.md
@@ -0,0 +1,58 @@
+## Data Item Component
+
+This option will be used for values in general. There will be an explanation for every option inside *Data Item Component*.
+
+To learn how to access the *Components* field : [Overview Component ](../components/overview_component.md)
+
+#### Combo Box
+
+This component allows multiple options for the user to choose from. The image below shows how it works.
+
+![](../../media/component_dataitem_checkbox_example_1.png)
+
+There is a place to include the options for your Combo Box.
+
+![](../../media/component_dataitem_checkbox_example_2.png)
+
+#### Lookup
+
+This component will allow information from another table to be selected for the current grid column.
+
+When clicking on the search field:
+
+![](../../media/component_dataitem_lookup_example_2.png)
+
+The image below shows the **Nome da Campanha** and **Data Criação**, as they were selected during the *Lookup* component registration. It is possible to change which values are displayed. *Element Map* will be used to register the search information mentioned above. *Element Name* is used to select the existing table, and *ID* and *Description* define which information will be displayed. It is important to note that the information can be changed according to the *Type* field. More information about this field can be found at the end of the page, in *Additional Settings*.
+
+The image below illustrates the display:
+
+![](../../media/component_dataitem_lookup_example_1.png) 
+
+#### Radio Button Group
+
+This component allows enabling a set of radio buttons that let the user select one option among them. The registered options can be configured according to the selection in the *Type* field. More information about this field can be found at the end of the page, in *Additional Settings*.
+
+![](../../media/component_dataitem_radiobutton_example_1.png) 
+
+#### Search Box
+
+An input field that allows the user to enter search terms to find specific information. As the user types, the component can suggest matching results to facilitate the search.
+
+![](../../media/component_dataitem_serachbox_example_1.png)
+
+#### Additional Settings
+
+- **Type**: Allows you to choose how the displayed information will be collected. Information can be selected through an *SQL Command*, manually entered by the creator, or selected from another existing dictionary via the *Element Map*.
+
+- **Grid Behavior**: Allows you to choose which information from your record will be displayed in the grid column of the data dictionary.
+
+- **First Option**: Allows you to change which option will be the first displayed in the *Combo Box*.
+
+- **Enable Multi Select**: Allows the user to select more than one value displayed in the *Combo Box*.
+
+- **Show Icon**: Allows an icon to be added next to the *Combo Box* options.
+
+- **Element Map**: Allows you to register which table and which information will be displayed when adding new information to the current dictionary. Element Name is used to select an existent table. The field ID and Description can be user to set which informations will be displayed in the grid.
+
+- **Filter**: Allows you to enable the existing filter in the table selected through the *Element Map* field.
+
diff --git a/doc/Documentation/articles/toc.yml b/doc/Documentation/articles/toc.yml
@@ -59,6 +59,8 @@
       href: components/calendar_component.md      
     - name: Boolean Components
       href: components/boolean_component.md
+    - name: Data Item Components
+      href: components/dataitem_component.md
   - name: Component Factories
     href: component_factories.md
   - name: Custom Rules

diff --git a/doc/Documentation/media/component_dataitem_checkbox_example_1.png b/doc/Documentation/media/component_dataitem_checkbox_example_1.png
diff --git a/doc/Documentation/media/component_dataitem_checkbox_example_2.png b/doc/Documentation/media/component_dataitem_checkbox_example_2.png
diff --git a/doc/Documentation/media/component_dataitem_lookup_example_1.png b/doc/Documentation/media/component_dataitem_lookup_example_1.png
diff --git a/doc/Documentation/media/component_dataitem_lookup_example_2.png b/doc/Documentation/media/component_dataitem_lookup_example_2.png
diff --git a/doc/Documentation/media/component_dataitem_radiobutton_example_1.png b/doc/Documentation/media/component_dataitem_radiobutton_example_1.png
diff --git a/doc/Documentation/media/component_dataitem_serachbox_example_1.png b/doc/Documentation/media/component_dataitem_serachbox_example_1.png