@akinon/ui-notification 0.5.0 → 1.0.1

package/dist/cjs/index.d.ts

@@ -1,6 +1,19 @@
 import './index.css';
+import * as React from 'react';
 import type { openNotificationParamsType } from './types';
 export type * from './types';
-export declare const openNotification: (openNotificationParams: openNotificationParamsType) => void;
+/**
+ *
+ * The Notification component is designed to display brief messages to the user as feedback, alerts, or status updates.
+ *
+ * - **Flexible Types**: Supports various types of notifications such as `success`, `info`, and `error` for clear visual distinction.
+ * - **Customizable Placement**: Allows notifications to appear in different positions on the screen, such as `topRight`, `bottomLeft`, or `top`.
+ * - **Rich Icon Support**: Includes the ability to add meaningful icons like `info-outlined` or `warning_tri` to enhance clarity.
+ * - **Dynamic Messaging**: Displays messages dynamically through provided properties, making it adaptable for a variety of use cases.
+ *
+ * This component ensures user engagement by providing timely and relevant information in an accessible manner.
+ *
+ */
+export declare const Notifications: React.FC<openNotificationParamsType>;
 export { notification } from 'antd';
 //# 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,aAAa,CAAC;AAMrB,OAAO,KAAK,EAGV,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAEjB,mBAAmB,SAAS,CAAC;AAE7B,eAAO,MAAM,gBAAgB,2BACH,0BAA0B,KACjD,IAiBF,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAIrB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAGV,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAEjB,mBAAmB,SAAS,CAAC;AAE7B;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAClC,0BAA0B,CAoB3B,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC"}

package/dist/cjs/index.js

@@ -1,11 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.notification = exports.openNotification = void 0;
+exports.notification = exports.Notifications = void 0;
 require("./index.css");
 const icons_1 = require("@akinon/icons");
 const antd_1 = require("antd");
 const React = require("react");
