Parsec Admin

https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils
Admin
Parsec Admin provides a collection of common utilities and React Hooks for rapid development in...
Tokens:3,468
Snippets:31
Trust Score:4.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Utility Functions Overview

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/handle-submit

A collection of utility functions for various administrative tasks.

```APIDOC
## Utility Functions

### ActionConfirm
- **Description**: Provides confirmation dialogs for actions.
- **Usage**: `actionConfirm(message, callback)`

### DeduplicationMessage
- **Description**: Manages deduplication of messages.
- **Usage**: `deduplicationMessage(message)`

### GetDateStr
- **Description**: Formats dates into strings.
- **Usage**: `getDateStr(date)`

### GetPrice
- **Description**: Formats currency values.
- **Usage**: `getPrice(amount)`

### JudgePwd
- **Description**: Validates password complexity.
- **Usage**: `judgePwd(password)`

### PageTitleHooks
- **Description**: Custom hook for managing page titles.
- **Usage**: `usePageTitle(title)`

### ReloadTableListHooks
- **Description**: Custom hook for refreshing table lists.
- **Usage**: `useReloadTableList(tableName, resetForm)`

### RenderState
- **Description**: Renders different states for UI elements.
- **Usage**: `renderState(state)`
```

--------------------------------

### handleSubmit - Form Submission Utility

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/handle-submit

Encapsulates form submission logic. It executes an asynchronous submit function, displays a success message, and triggers a table list refresh. Options allow specifying the table to refresh and whether to reset the form.

```APIDOC
## POST /api/submit

### Description
Handles form submissions by executing a provided asynchronous function, displaying success notifications, and optionally refreshing specific data tables.

### Method
POST

### Endpoint
/api/submit

### Parameters
#### Request Body
- **submitFn** (Promise<any>) - Required - The asynchronous function to execute for submission.
- **text** (string | false) - Optional - A prefix for the success message. If `false`, no success message is displayed. Defaults to "保存".
- **options** ({ tableName?: string; resetForm?: boolean }) - Optional - Configuration for table refresh. `tableName` specifies which table to refresh (defaults to 'all'), and `resetForm` (boolean) controls whether the form should be reset after submission. Defaults to `{ tableName: 'all' }`.

### Request Example
```json
{
  "submitFn": "() => Promise.resolve()",
  "text": "Save",
  "options": {
    "tableName": "users",
    "resetForm": true
  }
}
```

### Response
#### Success Response (200)
- **Promise<any>** - The result of the `submitFn`.

#### Response Example
```json
{
  "message": "Save successful",
  "data": "submission result"
}
```

#### Error Response
- **Error** - Propagates errors from the `submitFn`.
```

--------------------------------

### ActionConfirm Utility

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/action-confirm

Provides a confirmation dialog for potentially risky operations like deletion or deactivation. It allows customization of confirmation messages, styles, and post-confirmation actions such as list reloading.

```APIDOC
## ActionConfirm

### Description
Prompts a confirmation dialog before executing risky operations such as delete or disable. After clicking 'Confirm', the provided asynchronous method is executed. If successful, the list can be automatically refreshed and a success message displayed; clicking 'Cancel' aborts the operation and returns a rejection.

### API

#### Parameters

| Parameter | Description                                   | Type                     | Default Value | 
|-----------|-----------------------------------------------|--------------------------|---------------|
| fn        | Asynchronous method to execute on confirm     | `() => Promise<any>`     | -             |
| text      | Operation text, used for title and success msg| `string`                 | -             |
| options   | Other configuration options                   | `ActionConfirmOptions`   | `{}`          |

##### options.reloadList
Success after whether to refresh the list | `boolean` | `true`

##### options.template
Confirm title template, `{{text}}` is placeholder; `false` disables | `string | false` | - 

##### options.showMessage
Whether to display "Success" prompt after success | `boolean` | `true`

##### options.props
Properties passed to `Modal.confirm`          | `ModalFuncProps`         | -             |

### Return Value
`Promise<any>`. Resolves when the user clicks 'Confirm' and `fn` executes successfully, rejects when the user clicks 'Cancel'.

### Example Usage

```javascript
// Basic usage
ActionConfirm({
  fn: async () => {
    await deleteItem(id);
  },
  text: 'Delete Item'
});

// Customization example
ActionConfirm({
  fn: async () => {
    await deactivateUser(userId);
  },
  text: 'Deactivate User',
  options: {
    reloadList: false, // Do not reload list
    template: 'Are you sure you want to {{text}}?',
    showMessage: false // Do not show success message
  }
});
```

> For more usage details, refer to Ant Design's `Modal.confirm` documentation: https://ant.design/components/modal-cn/#API
```

--------------------------------

### Format Price Function in TypeScript

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/get-price

The getPrice function formats a number representing cents into a currency string in yuan. It supports specifying the number of decimal places and enabling thousand separators. The function handles rounding using ROUND_HALF_UP and supports negative numbers. It returns a string representation of the formatted price.

```typescript
declare function getPrice(num?: number, len?: number, split?: boolean): string;
```

--------------------------------

### List Refresh Hook useReloadTableList

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/reload-table-list-hooks

Provides a function to trigger table refreshes within a page, typically used for refreshing user lists.

```APIDOC
## Hook useReloadTableList

### Description
Returns a list refresh function from the route tree, used to trigger table refreshes within the page.
Refreshes the users table.

### Method
HOOK

### Endpoint
N/A (Client-side hook)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Example usage within a React component
// Assume useReloadTableList is imported and available
const reloadTable = useReloadTableList();

// To refresh the 'users' table:
reloadTable('users');

// To refresh the 'users' table and reset the form:
reloadTable('users', true);
```

### Response
#### Success Response
Type: `(tableName?: string, resetForm?: boolean) => void`
Description: A function that accepts an optional table name and a boolean to reset the form, and returns void.

#### Response Example
```javascript
// The hook returns a function, not a direct value.
// The function signature is: (tableName?: string, resetForm?: boolean) => void
```
```

--------------------------------

### Password Validation API (judgePwd)

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/judge-pwd

Validates the complexity of a password based on specified rules. It returns a Promise to integrate with form validation logic.

```APIDOC
## POST /api/utils/judgePwd

### Description
Validates password complexity: must contain uppercase and lowercase letters, numbers, special characters, be 8-30 characters long, and not have more than 3 consecutive repeating characters. Returns a `Promise` for form validation.

### Method
POST

### Endpoint
/api/utils/judgePwd

### Parameters
#### Request Body
- **value** (string) - Required - The password string to validate.
- **record** (any) - Optional - Business context (placeholder).

### Request Example
```json
{
  "value": "P@sswOrd123!",
  "record": {}
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful validation (Promise resolves).

#### Response Example
```json
{
  "message": "Password is valid."
}
```

#### Error Response (400)
- **error** (string) - Contains the error message if validation fails (Promise rejects).

#### Error Response Example
```json
{
  "error": "Password must contain at least one uppercase letter, one lowercase letter, one number, and one special character."
}
```
```

--------------------------------

### Format Date String - getDateStr (TypeScript)

Source: https://kanban.cqkqinfo.com/docs/kaiqiao-admin/utils/get-date-str

Formats a date string into a human-readable format, supporting full date and time or just the date. Returns '-' if the input is empty. It relies on the 'moment' library for parsing.

```TypeScript
declare function getDateStr(date?: string, type?: 1 | 2): string;
```
Tokens:
Raw