ng-dynamic-datatable 0.0.0 → 0.0.2

package/README.md

@@ -1,59 +1,134 @@
-# NgDynamicDatatable
+# dynamic-datatable
 
-This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 19.2.27.
+Config-driven Angular DataTable library that accepts columns, JSON data, and feature configuration.
 
-## Development server
+## Features
 
-To start a local development server, run:
+- Dynamic columns and data inputs
+- Sorting (column-wise)
+- Searching across visible columns
+- Pagination and rows-per-page selection
+- Row selection and select-all
+- Row action events
+- CSV and Excel export
+
+## Install
 
 ```bash
-ng serve
+npm install dynamic-datatable
 ```
 
-Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
-
-## Code scaffolding
-
-Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
-
-```bash
-ng generate component component-name
+## Usage
+
+Import the standalone component directly in your consuming component:
+
+```ts
+import { Component } from '@angular/core';
+import {
+   DynamicDatatableComponent,
+   DynamicDataTableConfig,
+   DataTableColumn
+} from 'dynamic-datatable';
+
+@Component({
+   selector: 'app-users',
+   standalone: true,
+   imports: [DynamicDatatableComponent],
+   template: `
+      <lib-dynamic-datatable
+         [config]="config"
+         [columns]="columns"
+         [data]="rows"
+         (actionSelected)="onAction($event)"
+         (selectionChange)="onSelection($event)"
+      />
+   `
+})
+export class UsersComponent {
+   rows = [
+      { id: 1, name: 'Aarav Sharma', email: 'aarav.sharma@company.in', salary: '19366.53', status: 'Resigned' },
+      { id: 2, name: 'Ananya Patel', email: 'ananya.patel@company.in', salary: '10745.32', status: 'Applied' }
+   ];
+
+   columns: DataTableColumn[] = [
+      { key: 'name', label: 'Name', sortable: true, width: '220px' },
+      { key: 'email', label: 'Email', sortable: true, width: '260px' },
+      { key: 'salary', label: 'Salary', sortable: true, width: '120px' },
+      {
+         key: 'status',
+         label: 'Status',
+         sortable: true,
+         render: (row) => `<span>${row['status']}</span>`
+      }
+   ];
+
+   config: DynamicDataTableConfig = {
+      title: 'Users',
+      features: {
+         export: true,
+         sorting: true,
+         searching: true,
+         pagination: true,
+         rowsPerPage: true,
+         actions: true,
+         checkboxSelection: true
+      },
+      rowsPerPageOptions: [5, 10, 25],
+      defaultRowsPerPage: 10,
+      exportOptions: { fileName: 'users-export', formats: ['csv', 'excel'] },
+      actions: [
+         { label: 'Details', id: 'details' },
+         { label: 'Delete', id: 'delete', danger: true }
+      ]
+   };
+
+   onAction(event: unknown): void {
+      console.log(event);
+   }
+
+   onSelection(rows: unknown[]): void {
+      console.log(rows);
+   }
+}
 ```
 
-For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
+## Component API
 
-```bash
-ng generate --help
-```
+Inputs:
 
-## Building
+- `config: DynamicDataTableConfig`
+- `columns: DataTableColumn[]`
+- `data: Record<string, unknown>[]`
 
-To build the project run:
+Outputs:
 
-```bash
-ng build
-```
+- `actionSelected`
+- `selectionChange`
+- `sortChange`
+- `pageChange`
+- `exportTriggered`
 
-This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
+Public methods:
 
-## Running unit tests
+- `refresh()`
+- `updateData(newData)`
+- `updateConfig(newConfig)`
+- `getSelectedRows()`
+- `clearSelection()`
 
-To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
+## Build
 
 ```bash
-ng test
+ng build dynamic-datatable
 ```
 
-## Running end-to-end tests
+Artifacts are generated in `dist/dynamic-datatable`.
 
-For end-to-end (e2e) testing, run:
+## Publish to npm
 
 ```bash
-ng e2e
+cd dist/dynamic-datatable
+npm publish --access public
 ```
 
-Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
-
-## Additional Resources
-
-For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+Before publishing, ensure the package name in `projects/dynamic-datatable/package.json` is unique on npm.