ms-data-grid 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +56 -14
  2. package/esm2022/lib/data-grid/data-grid.component.mjs +3 -3
  3. package/fesm2022/ms-data-grid.mjs +2 -2
  4. package/fesm2022/ms-data-grid.mjs.map +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -1,24 +1,66 @@
1
- # DataGrid
1
+ # 📊 Angular Mobile Sentrix Data Grid Component
2
2
 
3
- This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.2.0.
3
+ A customizable, feature-rich **data grid component** for Angular applications.
4
+ Provides flexible configuration for styling, pagination, filtering, sorting, and taskbar actions.
4
5
 
5
- ## Code scaffolding
6
+ ---
6
7
 
7
- Run `ng generate component component-name --project data-grid` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project data-grid`.
8
- > Note: Don't forget to add `--project data-grid` or else it will be added to the default project in your `angular.json` file.
8
+ ## 🚀 Installation
9
9
 
10
- ## Build
10
+ ```bash
11
+ npm install ms-data-grid
11
12
 
12
- Run `ng build data-grid` to build the project. The build artifacts will be stored in the `dist/` directory.
13
13
 
14
- ## Publishing
14
+ ## Inputs (Configuration)
15
15
 
16
- After building your library with `ng build data-grid`, go to the dist folder `cd dist/data-grid` and run `npm publish`.
16
+ | Input | Type | Description |
17
+ |-----------------------------|-----------|-------------|
18
+ | `columns` | `Array` | Defines table columns configuration. |
19
+ | `dataSet` | `Array` | Data to be displayed in the grid. |
20
+ | `evenRowsBackgroundColor` | `string` | Background color for even rows. |
21
+ | `oddRowsBackgroundColor` | `string` | Background color for odd rows. |
22
+ | `headerBackgroundColor` | `string` | Background color of the header row. |
23
+ | `sidemenuBackgroundColor` | `string` | Background color of the side menu. |
24
+ | `checkboxesBackgroundColor` | `string` | Background color of checkboxes. |
25
+ | `fontFaimly` | `string` | Font family applied to the table. |
26
+ | `showColumnsGrouping` | `boolean` | Show/hide columns grouping. |
27
+ | `leftPinnedBackgroundColor` | `string` | Background color of left pinned columns. |
28
+ | `rightPinnedBackgroundColor`| `string` | Background color of right pinned columns. |
29
+ | `bodyBackgroundColor` | `string` | Background color of table body. |
30
+ | `showVerticalBorder` | `boolean` | Show/hide vertical borders. |
31
+ | `bodyTextColor` | `string` | Color of body text. |
32
+ | `headerTextColor` | `string` | Color of header text. |
33
+ | `headerTextFontsSize` | `string` | Font size of header text. |
34
+ | `bodyTextFontsSize` | `string` | Font size of body text. |
35
+ | `bodyFontWeight` | `number` | Font weight of body text. |
36
+ | `checkedRowBackgroundColor` | `string` | Background color of selected rows. |
37
+ | `dropdownsBackgroundColor` | `string` | Background color of dropdown menus. |
38
+ | `showFilterRow` | `boolean` | Show/hide filter row. |
39
+ | `paginationConfig` | `object` | Pagination configuration. |
40
+ | `rowShadingEnabled` | `boolean` | Enable/disable row shading. |
41
+ | `singleSpaAssetsPath` | `string` | Path for single-spa assets. |
42
+ | `tableView` | `Array` | Table view configurations. |
43
+ | `filtersConfig` | `object` | Filters configuration. |
44
+ | `loading` | `boolean` | Show loading indicator. |
45
+ | `tableSearch` | `string` | Global search text. |
46
+ | `showCellDetailsBox` | `boolean` | Show/hide cell details popup. |
47
+ | `tableFilterViewId` | `string` | Selected filter view ID. |
48
+ | `selectedTableLayout` | `string` | Selected table layout. |
49
+ | `globalSearchText` | `string` | Text for global search. |
50
+ | `horizintalScrollbarWidth` | `string` | Width of horizontal scrollbar. |
51
+ | `verticalScrollbarWidth` | `string` | Width of vertical scrollbar. |
52
+ | `showTaskbar` | `boolean` | Show/hide taskbar. |
53
+ | `taskbarActions` | `Array` | Actions available in the taskbar. |
54
+ | `sortingConfig` | `object` | Sorting configuration. |
55
+ | `checkboxState` | `boolean` | Checkbox state reset flag. |
56
+ | `closeDropdown` | `boolean` | Close dropdown flag. |
17
57
 
18
- ## Running unit tests
58
+ ## Outputs (Events)
19
59
 
20
- Run `ng test data-grid` to execute the unit tests via [Karma](https://karma-runner.github.io).
60
+ | Event | Payload | Description |
61
+ |-----------------------------|---------|-------------|
62
+ | `genericEvent` | `any` | Emits generic table events. |
63
+ | `filterOptions` | `any` | Emits filter options when applied. |
64
+ | `createUpdateConfigListing` | `any` | Emits updated table configuration. |
65
+ | `sortingOrderOptions` | `any` | Emits sorting order selection. |
21
66
 
22
- ## Further help
23
-
24
- To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.