@akinon/ui-result 0.1.0 → 0.3.0

package/dist/cjs/index.d.ts

@@ -1,6 +1,9 @@
-import type { ResultProps as AntResultProps } from 'antd';
 import * as React from 'react';
-type ResultProps = AntResultProps;
-export declare const Result: ({ children, ...props }: ResultProps) => React.JSX.Element;
-export {};
+import { IResultProps } from './types';
+/**
+ * Result component for Akinon UI.
+ * This component provides a pre-baked result element with various types, icons, and states.
+ * It also supports custom icons and extra content to fit a wide range of use cases within the Akinon design system.
+ */
+export declare const Result: ({ children, icon, ...props }: IResultProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,cAAc,EAAE,MAAM,MAAM,CAAC;AAE1D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,KAAK,WAAW,GAAG,cAAc,CAAC;AAElC,eAAO,MAAM,MAAM,2BAA4B,WAAW,sBAEzD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,MAAM,iCAAkC,YAAY,sBAShE,CAAC"}

package/dist/cjs/index.js

@@ -12,10 +12,16 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Result = void 0;
+const icons_1 = require("@akinon/icons");
 const antd_1 = require("antd");
 const React = require("react");
+/**
+ * Result component for Akinon UI.
+ * This component provides a pre-baked result element with various types, icons, and states.
+ * It also supports custom icons and extra content to fit a wide range of use cases within the Akinon design system.
+ */
 const Result = (_a) => {
-    var { children } = _a, props = __rest(_a, ["children"]);
-    return React.createElement(antd_1.Result, Object.assign({}, props), children);
+    var { children, icon } = _a, props = __rest(_a, ["children", "icon"]);
+    return (React.createElement(antd_1.Result, Object.assign({}, props, { icon: icon ? React.createElement(icons_1.Icon, { icon: icon, size: 64 }) : undefined }), children));
 };
 exports.Result = Result;

package/dist/cjs/types.d.ts

@@ -0,0 +1,39 @@
+import type { IconName } from '@akinon/icons';
+import { ResultStatusType } from 'antd/es/result';
+
+/**
+ * Interface representing the properties for the Result component.
+ */
+export interface IResultProps {
+  /**
+   * The status of the result.
+   * @default 'info'
+   */
+  status?: ResultStatusType;
+
+  /**
+   * The title of the result. `string` is strongly recommended due to the Akinon design system.
+   */
+  title?: React.ReactNode;
+
+  /**
+   * The subtitle of the result. `string` is strongly recommended due to the Akinon design system.
+   */
+  subTitle?: React.ReactNode;
+
+  /**
+   * The icon name of the icon. Only icons from `akinon/icons` are supported.
+   */
+  icon?: IconName;
+
+  /**
+   * The extra content of the result. `string` is strongly recommended due to the Akinon design system.
+   */
+  extra?: React.ReactNode;
+
+  /**
+   * The children of the result.
+   * @type {React.ReactNode}
+   */
+  children?: React.ReactNode;
+}

package/dist/esm/index.d.ts

@@ -1,6 +1,9 @@
-import type { ResultProps as AntResultProps } from 'antd';
 import * as React from 'react';
-type ResultProps = AntResultProps;
-export declare const Result: ({ children, ...props }: ResultProps) => React.JSX.Element;
-export {};
+import { IResultProps } from './types';
+/**
+ * Result component for Akinon UI.
+ * This component provides a pre-baked result element with various types, icons, and states.
+ * It also supports custom icons and extra content to fit a wide range of use cases within the Akinon design system.
+ */
+export declare const Result: ({ children, icon, ...props }: IResultProps) => React.JSX.Element;
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,cAAc,EAAE,MAAM,MAAM,CAAC;AAE1D,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,KAAK,WAAW,GAAG,cAAc,CAAC;AAElC,eAAO,MAAM,MAAM,2BAA4B,WAAW,sBAEzD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,MAAM,iCAAkC,YAAY,sBAShE,CAAC"}

package/dist/esm/index.js

@@ -9,9 +9,15 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+import { Icon } from '@akinon/icons';
 import { Result as AntResult } from 'antd';
 import * as React from 'react';
+/**
+ * Result component for Akinon UI.
+ * This component provides a pre-baked result element with various types, icons, and states.
+ * It also supports custom icons and extra content to fit a wide range of use cases within the Akinon design system.
+ */
 export const Result = (_a) => {
-    var { children } = _a, props = __rest(_a, ["children"]);
-    return React.createElement(AntResult, Object.assign({}, props), children);
+    var { children, icon } = _a, props = __rest(_a, ["children", "icon"]);
+    return (React.createElement(AntResult, Object.assign({}, props, { icon: icon ? React.createElement(Icon, { icon: icon, size: 64 }) : undefined }), children));
 };

package/dist/esm/types.d.ts

@@ -0,0 +1,39 @@
+import type { IconName } from '@akinon/icons';
+import { ResultStatusType } from 'antd/es/result';
+
+/**
+ * Interface representing the properties for the Result component.
+ */
+export interface IResultProps {
+  /**
+   * The status of the result.
+   * @default 'info'
+   */
+  status?: ResultStatusType;
+
+  /**
+   * The title of the result. `string` is strongly recommended due to the Akinon design system.
+   */
+  title?: React.ReactNode;
+
+  /**
+   * The subtitle of the result. `string` is strongly recommended due to the Akinon design system.
+   */
+  subTitle?: React.ReactNode;
+
+  /**
+   * The icon name of the icon. Only icons from `akinon/icons` are supported.
+   */
+  icon?: IconName;
+
+  /**
+   * The extra content of the result. `string` is strongly recommended due to the Akinon design system.
+   */
+  extra?: React.ReactNode;
+
+  /**
+   * The children of the result.
+   * @type {React.ReactNode}
+   */
+  children?: React.ReactNode;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/ui-result",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "private": false,
   "type": "module",
   "main": "dist/esm/index.js",
@@ -9,16 +9,15 @@
     "dist"
   ],
   "dependencies": {
-    "antd": "5.17.0"
+    "antd": "5.17.0",
+    "@akinon/icons": "0.6.0"
   },
   "devDependencies": {
     "clean-package": "2.2.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.5",
     "typescript": "^5.2.2",
-    "@akinon/typescript-config": "0.2.0",
-    "@akinon/eslint-config": "0.1.0",
-    "@akinon/vite-config": "0.4.0"
+    "@akinon/typescript-config": "0.4.0"
   },
   "peerDependencies": {
     "react": ">=18",
@@ -38,12 +37,8 @@
     "build": "pnpm run build:esm && pnpm run build:commonjs && pnpm run copy:files",
     "build:esm": "tsc --outDir dist/esm",
     "build:commonjs": "tsc --module commonjs --outDir dist/cjs",
-    "copy:files": "copyfiles -u 1 src/**/*.css dist/esm && copyfiles -u 1 src/**/*.css dist/cjs",
+    "copy:files": "copyfiles -u 1 \"src/**/*.!(ts|tsx)\" dist/esm && copyfiles -u 1 \"src/**/*.!(ts|tsx)\" dist/cjs",
     "clean": "rimraf dist/",
-    "lint": "eslint *.ts*",
-    "test": "vitest run",
-    "test:ui": "vitest --ui",
-    "test:watch": "vitest watch",
     "typecheck": "tsc --noEmit"
   }
 }