mobigrid-module 1.1.3 → 1.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. package/README.md +43 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # mobigrid-module
2
+
3
+ A flexible and customizable data table interface module with advanced filtering, column management, and action handling capabilities.
4
+
5
+ ## Configuration Structure
6
+
7
+ The configuration object defines the structure and behavior of a data table interface. It includes filters, columns, actions, and other settings.
8
+
9
+ ### Main Properties
10
+
11
+ - **title**: The title of the configuration
12
+ - **data_url**: API endpoint for fetching data
13
+ - **Filters**: Array of filter groups for data filtering
14
+ - **columns**: Defines the table columns and their properties
15
+ - **extractColumns**: Columns used for data export
16
+ - **detailsColumns**: Columns shown in detail view
17
+
18
+ ### Filter Types
19
+
20
+ - **Select**: Dropdown with options (static or dynamic from urlSource)
21
+ - **Text**: Basic text input
22
+ - **Date**: Date picker input
23
+ - **Export**: Export functionality
24
+ - **Button**: Action buttons (e.g., search)
25
+
26
+ ### Column Properties
27
+
28
+ - **title**: Column header text
29
+ - **key**: Data field identifier
30
+ - **type**: Data type (date, money, dropdown, etc.)
31
+ - **pattern**: Format pattern (for dates)
32
+ - **actions**: Available actions for dropdown columns
33
+
34
+ ### Additional Settings
35
+
36
+ - **max_diff**: Maximum difference value
37
+ - **pagesNum**: Number of pages
38
+ - **service_path**: Service implementation path
39
+ - **authorized_profiles**: Allowed user profile IDs
40
+ - **modal_size**: Size of modal windows
41
+ - **components**: Required component names
42
+
43
+ ## Example Configuration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mobigrid-module",
3
- "version": "1.1.3",
3
+ "version": "1.1.4",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "main": "index.tsx",