@regenbio/regenbio-components-react 1.1.2 → 1.1.3

package/build/components/ActionBar/index.d.ts

@@ -0,0 +1,16 @@
+import { RbActionBarItemProps, RbActionBarProps } from "./type";
+/**
+ * RB 操作栏子项
+ *
+ * @param props 参数配置
+ * @constructor
+ */
+declare const RbActionBarItem: (props: RbActionBarItemProps) => any;
+/**
+ * RB 操作栏
+ *
+ * @param props 参数配置
+ * @constructor
+ */
+declare const RbActionBar: (props: RbActionBarProps) => any;
+export { RbActionBarItem, RbActionBar };

package/build/components/ActionBar/type.d.ts

@@ -0,0 +1,70 @@
+import React, { MutableRefObject } from "react";
+import { RbActionBarItem } from "./index";
+import { RbActionType } from "../DataTable/type";
+/**
+ * 操作栏属性
+ */
+export type RbActionBarProps = {
+    /**
+     * 最大展示数量（超出后收起）
+     */
+    max?: number;
+    /**
+     * 操作栏子项
+     */
+    children: React.ReactElement<typeof RbActionBarItem> | React.ReactElement<typeof RbActionBarItem>[];
+    /**
+     * 全局变量，用来判断当前用户是否携带对应的权限标识
+     */
+    initialState?: any;
+    /**
+     * 表格的扩展操作 Ref，传入后可以联动数据表格的 Loading 状态
+     */
+    tableRef?: MutableRefObject<RbActionType | undefined>;
+};
+/**
+ * 操作栏子项属性
+ */
+export type RbActionBarItemProps = {
+    /**
+     * 权限标识
+     */
+    sign: string;
+    /**
+     * 隐藏状态
+     */
+    hide?: boolean;
+    /**
+     * 表格的扩展操作 Ref，传入后可以联动数据表格的 Loading 状态
+     */
+    tableRef?: MutableRefObject<RbActionType | undefined>;
+    /**
+     * 是否检查权限，默认不传递则检查，此时 sign 只有 key 的作用
+     */
+    checkSign?: boolean;
+    /**
+     * 点击触发方法
+     */
+    onClick: () => void;
+    /**
+     * 内容
+     */
+    content?: React.ReactNode | string;
+    /**
+     * 二次确认参数（气泡框提示）
+     */
+    doubleCheck?: {
+        /**
+         * 是否开启
+         */
+        enable: boolean;
+        /**
+         * 标题
+         */
+        title: string;
+        /**
+         * 描述
+         */
+        description?: string;
+    };
+};

package/build/components/DataTable/constant.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    PARAMS_RECORD_TABLE: string;
+};
+export default _default;

package/build/components/DataTable/index.d.ts

@@ -0,0 +1,9 @@
+import { RbDataTableProps } from "./type";
+/**
+ * RB 数据表格
+ *
+ * @param props 参数配置
+ * @constructor
+ */
+declare const RbDataTable: <DataSource, U, ValueType = "text">(props: RbDataTableProps<DataSource, U, ValueType>) => any;
+export default RbDataTable;

package/build/components/DataTable/locales/en-US.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    'components.data-table.pagination.total': string;
+};
+export default _default;

package/build/components/DataTable/locales/zh-CN.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    'components.data-table.pagination.total': string;
+};
+export default _default;

package/build/components/DataTable/type.d.ts

