@spacego/fe-components 0.2.3 → 0.3.0

package/lib/types/hooks/index.d.ts

@@ -1,3 +1,4 @@
 export * from './use-auth.hook';
+export * from './use-descriptions.hook';
 export * from './use-nprogress.hook';
 export * from './use-permission.hook';

package/lib/types/hooks/{use-descriptions → use-descriptions.hook}/index.d.ts

@@ -1,3 +1,3 @@
-import { IDescriptionsParams, IUseDescriptions } from './index.d';
+import { IDescriptionsParams, IUseDescriptions } from './use-descriptions';
 declare const FeUseDescriptions: <DataType extends Record<string, any>>({ descriptionsItems, descriptionsData, bordered, size, rawKeyRef: externalKeyRef, className, styles, ...restProps }: IDescriptionsParams<DataType>) => IUseDescriptions;
 export default FeUseDescriptions;

package/lib/types/hooks/use-descriptions.hook/use-descriptions.d.ts

@@ -0,0 +1,151 @@
+import { DescriptionsProps, ImageProps } from 'antd';
+import { default as React } from 'react';
+/**
+ * @name 渲染类型
+ * @default default
+ * @options default:纯文本静态展示
+ *          tag:枚举tag展示，支持多个tag
+ *
+ */
+export type TRenderType = 'default' | 'tag' | 'link' | 'image';
+
+export interface IDescriptionsItem<DataType extends Record<string, any>> {
+  /**
+   * @name 标题
+   */
+  label: string | React.ReactNode;
+  /**
+   * @name 与实体映射的key
+   */
+  dataIndex: keyof DataType;
+  /**
+   * @name render 自定义渲染
+   */
+  render?: React.ReactNode | ((value: string, data: DataType) => React.ReactNode);
+  /**
+   * @name 确定这个列的唯一值,一般用于 dataIndex 重复的情况
+   */
+  key?: React.Key;
+  /**
+   * @name 描述列表栅格占位
+   * @default 1
+   */
+  colSpan?: number;
+  /**
+   * @name 内容
+   */
+  /**
+   * @name 是否开启ellipsis
+   */
+  ellipsis?: boolean | { showTitle: boolean };
+  /**
+   * @name 渲染类型
+   */
+  renderType?: TRenderType;
+  /**
+   * @name 是否隐藏
+   */
+  hidden?: boolean;
+  /**
+   *  @name 默认渲染器参数
+   */
+  defaultRenderParams?: {
+    /**
+     * @name 过滤器
+     */
+    filter?: any;
+    /**
+     * @name 过滤器参数
+     */
+    dictfilterParams?: {
+      dictList: Array<{ dataIndex: string; label: string }>;
+    };
+  };
+  /**
+   * @name tag渲染器参数
+   */
+  tagRenderParams?: {
+    /**
+     * @name 过滤器
+     */
+    filter?: any;
+    /**
+     * @name 过滤器参数
+     */
+    dictfilterParams?: {
+      dictList: Array<{ dataIndex: string; label: string }>;
+    };
+    /**
+     * @name 分割符
+     * @default |
+     */
+    separator?: string;
+    /**
+     * @name 颜色类型枚举
+     */
+    themeEnums?: Record<string, 'processing' | 'success' | 'error' | 'default'>;
+  };
+  /**
+   * @name link渲染器参数
+   */
+  linkRenderParams?: {
+    /*
+     * 标签
+     */
+    label?: string;
+    /**
+     * @name 点击事件
+     */
+    onClick?: (value: any) => void;
+  };
+  /**
+   * @name image渲染器参数
+   */
+  imageRenderParams?: ImageProps;
+}
+
+export interface IDescriptionsParams<DataType> {
+  /**
+   * @name 描述列表项
+   */
+  descriptionsItems: IDescriptionsItem<DataType>[];
+  /**
+   * @name 描述列表数据
+   */
+  descriptionsData: DataType<string, any>;
+  /**
+   * @name 是否显示边框
+   * @default true
+   */
+  bordered?: boolean;
+  /**
+   * @name 描述列表样式
+   */
+  styles?: DescriptionsProps['styles'];
+  /**
+   * @name 描述列表列数
+   * @default 3
+   */
+  column?: number;
+  /**
+   * @name 描述列表宽度
+   * @description 描述列表宽度统一设置仅增对bordered 为 true 有效
+   * @default 100%
+   */
+  descriptionsWidth?: string;
+  /**
+   * @name 描述列表大小
+   * @default small
+   */
+  size?: DescriptionsProps['size'];
+  /**
+   * @name 描述列表唯一标识
+   */
+  rawKeyRef?: React.MutableRefObject<string>;
+  /**
+   * @name 样式名
+   */
+  className?: string;
+}
+
+export interface IUseDescriptions extends DescriptionsProps { }

package/lib/types/hooks/use-form.hook/index.d.ts

@@ -0,0 +1,3 @@
+import { IFormParams, IFormProps } from './use-form.d';
+declare const FeUseForm: <DataType = Record<string, any>>(params: IFormParams) => IFormProps<DataType>;
+export default FeUseForm;

package/lib/types/hooks/{use-form/index.d.ts → use-form.hook/use-form.d.ts}

