antd-crud-table 0.0.1 → 0.0.3

package/.github/workflows/toghpage.yml

@@ -0,0 +1,33 @@
+name: Build and Publish to GH Pages
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: 'Installing build deps'    
+      run: npm i -g pnpm
+    - name: 'Installing deps'    
+      run: pnpm i
+    - name: 'Build'
+      run: pnpm build:static
+    - name: 'Deploy'
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+        publish_dir: ./dist
+        allow_empty_commit: true

package/.github/workflows/tonpm.yml

@@ -0,0 +1,31 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+        registry-url: ['https://registry.npmjs.org']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: ${{ matrix.registry-url }}
+      - name: 'Installing build deps'
+        run: npm i -g pnpm
+      - name: 'Installing deps'
+        run: pnpm i
+      - name: 'Build'
+        run: pnpm build:lib
+      - name: 'Publish'
+        run: pnpm publish --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Maifee Ul Asad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# antd-crud-table
+Easy CRUD table with AntD (Ant Design)

package/eslint.config.js

@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import reactHooks from 'eslint-plugin-react-hooks'
+import reactRefresh from 'eslint-plugin-react-refresh'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  { ignores: ['dist'] },
+  {
+    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': [
+        'warn',
+        { allowConstantExport: true },
+      ],
+    },
+  },
+)

package/helper/post-build.js

@@ -0,0 +1,22 @@
+import { promises as fs } from 'fs';
+import path from 'path';
+import packageJson from '../package.json' assert { type: 'json' };
+import { exit } from 'process';
+
+const distPath = path.resolve('dist/lib');
+const packageJsonPath = path.join(distPath, 'package.json');
+
+(async () => {
+    try {
+        // Ensure the dist/lib directory exists
+        await fs.mkdir(distPath, { recursive: true });
+
+        // Write the package.json file to the `dist/lib` directory
+        await fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2), 'utf-8');
+
+        console.log(`package.json has been copied to ${packageJsonPath}`);
+    } catch (error) {
+        console.error('Error copying package.json:', error);
+        exit(1);
+    }
+})();

package/index.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+
+    <script async src="https://www.googletagmanager.com/gtag/js?id=G-3G1RNC5YLT"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', 'G-3G1RNC5YLT');
+    </script>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/lib/CrudTable/CrudTable.css

@@ -0,0 +1,3 @@
+.row-differentiator {
+    background-color: #0000007f;
+}

package/lib/CrudTable/CrudTable.tsx