@@ -0,0 +1,107 @@
+import { ActionType, ProColumns, RequestData } from "@ant-design/pro-components";
+import { ReactNode, Ref } from "react";
+import { TableProps } from "antd";
+import type { SortOrder } from "antd/lib/table/interface";
+import type { ToolBarProps } from "@ant-design/pro-table/es/components/ToolBar";
+import type { AlertRenderType } from "@ant-design/pro-table/es/components/Alert";
+import type { TableProps as RcTableProps } from "rc-table/lib/Table";
+import type { SearchConfig } from "@ant-design/pro-table/es/components/Form/FormRender";
+import type { TableSticky } from "rc-table/lib/interface";
+/**
+ * 扩展操作类型
+ */
+export type RbActionType = {
+    /**
+     * 主动开启表格等待
+     */
+    startLoading: () => void;
+    /**
+     * 主动关闭表格等待
+     */
+    finishLoading: () => void;
+} & ActionType;
+/**
+ * 数据表格属性
+ */
+export type RbDataTableProps<DataSource, U, ValueType = 'text'> = {
+    /**
+     * 行主键，默认：guid
+     */
+    rowKey?: string;
+    /**
+     * 字段配置
+     */
+    columns?: ProColumns<DataSource, ValueType>[];
+    /**
+     * 查询参数配置
+     */
+    params?: U;
+    /**
+     * 远程数据请求
+     *
+     * @param params 参数
+     * @param sort 排序
+     * @param filter 过滤
+     */
+    request: (params: U & {
+        pageSize?: number;
+        current?: number;
+        keyword?: string;
+    }, sort: Record<string, SortOrder>, filter: Record<string, (string | number)[] | null>) => Promise<Partial<RequestData<DataSource>>>;
+    /**
+     * Table action 的引用，便于自定义触发
+     */
+    actionRef?: Ref<RbActionType | undefined>;
+    /**
+     * 工具栏渲染
+     */
+    toolBarRender?: ToolBarProps<DataSource>['toolBarRender'] | false;
+    /**
+     * 行选中
+     */
+    rowSelection?: (TableProps<DataSource>['rowSelection'] & {
+        alwaysShowAlert?: boolean;
+    }) | false;
+    /**
+     * 表格警告栏
+     */
+    tableAlertOptionRender?: AlertRenderType<DataSource>;
+    /**
+     * 缓存 Key 后缀，控制同一个 URL 下的两张表不起冲突
+     */
+    cacheSuffix?: string;
+    /**
+     * 滚动条
+     */
+    scroll?: RcTableProps<ValueType>['scroll'] & {
+        scrollToFirstRowOnChange?: boolean;
+    };
+    /**
+     * 搜索
+     */
+    search?: false | SearchConfig;
+    /**
+     * 边框
+     */
+    bordered?: boolean;
+    /**
+     * 分页
+     */
+    pagination?: boolean;
+    /**
+     * 表头
+     */
+    headerTitle?: ReactNode;
+    /**
+     * 数据源
+     */
+    dataSource?: RcTableProps<DataSource>['data'];
+    /**
+     * 粘性布局
+     */
+    sticky?: boolean | TableSticky;
+    /**
+     * 国际化
+     */
+    intl: any;
+};

package/build/components/ThemeListener/index.d.ts

@@ -0,0 +1,9 @@
+import { RbThemeListenerProps } from "./type";
+/**
+ * RB 主题监听器
+ *
+ * @param props 配置参数
+ * @constructor
+ */
+declare const RbThemeListener: (props: RbThemeListenerProps) => any;
+export default RbThemeListener;

package/build/components/ThemeListener/type.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+/**
+ * 主题监听器属性
+ */
+export type RbThemeListenerProps = {
+    /**
+     * 子项
+     */
+    children?: React.ReactNode;
+};

package/build/components/ThemeSetter/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * RB 主题设置器
+ *
+ * @param props 配置参数
+ * @constructor
+ */
+declare const RbThemeSetter: (props: any) => any;
+export default RbThemeSetter;

package/build/index.d.ts

@@ -0,0 +1,34 @@
+import RbDataTable from "./components/DataTable/index";
+import { RbDataTableProps, RbActionType } from "./components/DataTable/type";
+import { RbActionBarItem, RbActionBar } from "./components/ActionBar";
+import { RbActionBarItemProps, RbActionBarProps } from "./components/ActionBar/type";
+import RbThemeSetter from "./components/ThemeSetter";
+import RbThemeListener from "./components/ThemeListener";
+import { RbThemeListenerProps } from "./components/ThemeListener/type";
+import DbUtil from "./services/utils/dbUtil";
+import ObjectUtil from "./services/utils/objectUtil";
+import EventUtil from "./services/utils/eventUtil";
+import StorageUtil from "./services/utils/storageUtil";
+import ResourceUtil from "./services/utils/resourceUtil";
+import EventEnum from "./services/enums/eventEnum";
+import StorageEnum from "./services/enums/storageEnum";
+import zhCN from "./locales/zh-CN";
+import enUS from "./locales/en-US";
+export { RbDataTable };
+export type { RbDataTableProps, RbActionType };
+export { RbActionBarItem, RbActionBar };
+export type { RbActionBarItemProps, RbActionBarProps };
+export { RbThemeSetter };
+export { RbThemeListener };
+export type { RbThemeListenerProps };
+export { DbUtil, ObjectUtil, EventUtil, StorageUtil, ResourceUtil };
+export { EventEnum, StorageEnum };
+export { zhCN, enUS };
+declare const _default: {
+    RbDataTable: <DataSource, U, ValueType = "text">(props: RbDataTableProps<DataSource, U, ValueType>) => any;
+    RbActionBarItem: (props: RbActionBarItemProps) => any;
+    RbActionBar: (props: RbActionBarProps) => any;
+    RbThemeSetter: (props: any) => any;
+    RbThemeListener: (props: RbThemeListenerProps) => any;
+};
+export default _default;