-const openNotification = (openNotificationParams) => {
+/**
+ *
+ * The Notification component is designed to display brief messages to the user as feedback, alerts, or status updates.
+ *
+ * - **Flexible Types**: Supports various types of notifications such as `success`, `info`, and `error` for clear visual distinction.
+ * - **Customizable Placement**: Allows notifications to appear in different positions on the screen, such as `topRight`, `bottomLeft`, or `top`.
+ * - **Rich Icon Support**: Includes the ability to add meaningful icons like `info-outlined` or `warning_tri` to enhance clarity.
+ * - **Dynamic Messaging**: Displays messages dynamically through provided properties, making it adaptable for a variety of use cases.
+ *
+ * This component ensures user engagement by providing timely and relevant information in an accessible manner.
+ *
+ */
+const Notifications = openNotificationParams => {
     const { message, type } = openNotificationParams;
     const ICON_NAME = {
         success: 'katalogkontrol',
@@ -18,7 +30,8 @@ const openNotification = (openNotificationParams) => {
         placement: 'top',
         icon: React.createElement(icons_1.Icon, { icon: ICON_NAME[type] })
     });
+    return null;
 };
-exports.openNotification = openNotification;
+exports.Notifications = Notifications;
 var antd_2 = require("antd");
 Object.defineProperty(exports, "notification", { enumerable: true, get: function () { return antd_2.notification; } });

package/dist/cjs/types.d.ts

@@ -1,22 +1,44 @@
+/**
+ * Parameters for opening a notification.
+ */
 export type openNotificationParamsType = {
+  /**
+   * The message content of the notification.
+   */
   message: string;
+
+  /**
+   * The type of notification box to be displayed. It determines the style and icon.
+   */
   type: notificationBoxType;
 };
 
+/**
+ * Supported types of notification boxes.
+ */
 export type notificationBoxType = 'success' | 'info' | 'error';
 
+/**
+ * Supported icons for notifications.
+ */
 export type notificationIconType =
-  | 'katalogkontrol'
-  | 'info-outlined'
-  | 'warning_tri';
+  | 'katalogkontrol' // Represents a catalog control icon.
+  | 'info-outlined' // Represents an informational icon.
+  | 'warning_tri'; // Represents a warning triangle icon.
 
+/**
+ * The possible placements for a notification on the screen.
+ */
 export type NotificationPlacement = (typeof NotificationPlacements)[number];
 
+/**
+ * A list of valid placements for notifications.
+ */
 declare const NotificationPlacements: readonly [
-  'top',
-  'topLeft',
-  'topRight',
-  'bottom',
-  'bottomLeft',
-  'bottomRight'
+  'top', // Notification appears at the top-center of the screen.
+  'topLeft', // Notification appears at the top-left corner of the screen.
+  'topRight', // Notification appears at the top-right corner of the screen.
+  'bottom', // Notification appears at the bottom-center of the screen.
+  'bottomLeft', // Notification appears at the bottom-left corner of the screen.
+  'bottomRight' // Notification appears at the bottom-right corner of the screen.
 ];

package/dist/esm/index.d.ts

@@ -1,6 +1,19 @@
 import './index.css';
+import * as React from 'react';
 import type { openNotificationParamsType } from './types';
 export type * from './types';
-export declare const openNotification: (openNotificationParams: openNotificationParamsType) => void;
+/**
+ *
+ * The Notification component is designed to display brief messages to the user as feedback, alerts, or status updates.
+ *
+ * - **Flexible Types**: Supports various types of notifications such as `success`, `info`, and `error` for clear visual distinction.
+ * - **Customizable Placement**: Allows notifications to appear in different positions on the screen, such as `topRight`, `bottomLeft`, or `top`.
+ * - **Rich Icon Support**: Includes the ability to add meaningful icons like `info-outlined` or `warning_tri` to enhance clarity.
+ * - **Dynamic Messaging**: Displays messages dynamically through provided properties, making it adaptable for a variety of use cases.
+ *
+ * This component ensures user engagement by providing timely and relevant information in an accessible manner.
+ *
+ */
+export declare const Notifications: React.FC<openNotificationParamsType>;
 export { notification } from 'antd';
 //# 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,aAAa,CAAC;AAMrB,OAAO,KAAK,EAGV,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAEjB,mBAAmB,SAAS,CAAC;AAE7B,eAAO,MAAM,gBAAgB,2BACH,0BAA0B,KACjD,IAiBF,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAIrB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAGV,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAEjB,mBAAmB,SAAS,CAAC;AAE7B;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAClC,0BAA0B,CAoB3B,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC"}

package/dist/esm/index.js

@@ -2,7 +2,19 @@ import './index.css';
 import { Icon } from '@akinon/icons';
 import { notification } from 'antd';
 import * as React from 'react';
-export const openNotification = (openNotificationParams) => {
+/**
+ *
+ * The Notification component is designed to display brief messages to the user as feedback, alerts, or status updates.
+ *
+ * - **Flexible Types**: Supports various types of notifications such as `success`, `info`, and `error` for clear visual distinction.
+ * - **Customizable Placement**: Allows notifications to appear in different positions on the screen, such as `topRight`, `bottomLeft`, or `top`.
+ * - **Rich Icon Support**: Includes the ability to add meaningful icons like `info-outlined` or `warning_tri` to enhance clarity.
+ * - **Dynamic Messaging**: Displays messages dynamically through provided properties, making it adaptable for a variety of use cases.
+ *
+ * This component ensures user engagement by providing timely and relevant information in an accessible manner.
+ *
+ */
+export const Notifications = openNotificationParams => {
     const { message, type } = openNotificationParams;
     const ICON_NAME = {
         success: 'katalogkontrol',
@@ -15,5 +27,6 @@ export const openNotification = (openNotificationParams) => {
         placement: 'top',
         icon: React.createElement(Icon, { icon: ICON_NAME[type] })
     });
+    return null;
 };
 export { notification } from 'antd';

package/dist/esm/types.d.ts

@@ -1,22 +1,44 @@
+/**
+ * Parameters for opening a notification.
+ */
 export type openNotificationParamsType = {
+  /**
+   * The message content of the notification.
+   */
   message: string;
+
+  /**
+   * The type of notification box to be displayed. It determines the style and icon.
+   */
   type: notificationBoxType;
 };
 
+/**
+ * Supported types of notification boxes.
+ */
 export type notificationBoxType = 'success' | 'info' | 'error';
 
+/**
+ * Supported icons for notifications.
+ */
 export type notificationIconType =
-  | 'katalogkontrol'
-  | 'info-outlined'
-  | 'warning_tri';
+  | 'katalogkontrol' // Represents a catalog control icon.
+  | 'info-outlined' // Represents an informational icon.
+  | 'warning_tri'; // Represents a warning triangle icon.
 
+/**
+ * The possible placements for a notification on the screen.
+ */
 export type NotificationPlacement = (typeof NotificationPlacements)[number];
 
+/**
+ * A list of valid placements for notifications.
+ */
 declare const NotificationPlacements: readonly [
-  'top',
-  'topLeft',
-  'topRight',
-  'bottom',
-  'bottomLeft',
-  'bottomRight'
+  'top', // Notification appears at the top-center of the screen.
+  'topLeft', // Notification appears at the top-left corner of the screen.
+  'topRight', // Notification appears at the top-right corner of the screen.
+  'bottom', // Notification appears at the bottom-center of the screen.
+  'bottomLeft', // Notification appears at the bottom-left corner of the screen.
+  'bottomRight' // Notification appears at the bottom-right corner of the screen.
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/ui-notification",
-  "version": "0.5.0",
+  "version": "1.0.1",
   "private": false,
   "type": "module",
   "main": "dist/esm/index.js",
@@ -9,15 +9,15 @@
     "dist"
   ],
   "dependencies": {
-    "antd": "5.17.0",
-    "@akinon/icons": "0.6.0"
+    "antd": "5.22.6",
+    "@akinon/icons": "1.0.1"
   },
   "devDependencies": {
     "clean-package": "2.2.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.5",
-    "typescript": "^5.2.2",
-    "@akinon/typescript-config": "0.4.0"
+    "typescript": "*",
+    "@akinon/typescript-config": "1.0.1"
   },
   "peerDependencies": {
     "react": ">=18",