@@ -0,0 +1,314 @@
+import { PlusOutlined, EllipsisOutlined } from '@ant-design/icons';
+import type { ActionType, ProColumns } from '@ant-design/pro-components';
+import { ProTable, ProConfigProvider } from '@ant-design/pro-components';
+import { Button, Dropdown, Tag, message, Modal, Form, Input, InputNumber, Select, Switch, DatePicker } from 'antd';
+import { useRef, useState } from 'react';
+import type { SortOrder } from 'antd/es/table/interface';
+import { format, parseISO, formatISO } from 'date-fns';
+import dayjs from 'dayjs';
+
+import './CrudTable.css';
+
+type DataType = Record<string, any>;
+type FieldType = 'string' | 'number' | 'date' | 'boolean' | 'enum' | 'custom';
+
+interface CrudColumn<T extends DataType> extends ProColumns<T> {
+  fieldType?: FieldType;
+  enumOptions?: Record<string, { text: string;[key: string]: any }>;
+  customRender?: (value: any, record: T) => React.ReactNode;
+  formConfig?: {
+    required?: boolean;
+    component?: React.ReactNode;
+    transform?: (value: any) => any;
+  };
+  fieldEditable?: boolean;
+}
+
+interface CrudTableConfig<T extends DataType> {
+  columns: CrudColumn<T>[];
+  service: {
+    getList: (params: any) => Promise<{ data: T[]; total: number }>;
+    create: (data: Partial<T>) => Promise<T>;
+    update: (id: any, data: Partial<T>) => Promise<T>;
+    delete: (id: any) => Promise<void>;
+  };
+  rowKey: keyof T;
+  title: string;
+  defaultPageSize?: number;
+}
+
+const CrudTable = <T extends DataType>(config: CrudTableConfig<T>) => {
+  const actionRef = useRef<ActionType>(null);
+  const { columns, service, rowKey, title, defaultPageSize = 5 } = config;
+  const [modalVisible, setModalVisible] = useState(false);
+  const [currentRecord, setCurrentRecord] = useState<Partial<T> | null>(null);
+  const [form] = Form.useForm();
+
+  let enhancedColumns: ProColumns<T>[] = (columns || []).map((col) => {
+    const baseColumn: ProColumns<T> = {
+      ...col,
+      dataIndex: col.dataIndex as string,
+      title: col.title,
+    };
+
+    switch (col.fieldType) {
+      case 'date':
+        return {
+          ...baseColumn,
+          valueType: 'dateTime',
+          render: (_, record) => (
+            <span>
+              {format(parseISO(record[col.dataIndex as string]), 'yyyy-MM-dd HH:mm')}
+            </span>
+          ),
+        };
+      case 'enum':
+        return {
+          ...baseColumn,
+          valueType: 'select',
+          valueEnum: col.enumOptions,
+        };
+      case 'number':
+        return {
+          ...baseColumn,
+          valueType: 'digit',
+        };
+      case 'boolean':
+        return {
+          ...baseColumn,
+          valueType: 'switch',
+          render: (_, record) => (
+            <Tag color={record[col.dataIndex as string] ? 'green' : 'red'}>
+              {record[col.dataIndex as string] ? 'Yes' : 'No'}
+            </Tag>
+          ),
+        };
+      case 'custom':
+        return {
+          ...baseColumn,
+          render: (_, record) => col.customRender?.(record[col.dataIndex as string], record),
+        };
+      default:
+        return baseColumn;
+    }
+  });
+  enhancedColumns.push({
+    title: 'Actions',
+    valueType: 'option',
+    render: (_, record: T) => [
+      <Button key="edit" type="primary" onClick={() => openModal(record)}>
+        Edit
+      </Button>,
+      <Button key="delete" type="primary" danger onClick={async () => {
+        await service.delete(record[rowKey]);
+        actionRef.current?.reload();
+      }}>
+        Delete
+      </Button>,
+    ],
+  });
+
+  const handleRequest = async (
+    params: Record<string, any>,
+    sort: Record<string, SortOrder>,
+    filter: Record<string, any>,
+  ) => {
+    try {
+      const query = {
+        ...params,
+        sortBy: Object.keys(sort)[0],
+        sortOrder: Object.values(sort)[0],
+        ...filter,
+      };
+      const { data, total } = await service.getList(query);
+      return { data, success: true, total };
+    } catch (error) {
+      message.error('Failed to fetch data');
+      return { data: [], success: false, total: 0 };
+    }
+  };
+
+  const openModal = (record?: Partial<T>) => {
+    setCurrentRecord(record || null);
+    if (record) {
+      const values = { ...record };
+      columns.forEach((col) => {
+        const field = col.dataIndex as string;
+        if (col.fieldType === 'date' && values[field]) {
+          // @ts-ignore
+          values[field] = dayjs(values[field]);
+        }
+      });
+    form.setFieldsValue(values);
+    } else {
+        form.resetFields();
+      }
+      setModalVisible(true);
+    };
+
+  const handleOk = async () => {
+    try {
+      const values = await form.validateFields();
+      const transformedValues = { ...values };
+
+      // Handle any transformations like date formatting
+      columns.forEach((col) => {
+        const field = col.dataIndex as string;
+        if (col.fieldType === 'date' && values[field]) {
+          transformedValues[field] = formatISO(values[field]);
+        }
+        if (col.formConfig?.transform) {
+          transformedValues[field] = col.formConfig.transform(values[field]);
+        }
+      });
+
+      if (currentRecord && currentRecord[rowKey]) {
+        await service.update(currentRecord[rowKey], transformedValues);
+        message.success('Updated successfully');
+      } else {
+        await service.create(transformedValues);
+        message.success('Created successfully');
+      }
+
+      setModalVisible(false);
+      actionRef.current?.reload();
+    } catch (error) {
+      console.error(error);
+      message.error('Submit failed');
+    }
+  };
+
+  const handleCancel = () => {
+    setModalVisible(false);
+  };
+
+  return (
+    <ProConfigProvider needDeps>
+      <ProTable<T>
+        headerTitle={title}
+        rowKey={rowKey as string}
+        // row classname to gray and white
+        rowClassName={(_, index) => (index % 2 === 0 && 'row-differentiator' || '')}
+        actionRef={actionRef}
+        columns={enhancedColumns}
+        request={handleRequest}
+        search={{ labelWidth: 'auto' }}
+        pagination={{ pageSize: defaultPageSize }}
+        toolBarRender={() => [
+          <Button
+            key="add"
+            type="primary"
+            icon={<PlusOutlined />}
+            onClick={() => openModal()}
+          >
+            New
+          </Button>,
+          <Dropdown
+            key="menu"
+            menu={{
+              items: [
+                { key: 'export', label: 'Export' },
+                { key: 'refresh', label: 'Refresh', onClick: () => actionRef.current?.reload() },
+              ],
+            }}
+          >
+            <Button>
+              <EllipsisOutlined />
+            </Button>
+          </Dropdown>,
+        ]}
+        options={{
+          setting: { listsHeight: 400 },
+          reload: () => actionRef.current?.reload(),
+        }}
+        dateFormatter="string"
+      />
+
+      <Modal
+        forceRender
+        title={currentRecord ? 'Edit Item' : 'Create Item'}
+        open={modalVisible}
+        onOk={handleOk}
+        onCancel={handleCancel}
+        destroyOnClose
+      >
+        <Form form={form} layout="vertical">
+          {columns.map((col) => {
+            if (!col.dataIndex) return null;
+            const name = col.dataIndex as string;
+            const label = col.title as string;
+            const fieldDisabled = !(col.fieldEditable ?? true);
+
+            switch (col.fieldType) {
+              case 'string':
+                return (
+                  <Form.Item
+                    key={name}
+                    name={name}
+                    label={label}
+                    rules={[{ required: col.formConfig?.required, message: `${label} is required` }]}
+                  >
+                    <Input disabled={fieldDisabled} />
+                  </Form.Item>
+                );
+              case 'number':
+                return (
+                  <Form.Item
+                    key={name}
+                    name={name}
+                    label={label}
+                    rules={[{ required: col.formConfig?.required, message: `${label} is required` }]}
+                  >
+                    <InputNumber style={{ width: '100%' }} disabled={fieldDisabled} />
+                  </Form.Item>
+                );
+              case 'date':
+                return (
+                  <Form.Item
+                    key={name}
+                    name={name}
+                    label={label}
+                    rules={[{ required: col.formConfig?.required, message: `${label} is required` }]}
+                  >
+                    <DatePicker style={{ width: '100%' }} showTime disabled={fieldDisabled} />
+                  </Form.Item>
+                );
+              case 'boolean':
+                return (
+                  <Form.Item
+                    key={name}
+                    name={name}
+                    label={label}
+                    valuePropName="checked"
+                  >
+                    <Switch disabled={fieldDisabled}  />
+                  </Form.Item>
+                );
+              case 'enum':
+                return (
+                  <Form.Item
+                    key={name}
+                    name={name}
+                    label={label}
+                    rules={[{ required: col.formConfig?.required, message: `${label} is required` }]}
+                  >
+                    <Select 
+                      disabled={fieldDisabled} 
+                      options={Object.entries(col.enumOptions || {}).map(([value, option]) => ({
+                        label: option.text,
+                        value,
+                    }))} />
+                  </Form.Item>
+                );
+              default:
+                return null;
+            }
+          })}
+        </Form>
+      </Modal>
+    </ProConfigProvider>
+  );
+};
+
+export default CrudTable;
+export type { CrudTableConfig, CrudColumn, DataType };