@@ -1,6 +1,6 @@
 import { FormInstance } from 'antd';
 import { default as React } from 'react';
-import { FeFormProps } from '../../fe-form/fe-form/index.d';
+import { FeFormProps } from '../../fe-form/fe-form/form.d';
 export interface IFormParams<DataType = any>
   extends FeFormProps<DataType> {
     setFormData: (data: Partial<DataType> | DataType) => void;

package/lib/types/hooks/use-permission.hook/index.d.ts

@@ -1,10 +1,10 @@
-export interface IPermissionStore {
-  /**
-   * @name 按钮权限字符串
-   */
-  btnPermissionList: string[];
-  /**
-   * @name 判断是否有权限
-   */
-  hasPermission: (permission: string | string[]) => boolean;
-}
+import { IPermissionStore } from './use-permission.d';
+/**
+ * @name 权限上下文
+ */
+declare const FePermissionContext: import('react').Context<IPermissionStore>;
+/**
+ * @name 获取权限上下文
+ */
+export declare const usePermission: () => IPermissionStore;
+export default FePermissionContext;

package/lib/types/hooks/use-permission.hook/use-permission.d.ts

@@ -0,0 +1,10 @@
+export interface IPermissionStore {
+  /**
+   * @name 按钮权限字符串
+   */
+  btnPermissionList: string[];
+  /**
+   * @name 判断是否有权限
+   */
+  hasPermission: (permission: string | string[]) => boolean;
+}

package/lib/types/index.d.ts

@@ -10,39 +10,68 @@ export * from './router';
 export * from './hooks';
 /**------------------------------------------- components ------------------------------------------- */
 export { default as FeAutoComplete } from './fe-auto-complete';
+export * from './fe-auto-complete/auto-complete.d';
 export { default as FeButton } from './fe-button';
+export * from './fe-button/button.d';
 export { default as FeCascader } from './fe-cascader';
+export * from './fe-cascader/cascader.d';
 export { default as FeCheckbox } from './fe-checkbox';
+export * from './fe-checkbox/checkbox.d';
 export { default as FeCheckboxGroup } from './fe-checkbox-group';
+export * from './fe-checkbox-group/checkbox-group.d';
 export { default as FeDatePicker } from './fe-date-picker';
+export * from './fe-date-picker/date-picker.d';
 export { default as FeDescriptionRender } from './fe-description-render';
+export * from './fe-description-render/description-render.d';
 export { default as FeDescriptions } from './fe-descriptions';
+export * from './fe-descriptions/descriptions.d';
 export { default as FeEmpty } from './fe-empty';
+export * from './fe-empty/empty.d';
 export { default as FeErrorBlock } from './fe-error-block';
+export * from './fe-error-block/error-block.d';
 export * from './fe-form';
 export { default as FeInput } from './fe-input';
+export * from './fe-input/input.d';
 export { default as FeInputNumber } from './fe-input-number';
+export * from './fe-input-number/input-number.d';
 export * from './fe-layouts';
 export { default as FeLink } from './fe-link';
+export * from './fe-link/link.d';
+export type { IFeLoadingProps } from './fe-loading';
 export { default as FeLoading } from './fe-loading';
 export { default as FeMap } from './fe-map';
+export * from './fe-map/map.d';
 export { default as FeModal } from './fe-modal';
+export * from './fe-modal/modal.d';
 export { default as FePagination } from './fe-pagination';
+export * from './fe-pagination/pagination.d';
 export { default as FePanel } from './fe-panel';
+export * from './fe-panel/panel.d';
 export { usePanelContext } from './fe-panel/use-panel-context';
 export { default as FePermission } from './fe-permission';
+export * from './fe-permission/permission.d';
 export { default as FePermissionProvider } from './fe-permission-provider';
-export { type FePermissionProviderProps } from './fe-permission-provider/index.d';
+export { type FePermissionProviderProps } from './fe-permission-provider/permission-provider.d';
 export { default as FeRadio } from './fe-radio';
+export * from './fe-radio/radio.d';
 export { default as FeRadioGroup } from './fe-radio-group';
+export * from './fe-radio-group/radio-group.d';
 export { default as FeRichText } from './fe-rich-text';
+export * from './fe-rich-text/rich-text.d';
 export { default as FeSelect } from './fe-select';
+export * from './fe-select/select.d';
 export { default as FeSwitch } from './fe-switch';
+export * from './fe-switch/switch.d';
 export * from './fe-table';
 export { default as FeTextArea } from './fe-text-area';
+export * from './fe-text-area/text-area.d';
 export { default as FeTimePicker } from './fe-time-picker';
+export * from './fe-time-picker/time-picker.d';
 export { default as FeUpload } from './fe-upload';
+export * from './fe-upload/upload.d';
 export { default as FeUploadAtomic } from './fe-upload-atomic';
+export * from './fe-upload-atomic/upload-atomic.d';
+export type { ICropRenderProps } from './fe-upload-crop';
 export { default as FeUploadCrop } from './fe-upload-crop';
 /**------------------------------------------- typings ------------------------------------------- */
 export * from './typings/index.d';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spacego/fe-components",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "🚀 A component library for fe to use.",
   "type": "module",
   "main": "lib/index.js",