@synerise/ds-alert 0.8.41 → 0.8.43

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.8.43](https://github.com/Synerise/synerise-design/compare/@synerise/ds-alert@0.8.42...@synerise/ds-alert@0.8.43) (2024-12-13)
+
+**Note:** Version bump only for package @synerise/ds-alert
+
+
+
+
+
+## [0.8.42](https://github.com/Synerise/synerise-design/compare/@synerise/ds-alert@0.8.41...@synerise/ds-alert@0.8.42) (2024-12-11)
+
+**Note:** Version bump only for package @synerise/ds-alert
+
+
+
+
+
 ## [0.8.41](https://github.com/Synerise/synerise-design/compare/@synerise/ds-alert@0.8.40...@synerise/ds-alert@0.8.41) (2024-12-04)
 
 **Note:** Version bump only for package @synerise/ds-alert

package/README.md

@@ -30,6 +30,8 @@ import Alert from '@synerise/ds-alert'
 
 ### Notifications
 
+**DEPRECATED** Notification component will no longer be supported
+
 Notifications API offer three things:
 
   * `<Notification/>` component for styled content,

package/dist/Notification/Notification.d.ts

@@ -3,8 +3,8 @@ import { NotificationInstance } from 'antd/lib/notification';
 import type { ArgsProps, NotificationApi } from 'antd/es/notification';
 import 'antd/lib/notification/style/index.less';
 /**
- * Typings for using better autocompletion for defining an argument for `notificationOpen`'s message property.
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export type NotificationProps = {
     /** content of the notification */
     children?: JSX.Element | React.ReactNode | React.ReactNode[];
@@ -23,43 +23,18 @@ type NotificationApiHook = ReturnType<NotificationApi['useNotification']>;
 type ApiHook = NotificationApiHook[0];
 type ContextHolder = NotificationApiHook[1];
 /**
- * Component with the content of the notification.
- * Note that in order to show notification you need to use `notificationOpen`
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare function Notification({ buttonText, children, onButtonClick, onClose, icon, closeIconClassName, }: NotificationProps): JSX.Element;
 /**
- * creates a div, mounts it in getContainer and returns reference to it.
- * This is a helper function for creating a getContainer-compatible element,
- * which later should be passed to getContainer option in `antd-notification`'s api
- *
- * @param @contextHolder notification's hook api context
- * @param @getContainer where to mount styled wrapper; can be a ref=React.useRef, <div ref={ref}/>
+ * @deprecated - Notification component will no longer be supported
  **/
 export declare function mountInstance(contextHolder?: ContextHolder, { getContainer, className }?: {
     getContainer?: (() => HTMLElement) | undefined;
     className?: string | undefined;
 }): [Promise<HTMLElement>, HTMLElement, () => void];
 /**
- * Function for showing new notifications.
- * It requires proper context to be injected (see `notificationApi.useNotification`)
- * and `message` prop in its first argument.
- * Below you will find an example usage.
- * Please remember that it is on you to provide contextHolder in the right place.
- * ```
- *   import { notificationApi, Notification, notificationOpen } from '@synerise/ds-alert';
- *   const [api, contextHolder] = notificationApi.useNotification();
- *
- *   function App() {
- *     return (<div id="app">
- *       {contextHolder}
- *       <button onClick={() => notificationOpen({
- *         message: <Notification>You have been notified.</Notification>
- *       })}>
- *         Show notification
- *       </button>);
- *
- *    ReactDOM.render(<App/>, document.querySelector('#app'));
- * ```
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare function notificationOpen({ type, className, message, icon, onClick, onClose, closeIconClassName, placement, ...props }: NotificationProps, notificationApi?: ApiHook, contextHolder?: ContextHolder): Promise<void>;
 export default Notification;

package/dist/Notification/Notification.js

@@ -17,13 +17,12 @@ import Icon, { UserAddM, CloseM } from '@synerise/ds-icon';
 import * as S from './Notification.styles';
 
 /**
- * Typings for using better autocompletion for defining an argument for `notificationOpen`'s message property.
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 
 /**
- * Component with the content of the notification.
- * Note that in order to show notification you need to use `notificationOpen`
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export function Notification(_ref) {
   var buttonText = _ref.buttonText,
     _ref$children = _ref.children,
@@ -50,12 +49,7 @@ export function Notification(_ref) {
 }
 
 /**
- * creates a div, mounts it in getContainer and returns reference to it.
- * This is a helper function for creating a getContainer-compatible element,
- * which later should be passed to getContainer option in `antd-notification`'s api
- *
- * @param @contextHolder notification's hook api context
- * @param @getContainer where to mount styled wrapper; can be a ref=React.useRef, <div ref={ref}/>
+ * @deprecated - Notification component will no longer be supported
  **/
 export function mountInstance(contextHolder, _temp) {
   var _ref2 = _temp === void 0 ? {} : _temp,
@@ -82,27 +76,8 @@ export function mountInstance(contextHolder, _temp) {
 }
 
 /**
- * Function for showing new notifications.
- * It requires proper context to be injected (see `notificationApi.useNotification`)
- * and `message` prop in its first argument.
- * Below you will find an example usage.
- * Please remember that it is on you to provide contextHolder in the right place.
- * ```
- *   import { notificationApi, Notification, notificationOpen } from '@synerise/ds-alert';
- *   const [api, contextHolder] = notificationApi.useNotification();
- *
- *   function App() {
- *     return (<div id="app">
- *       {contextHolder}
- *       <button onClick={() => notificationOpen({
- *         message: <Notification>You have been notified.</Notification>
- *       })}>
- *         Show notification
- *       </button>);
- *
- *    ReactDOM.render(<App/>, document.querySelector('#app'));
- * ```
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export function notificationOpen(_x, _x2, _x3) {
   return _notificationOpen.apply(this, arguments);
 }

package/dist/Notification/Notification.styles.d.ts

@@ -1,6 +1,18 @@
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare const NotificationsContainer: import("styled-components").StyledComponent<"div", any, {}, never>;
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare const Shrink: import("styled-components").StyledComponent<"div", any, {}, never>;
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare const TextLabel: import("styled-components").StyledComponent<"div", any, {}, never>;
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare const NotificationsWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
 declare const _default: {
     NotificationsContainer: import("styled-components").StyledComponent<"div", any, {}, never>;

package/dist/Notification/Notification.styles.js

@@ -1,5 +1,9 @@
 import styled from 'styled-components';
 import { theme } from '@synerise/ds-core';
+
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export var NotificationsContainer = styled.div.withConfig({
   displayName: "Notificationstyles__NotificationsContainer",
   componentId: "sc-1ke52b0-0"
@@ -7,14 +11,26 @@ export var NotificationsContainer = styled.div.withConfig({
   var _palette;
   return (_palette = ((props == null ? void 0 : props.theme) || theme).palette) == null ? void 0 : _palette['grey-800'];
 });
+
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export var Shrink = styled.div.withConfig({
   displayName: "Notificationstyles__Shrink",
   componentId: "sc-1ke52b0-1"
 })(["flex-grow:0;"]);
+
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export var TextLabel = styled.div.withConfig({
   displayName: "Notificationstyles__TextLabel",
   componentId: "sc-1ke52b0-2"
 })(["flex-grow:1;font-size:13px;"]);
+
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export var NotificationsWrapper = styled.div.withConfig({
   displayName: "Notificationstyles__NotificationsWrapper",
   componentId: "sc-1ke52b0-3"

package/dist/index.d.ts

@@ -12,9 +12,8 @@ export declare const AlertStyles: {
     IconAlert: typeof IconAlertStyles;
 };
 /**
- * notificationApi is required for properly handling injecting ContextApi for styling and locales.
- * It's a proxy to `antd`'s `notification` module.
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export declare const notificationsApi: import("antd/lib/notification").NotificationApi;
 export type { NotificationProps } from './Notification/Notification';
 export { default as Notification } from './Notification/Notification';
@@ -28,4 +27,7 @@ export { default as InlineAlert } from './InlineAlert/InlineAlert';
 export { default as AlertInfo } from './AlertInfo/AlertInfo';
 export type { AlertSize } from './AlertInfo/AlertInfo.types';
 export { AlertMessage } from './Alert.styles';
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 export * as S from './Notification/Notification.styles';

package/dist/index.js

@@ -14,9 +14,8 @@ export var AlertStyles = {
 };
 
 /**
- * notificationApi is required for properly handling injecting ContextApi for styling and locales.
- * It's a proxy to `antd`'s `notification` module.
- */
+ * @deprecated - Notification component will no longer be supported
+ **/
 export var notificationsApi = notification;
 export { default as Notification } from './Notification/Notification';
 export { notificationOpen } from './Notification/Notification';
@@ -27,6 +26,9 @@ export { default as InlineAlert } from './InlineAlert/InlineAlert';
 export { default as AlertInfo } from './AlertInfo/AlertInfo';
 // @deprecated use AlertStyles.Alert instead
 export { AlertMessage } from './Alert.styles';
-// @deprecated use AlertStyles.Notification instead
+
+/**
+ * @deprecated - Notification component will no longer be supported
+ **/
 import * as _S from './Notification/Notification.styles';
 export { _S as S };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synerise/ds-alert",
-  "version": "0.8.41",
+  "version": "0.8.43",
   "description": "Alert UI Component for the Synerise Design System",
   "license": "ISC",
   "repository": "Synerise/synerise-design",
@@ -36,7 +36,7 @@
   "dependencies": {
     "@synerise/ds-button": "^0.22.0",
     "@synerise/ds-icon": "^0.68.0",
-    "@synerise/ds-unordered-list": "^0.3.17",
+    "@synerise/ds-unordered-list": "^0.3.18",
     "@synerise/ds-utils": "^0.31.2",
     "animate.css": "^4.1.1",
     "react-animate-height": "^2.0.23",
@@ -48,5 +48,5 @@
     "react": ">=16.9.0 <= 17.0.2",
     "styled-components": "5.0.1"
   },
-  "gitHead": "03c0625fb7b5baaa35f6633a425fb803469b6a20"
+  "gitHead": "f10ff573f65d5e70b13c695abded40a3289f792f"
 }