package/lib/CrudTable/CrudTableLazy.tsx

@@ -0,0 +1,27 @@
+import { Suspense, lazy } from 'react';
+import type { CrudTableConfig, DataType } from './CrudTable';
+
+const CrudTable = lazy(() => import('./CrudTable'));
+
+const CrudTableLazy = <T extends DataType>(props: CrudTableConfig<T>) => {
+  const { columns, service, rowKey, title, defaultPageSize = 5 } = props;
+  return (
+    <Suspense
+      fallback={
+        <div style={{ textAlign: 'center', padding: '2rem' }}>
+          Loading curd table w antd
+        </div>
+      }
+    >
+      <CrudTable
+        columns={columns as any}
+        service={service as any}
+        rowKey={rowKey as string}
+        title={title}
+        defaultPageSize={defaultPageSize}
+      />
+    </Suspense>
+  );
+};
+
+export default CrudTableLazy;

package/lib/main.ts

@@ -0,0 +1,5 @@
+import CrudTable from "./CrudTable/CrudTable";
+import CrudTableLazy from "./CrudTable/CrudTableLazy";
+
+export { CrudTable, CrudTableLazy };
+export type { CrudTableConfig, CrudColumn, DataType } from "./CrudTable/CrudTable";

package/package.json

@@ -1,16 +1,9 @@
 {
   "name": "antd-crud-table",
   "private": false,
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "homepage": ".",
-  "scripts": {
-    "dev": "vite",
-    "build:static": "tsc -b && vite build",
-    "build:lib": "tsc --p ./tsconfig.build.json && vite build --config vite.config.lib.ts",
-    "lint": "eslint .",
-    "preview": "vite preview"
-  },
   "devDependencies": {
     "@ant-design/icons": "^6.0.0",
     "@ant-design/pro-components": "^2.8.7",
@@ -40,5 +33,12 @@
     "dayjs": "^1.11.13",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build:static": "tsc -b && vite build",
+    "build:lib": "tsc --p ./tsconfig.build.json && vite build --config vite.config.lib.ts && node helper/post-build.js",
+    "lint": "eslint .",
+    "preview": "vite preview"
   }
-}
+}

package/src/App.css

@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}