@aglyn/shared-ui-snackstack 1.0.0-beta.143

package/src/lib/SnackbarProvider.js

@@ -0,0 +1,272 @@
+import { _ as _extends } from "@swc/helpers/_/_extends";
+import { _ as _object_without_properties_loose } from "@swc/helpers/_/_object_without_properties_loose";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { createElement as _createElement } from "react";
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { createChainedFunction } from "@aglyn/shared-util-tools";
+import clsx from "clsx";
+import { Component } from "react";
+import { createPortal } from "react-dom";
+import SnackbarContainer from "./SnackbarContainer.js";
+import SnackbarContext from "./SnackbarContext.js";
+import SnackbarItem from "./SnackbarItem/index.js";
+import { DEFAULTS, isDefined, merge, MESSAGES, omitContainerKeys, originKeyExtractor, REASONS, transformer } from "./utils/constants.js";
+import warning from "./utils/warning.js";
+let SnackbarProvider = class SnackbarProvider extends Component {
+    get maxSnack() {
+        return this.props.maxSnack || DEFAULTS.maxSnack;
+    }
+    render() {
+        const { contextValue } = this.state;
+        const _this_props = this.props, { maxSnack: dontspread1, allowDuplicate: dontspread2, variant: dontspread3, anchorOrigin: dontspread4, iconVariant, dense, hideIconVariant, domRoot, children, classes = {} } = _this_props, props = _object_without_properties_loose(_this_props, [
+            "maxSnack",
+            "allowDuplicate",
+            "variant",
+            "anchorOrigin",
+            "iconVariant",
+            "dense",
+            "hideIconVariant",
+            "domRoot",
+            "children",
+            "classes"
+        ]);
+        const categ = this.state.snacks.reduce((acc, current)=>{
+            const category = originKeyExtractor(current.anchorOrigin);
+            const existingOfCategory = acc[category] || [];
+            return _extends({}, acc, {
+                [category]: [
+                    ...existingOfCategory,
+                    current
+                ]
+            });
+        }, {});
+        const snackbars = Object.keys(categ).map((origin)=>{
+            const snacks = categ[origin];
+            return /*#__PURE__*/ _jsx(SnackbarContainer, {
+                dense: Boolean(dense),
+                anchorOrigin: snacks[0].anchorOrigin,
+                className: clsx(classes.containerRoot, classes[transformer.toContainerAnchorOrigin(origin)]),
+                children: snacks.map((snack)=>/*#__PURE__*/ _createElement(SnackbarItem, _extends({}, props, {
+                        key: snack.snackbarId,
+                        snack: snack,
+                        dense: Boolean(dense),
+                        iconVariant: iconVariant,
+                        hideIconVariant: hideIconVariant,
+                        classes: omitContainerKeys(classes),
+                        onClose: this.handleCloseSnack,
+                        onExited: createChainedFunction([
+                            this.handleExitedSnack,
+                            this.props.onExited
+                        ]),
+                        onEntered: createChainedFunction([
+                            this.handleEnteredSnack,
+                            this.props.onEntered
+                        ])
+                    })))
+            }, origin);
+        });
+        return /*#__PURE__*/ _jsxs(SnackbarContext.Provider, {
+            value: contextValue,
+            children: [
+                children,
+                domRoot ? /*#__PURE__*/ createPortal(snackbars, domRoot) : snackbars
+            ]
+        });
+    }
+    constructor(props){
+        super(props), /**
+   * Adds a new snackbar to the queue to be presented. Returns generated or user
+   * defined snackbarId referencing the new snackbar or null
+   */ this.enqueueSnackbar = (message, opts = {})=>{
+            const { snackbarId, allowDuplicate } = opts, options = _object_without_properties_loose(opts, [
+                "snackbarId",
+                "allowDuplicate"
+            ]);
+            const hasSpecifiedKey = isDefined(snackbarId);
+            const id = hasSpecifiedKey ? snackbarId : new Date().getTime() + Math.random();
+            const merger = merge(options, this.props, DEFAULTS);
+            const snack = _extends({
+                snackbarId: id
+            }, options, {
+                message,
+                open: true,
+                entered: false,
+                requestClose: false,
+                variant: merger('variant'),
+                anchorOrigin: merger('anchorOrigin'),
+                autoHideDuration: merger('autoHideDuration')
+            });
+            if (options.persist) {
+                snack.autoHideDuration = undefined;
+            }
+            this.setState((state)=>{
+                if (allowDuplicate === undefined && this.props.allowDuplicate || allowDuplicate) {
+                    const compareFunction = (item)=>hasSpecifiedKey ? item.snackbarId === snackbarId : item.message === message;
+                    const inQueue = state.queue.findIndex(compareFunction) > -1;
+                    const inView = state.snacks.findIndex(compareFunction) > -1;
+                    if (inQueue || inView) {
+                        return state;
+                    }
+                }
+                return this.handleDisplaySnack(_extends({}, state, {
+                    queue: [
+                        ...state.queue,
+                        snack
+                    ]
+                }));
+            });
+            return id;
+        }, /**
+   * Close snackbar with the given snackbarId
+   */ this.closeSnackbar = (snackbarId)=>{
+            // call individual snackbar onClose callback passed through options parameter
+            const toBeClosed = this.state.snacks.find((item)=>item.snackbarId === snackbarId);
+            if (isDefined(snackbarId) && toBeClosed && toBeClosed.onClose) {
+                toBeClosed.onClose(null, REASONS.INSTRUCTED, snackbarId);
+            }
+            this.handleCloseSnack(null, REASONS.INSTRUCTED, snackbarId);
+        }, /**
+   * Reducer: Display snack if there's space for it. Otherwise, immediately
+   * begin dismissing the oldest message to start showing the new one.
+   */ this.handleDisplaySnack = (state)=>{
+            const { snacks } = state;
+            if (snacks.length >= this.maxSnack) {
+                return this.handleDismissOldest(state);
+            }
+            return this.processQueue(state);
+        }, /**
+   * Reducer: Display items (notifications) in the queue if there's space for them.
+   */ this.processQueue = (state)=>{
+            const { queue, snacks } = state;
+            if (queue.length > 0) {
+                return _extends({}, state, {
+                    snacks: [
+                        ...snacks,
+                        queue[0]
+                    ],
+                    queue: queue.slice(1, queue.length)
+                });
+            }
+            return state;
+        }, /**
+   * Reducer: Hide oldest snackbar on the screen because there exists a new one which we have to
+   * display.
+   * (ignoring the one with 'persist' flag. i.e. explicitly told by user not to get dismissed).
+   *
+   * Note 1: If there is already a message leaving the screen, no new messages are dismissed.
+   * Note 2: If the oldest message has not yet entered the screen, only a request to close the
+   *         snackbar is made. Once it entered the screen, it will be immediately dismissed.
+   */ this.handleDismissOldest = (state)=>{
+            if (state.snacks.some((item)=>!item.open || item.requestClose)) {
+                return state;
+            }
+            let popped = false;
+            let ignore = false;
+            const persistentCount = state.snacks.reduce((acc, current)=>acc + (current.open && current.persist ? 1 : 0), 0);
+            if (persistentCount === this.maxSnack) {
+                warning(MESSAGES.NO_PERSIST_ALL);
+                ignore = true;
+            }
+            const snacks = state.snacks.map((item)=>{
+                if (!popped && (!item.persist || ignore)) {
+                    popped = true;
+                    if (!item.entered) {
+                        return _extends({}, item, {
+                            requestClose: true
+                        });
+                    }
+                    if (item.onClose) item.onClose(null, REASONS.MAXSNACK, item.snackbarId);
+                    if (this.props.onClose) this.props.onClose(null, REASONS.MAXSNACK, item.snackbarId);
+                    return _extends({}, item, {
+                        open: false
+                    });
+                }
+                return _extends({}, item);
+            });
+            return _extends({}, state, {
+                snacks
+            });
+        }, /**
+   * Set the entered state of the snackbar with the given snackbarId.
+   */ this.handleEnteredSnack = (node, isAppearing, snackbarId)=>{
+            if (!isDefined(snackbarId)) {
+                throw new Error('handleEnteredSnack Cannot be called with undefined snackbarId');
+            }
+            this.setState(({ snacks })=>({
+                    snacks: snacks.map((item)=>item.snackbarId === snackbarId ? _extends({}, item, {
+                            entered: true
+                        }) : _extends({}, item))
+                }));
+        }, /**
+   * Hide a snackbar after its timeout.
+   */ this.handleCloseSnack = (event, reason, snackbarId)=>{
+            // should not use createChainedFunction for onClose.
+            // because this.closeSnackbar called this function
+            if (this.props.onClose) {
+                this.props.onClose(event, reason, snackbarId);
+            }
+            if (reason === REASONS.CLICKAWAY) return;
+            const shouldCloseAll = snackbarId === undefined;
+            this.setState(({ snacks, queue })=>({
+                    snacks: snacks.map((item)=>{
+                        if (!shouldCloseAll && item.snackbarId !== snackbarId) {
+                            return _extends({}, item);
+                        }
+                        return item.entered ? _extends({}, item, {
+                            open: false
+                        }) : _extends({}, item, {
+                            requestClose: true
+                        });
+                    }),
+                    queue: queue.filter((item)=>item.snackbarId !== snackbarId)
+                }));
+        }, /**
+   * When we set open attribute of a snackbar to false (i.e. after we hide a snackbar),
+   * it leaves the screen and immediately after leaving animation is done, this method
+   * gets called. We remove the hidden snackbar from state and then display notifications
+   * waiting in the queue (if any). If after this process the queue is not empty, the
+   * oldest message is dismissed.
+   */ // @ts-expect-error — handler accepts extra snackbarId params beyond the typed signature
+        this.handleExitedSnack = (event, snackbarId1, snackbarId2)=>{
+            const snackbarId = snackbarId1 || snackbarId2;
+            if (!isDefined(snackbarId)) {
+                throw new Error('handleExitedSnack Cannot be called with undefined snackbarId');
+            }
+            this.setState((state)=>{
+                const newState = this.processQueue(_extends({}, state, {
+                    snacks: state.snacks.filter((item)=>item.snackbarId !== snackbarId)
+                }));
+                if (newState.queue.length === 0) {
+                    return newState;
+                }
+                return this.handleDismissOldest(newState);
+            });
+        };
+        this.state = {
+            snacks: [],
+            queue: [],
+            contextValue: {
+                enqueueSnackbar: this.enqueueSnackbar.bind(this),
+                closeSnackbar: this.closeSnackbar.bind(this)
+            }
+        };
+    }
+};
+export { SnackbarProvider };
+export default SnackbarProvider;
+
+//# sourceMappingURL=SnackbarProvider.js.map

package/src/lib/SnackbarProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/shared/ui/snackstack/src/lib/SnackbarProvider.tsx"],"sourcesContent":["/**\n * @license\n * Copyright 2022 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {createChainedFunction} from '@aglyn/shared-util-tools'\nimport clsx from 'clsx'\nimport {Component} from 'react'\nimport {createPortal} from 'react-dom'\nimport SnackbarContainer from './SnackbarContainer'\nimport SnackbarContext from './SnackbarContext'\nimport SnackbarItem from './SnackbarItem'\nimport type {\n  OptionsObject,\n  ProviderContext,\n  RequiredBy,\n  SnackbarId,\n  SnackbarMessage,\n  SnackbarProviderProps,\n  TransitionHandlerProps,\n} from './types'\nimport {\n  DEFAULTS,\n  isDefined,\n  merge,\n  MESSAGES,\n  omitContainerKeys,\n  originKeyExtractor,\n  REASONS,\n  transformer,\n} from './utils/constants'\nimport warning from './utils/warning'\n\n\ntype Reducer = (state: State) => State;\ntype SnacksByPosition = {[snackbarId: string]: Snack[]};\n\nexport interface Snack extends RequiredBy<OptionsObject, 'snackbarId' | 'variant' | 'anchorOrigin'> {\n  message: SnackbarMessage;\n  open: boolean;\n  entered: boolean;\n  requestClose: boolean;\n}\n\ninterface State {\n  snacks: Snack[];\n  queue: Snack[];\n  contextValue: ProviderContext;\n}\n\nclass SnackbarProvider extends Component<SnackbarProviderProps, State> {\n\n  get maxSnack(): number {\n    return this.props.maxSnack || DEFAULTS.maxSnack\n  }\n\n  constructor(props: SnackbarProviderProps) {\n    super(props)\n    this.state = {\n      snacks: [],\n      queue: [],\n      contextValue: {\n        enqueueSnackbar: this.enqueueSnackbar.bind(this),\n        closeSnackbar: this.closeSnackbar.bind(this),\n      },\n    }\n  }\n\n  /**\n   * Adds a new snackbar to the queue to be presented. Returns generated or user\n   * defined snackbarId referencing the new snackbar or null\n   */\n  public enqueueSnackbar = (message: SnackbarMessage, opts: OptionsObject = {}): SnackbarId => {\n    const {\n      snackbarId,\n      allowDuplicate,\n      ...options\n    } = opts\n\n    const hasSpecifiedKey = isDefined(snackbarId)\n    const id = hasSpecifiedKey ? (snackbarId as SnackbarId) : new Date().getTime() + Math.random()\n\n    const merger = merge(options, this.props, DEFAULTS)\n    const snack: Snack = {\n      snackbarId: id,\n      ...options,\n      message,\n      open: true,\n      entered: false,\n      requestClose: false,\n      variant: merger('variant'),\n      anchorOrigin: merger('anchorOrigin'),\n      autoHideDuration: merger('autoHideDuration'),\n    }\n\n    if (options.persist) {\n      snack.autoHideDuration = undefined\n    }\n\n    this.setState((state) => {\n      if ((allowDuplicate === undefined && this.props.allowDuplicate) || allowDuplicate) {\n        const compareFunction = (item: Snack): boolean => (\n          hasSpecifiedKey ? item.snackbarId === snackbarId : item.message === message\n        )\n\n        const inQueue = state.queue.findIndex(compareFunction) > -1\n        const inView = state.snacks.findIndex(compareFunction) > -1\n        if (inQueue || inView) {\n          return state\n        }\n      }\n\n      return this.handleDisplaySnack({\n        ...state,\n        queue: [...state.queue, snack],\n      })\n    })\n\n    return id\n  }\n\n  /**\n   * Close snackbar with the given snackbarId\n   */\n  public closeSnackbar: ProviderContext['closeSnackbar'] = (snackbarId) => {\n    // call individual snackbar onClose callback passed through options parameter\n    const toBeClosed = this.state.snacks.find(item => item.snackbarId === snackbarId)\n    if (isDefined(snackbarId) && toBeClosed && toBeClosed.onClose) {\n      toBeClosed.onClose(null, REASONS.INSTRUCTED, snackbarId)\n    }\n\n    this.handleCloseSnack(null, REASONS.INSTRUCTED, snackbarId)\n  }\n\n  public render(): JSX.Element {\n    const {contextValue} = this.state\n    const {\n      maxSnack: dontspread1,\n      allowDuplicate: dontspread2,\n      variant: dontspread3,\n      anchorOrigin: dontspread4,\n      iconVariant,\n      dense,\n      hideIconVariant,\n      domRoot,\n      children,\n      classes = {},\n      ...props\n    } = this.props\n\n    const categ = this.state.snacks.reduce<SnacksByPosition>((acc, current) => {\n      const category = originKeyExtractor(current.anchorOrigin)\n      const existingOfCategory = acc[category] || []\n      return {\n        ...acc,\n        [category]: [...existingOfCategory, current],\n      }\n    }, {})\n\n    const snackbars = Object.keys(categ).map((origin) => {\n      const snacks = categ[origin]\n      return (\n        <SnackbarContainer\n          key={origin}\n          dense={Boolean(dense)}\n          anchorOrigin={snacks[0].anchorOrigin}\n          className={clsx(\n            classes.containerRoot,\n            classes[transformer.toContainerAnchorOrigin(origin)],\n          )}\n        >\n          {snacks.map(snack => (\n            <SnackbarItem\n              {...props}\n              key={snack.snackbarId}\n              snack={snack}\n              dense={Boolean(dense)}\n              iconVariant={iconVariant}\n              hideIconVariant={hideIconVariant}\n              classes={omitContainerKeys(classes)}\n              onClose={this.handleCloseSnack}\n              onExited={createChainedFunction([this.handleExitedSnack, this.props.onExited])}\n              onEntered={createChainedFunction([this.handleEnteredSnack, this.props.onEntered])}\n            />\n          ))}\n        </SnackbarContainer>\n      )\n    })\n\n    return (\n      <SnackbarContext.Provider value={contextValue}>\n        {children}\n        {domRoot ? createPortal(snackbars, domRoot) : snackbars}\n      </SnackbarContext.Provider>\n    )\n  }\n\n\n  /**\n   * Reducer: Display snack if there's space for it. Otherwise, immediately\n   * begin dismissing the oldest message to start showing the new one.\n   */\n  private handleDisplaySnack: Reducer = (state) => {\n    const {snacks} = state\n    if (snacks.length >= this.maxSnack) {\n      return this.handleDismissOldest(state)\n    }\n    return this.processQueue(state)\n  }\n\n  /**\n   * Reducer: Display items (notifications) in the queue if there's space for them.\n   */\n  private processQueue: Reducer = (state) => {\n    const {queue, snacks} = state\n    if (queue.length > 0) {\n      return {\n        ...state,\n        snacks: [...snacks, queue[0]],\n        queue: queue.slice(1, queue.length),\n      }\n    }\n    return state\n  }\n\n  /**\n   * Reducer: Hide oldest snackbar on the screen because there exists a new one which we have to\n   * display.\n   * (ignoring the one with 'persist' flag. i.e. explicitly told by user not to get dismissed).\n   *\n   * Note 1: If there is already a message leaving the screen, no new messages are dismissed.\n   * Note 2: If the oldest message has not yet entered the screen, only a request to close the\n   *         snackbar is made. Once it entered the screen, it will be immediately dismissed.\n   */\n  private handleDismissOldest: Reducer = (state) => {\n    if (state.snacks.some(item => !item.open || item.requestClose)) {\n      return state\n    }\n\n    let popped = false\n    let ignore = false\n\n    const persistentCount = state.snacks.reduce((acc, current) => (\n      acc + (current.open && current.persist ? 1 : 0)\n    ), 0)\n\n    if (persistentCount === this.maxSnack) {\n      warning(MESSAGES.NO_PERSIST_ALL)\n      ignore = true\n    }\n\n    const snacks = state.snacks.map((item) => {\n      if (!popped && (!item.persist || ignore)) {\n        popped = true\n\n        if (!item.entered) {\n          return {\n            ...item,\n            requestClose: true,\n          }\n        }\n\n        if (item.onClose) item.onClose(null, REASONS.MAXSNACK, item.snackbarId)\n        if (this.props.onClose) this.props.onClose(null, REASONS.MAXSNACK, item.snackbarId)\n\n        return {\n          ...item,\n          open: false,\n        }\n      }\n\n      return {...item}\n    })\n\n    return {...state, snacks}\n  }\n\n  /**\n   * Set the entered state of the snackbar with the given snackbarId.\n   */\n  private handleEnteredSnack: TransitionHandlerProps['onEntered'] = (node, isAppearing, snackbarId) => {\n    if (!isDefined(snackbarId)) {\n      throw new Error('handleEnteredSnack Cannot be called with undefined snackbarId')\n    }\n\n    this.setState(({snacks}) => ({\n      snacks: snacks.map(item => (\n        item.snackbarId === snackbarId ? {...item, entered: true} : {...item}\n      )),\n    }))\n  }\n\n  /**\n   * Hide a snackbar after its timeout.\n   */\n  private handleCloseSnack: TransitionHandlerProps['onClose'] = (event, reason, snackbarId) => {\n    // should not use createChainedFunction for onClose.\n    // because this.closeSnackbar called this function\n    if (this.props.onClose) {\n      this.props.onClose(event, reason, snackbarId)\n    }\n\n    if (reason === REASONS.CLICKAWAY) return\n    const shouldCloseAll = snackbarId === undefined\n\n    this.setState(({snacks, queue}) => ({\n      snacks: snacks.map((item) => {\n        if (!shouldCloseAll && item.snackbarId !== snackbarId) {\n          return {...item}\n        }\n\n        return item.entered\n          ? {...item, open: false}\n          : {...item, requestClose: true}\n      }),\n      queue: queue.filter(item => item.snackbarId !== snackbarId),\n    }))\n  }\n\n  /**\n   * When we set open attribute of a snackbar to false (i.e. after we hide a snackbar),\n   * it leaves the screen and immediately after leaving animation is done, this method\n   * gets called. We remove the hidden snackbar from state and then display notifications\n   * waiting in the queue (if any). If after this process the queue is not empty, the\n   * oldest message is dismissed.\n   */\n  // @ts-expect-error — handler accepts extra snackbarId params beyond the typed signature\n  private handleExitedSnack: TransitionHandlerProps['onExited'] = (event, snackbarId1, snackbarId2) => {\n    const snackbarId = snackbarId1 || snackbarId2\n    if (!isDefined(snackbarId)) {\n      throw new Error('handleExitedSnack Cannot be called with undefined snackbarId')\n    }\n\n    this.setState((state) => {\n      const newState = this.processQueue({\n        ...state,\n        snacks: state.snacks.filter(item => item.snackbarId !== snackbarId),\n      })\n\n      if (newState.queue.length === 0) {\n        return newState\n      }\n\n      return this.handleDismissOldest(newState)\n    })\n  }\n}\n\n\nexport {SnackbarProvider}\nexport default SnackbarProvider\n"],"names":["createChainedFunction","clsx","Component","createPortal","SnackbarContainer","SnackbarContext","SnackbarItem","DEFAULTS","isDefined","merge","MESSAGES","omitContainerKeys","originKeyExtractor","REASONS","transformer","warning","SnackbarProvider","maxSnack","props","render","contextValue","state","dontspread1","allowDuplicate","dontspread2","variant","dontspread3","anchorOrigin","dontspread4","iconVariant","dense","hideIconVariant","domRoot","children","classes","categ","snacks","reduce","acc","current","category","existingOfCategory","snackbars","Object","keys","map","origin","Boolean","className","containerRoot","toContainerAnchorOrigin","snack","key","snackbarId","onClose","handleCloseSnack","onExited","handleExitedSnack","onEntered","handleEnteredSnack","Provider","value","enqueueSnackbar","message","opts","options","hasSpecifiedKey","id","Date","getTime","Math","random","merger","open","entered","requestClose","autoHideDuration","persist","undefined","setState","compareFunction","item","inQueue","queue","findIndex","inView","handleDisplaySnack","closeSnackbar","toBeClosed","find","INSTRUCTED","length","handleDismissOldest","processQueue","slice","some","popped","ignore","persistentCount","NO_PERSIST_ALL","MAXSNACK","node","isAppearing","Error","event","reason","CLICKAWAY","shouldCloseAll","filter","snackbarId1","snackbarId2","newState","bind"],"mappings":";;;;AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAAQA,qBAAqB,QAAO,2BAA0B;AAC9D,OAAOC,UAAU,OAAM;AACvB,SAAQC,SAAS,QAAO,QAAO;AAC/B,SAAQC,YAAY,QAAO,YAAW;AACtC,OAAOC,uBAAuB,yBAAqB;AACnD,OAAOC,qBAAqB,uBAAmB;AAC/C,OAAOC,kBAAkB,0BAAgB;AAUzC,SACEC,QAAQ,EACRC,SAAS,EACTC,KAAK,EACLC,QAAQ,EACRC,iBAAiB,EACjBC,kBAAkB,EAClBC,OAAO,EACPC,WAAW,QACN,uBAAmB;AAC1B,OAAOC,aAAa,qBAAiB;AAmBrC,IAAA,AAAMC,mBAAN,MAAMA,yBAAyBd;IAE7B,IAAIe,WAAmB;QACrB,OAAO,IAAI,CAACC,KAAK,CAACD,QAAQ,IAAIV,SAASU,QAAQ;IACjD;IAgFOE,SAAsB;QAC3B,MAAM,EAACC,YAAY,EAAC,GAAG,IAAI,CAACC,KAAK;QACjC,MAYI,cAAA,IAAI,CAACH,KAAK,EAZR,EACJD,UAAUK,WAAW,EACrBC,gBAAgBC,WAAW,EAC3BC,SAASC,WAAW,EACpBC,cAAcC,WAAW,EACzBC,WAAW,EACXC,KAAK,EACLC,eAAe,EACfC,OAAO,EACPC,QAAQ,EACRC,UAAU,CAAC,CAAC,EAEb,GAAG,aADChB,yCACD;;;;;;;;;;;;QAEJ,MAAMiB,QAAQ,IAAI,CAACd,KAAK,CAACe,MAAM,CAACC,MAAM,CAAmB,CAACC,KAAKC;YAC7D,MAAMC,WAAW5B,mBAAmB2B,QAAQZ,YAAY;YACxD,MAAMc,qBAAqBH,GAAG,CAACE,SAAS,IAAI,EAAE;YAC9C,OAAO,aACFF;gBACH,CAACE,SAAS,EAAE;uBAAIC;oBAAoBF;iBAAQ;;QAEhD,GAAG,CAAC;QAEJ,MAAMG,YAAYC,OAAOC,IAAI,CAACT,OAAOU,GAAG,CAAC,CAACC;YACxC,MAAMV,SAASD,KAAK,CAACW,OAAO;YAC5B,qBACE,KAAC1C;gBAEC0B,OAAOiB,QAAQjB;gBACfH,cAAcS,MAAM,CAAC,EAAE,CAACT,YAAY;gBACpCqB,WAAW/C,KACTiC,QAAQe,aAAa,EACrBf,OAAO,CAACpB,YAAYoC,uBAAuB,CAACJ,QAAQ;0BAGrDV,OAAOS,GAAG,CAACM,CAAAA,sBACV,eAAC7C,2BACKY;wBACJkC,KAAKD,MAAME,UAAU;wBACrBF,OAAOA;wBACPrB,OAAOiB,QAAQjB;wBACfD,aAAaA;wBACbE,iBAAiBA;wBACjBG,SAASvB,kBAAkBuB;wBAC3BoB,SAAS,IAAI,CAACC,gBAAgB;wBAC9BC,UAAUxD,sBAAsB;4BAAC,IAAI,CAACyD,iBAAiB;4BAAE,IAAI,CAACvC,KAAK,CAACsC,QAAQ;yBAAC;wBAC7EE,WAAW1D,sBAAsB;4BAAC,IAAI,CAAC2D,kBAAkB;4BAAE,IAAI,CAACzC,KAAK,CAACwC,SAAS;yBAAC;;eAnB/EZ;QAwBX;QAEA,qBACE,MAACzC,gBAAgBuD,QAAQ;YAACC,OAAOzC;;gBAC9Ba;gBACAD,wBAAU7B,aAAauC,WAAWV,WAAWU;;;IAGpD;IA3IA,YAAYxB,KAA4B,CAAE;QACxC,KAAK,CAACA,QAWR;;;GAGC,QACM4C,kBAAkB,CAACC,SAA0BC,OAAsB,CAAC,CAAC;YAC1E,MAAM,EACJX,UAAU,EACV9B,cAAc,EAEf,GAAGyC,MADCC,2CACDD;;;;YAEJ,MAAME,kBAAkB1D,UAAU6C;YAClC,MAAMc,KAAKD,kBAAmBb,aAA4B,IAAIe,OAAOC,OAAO,KAAKC,KAAKC,MAAM;YAE5F,MAAMC,SAAS/D,MAAMwD,SAAS,IAAI,CAAC/C,KAAK,EAAEX;YAC1C,MAAM4C,QAAe;gBACnBE,YAAYc;eACTF;gBACHF;gBACAU,MAAM;gBACNC,SAAS;gBACTC,cAAc;gBACdlD,SAAS+C,OAAO;gBAChB7C,cAAc6C,OAAO;gBACrBI,kBAAkBJ,OAAO;;YAG3B,IAAIP,QAAQY,OAAO,EAAE;gBACnB1B,MAAMyB,gBAAgB,GAAGE;YAC3B;YAEA,IAAI,CAACC,QAAQ,CAAC,CAAC1D;gBACb,IAAI,AAACE,mBAAmBuD,aAAa,IAAI,CAAC5D,KAAK,CAACK,cAAc,IAAKA,gBAAgB;oBACjF,MAAMyD,kBAAkB,CAACC,OACvBf,kBAAkBe,KAAK5B,UAAU,KAAKA,aAAa4B,KAAKlB,OAAO,KAAKA;oBAGtE,MAAMmB,UAAU7D,MAAM8D,KAAK,CAACC,SAAS,CAACJ,mBAAmB,CAAC;oBAC1D,MAAMK,SAAShE,MAAMe,MAAM,CAACgD,SAAS,CAACJ,mBAAmB,CAAC;oBAC1D,IAAIE,WAAWG,QAAQ;wBACrB,OAAOhE;oBACT;gBACF;gBAEA,OAAO,IAAI,CAACiE,kBAAkB,CAAC,aAC1BjE;oBACH8D,OAAO;2BAAI9D,MAAM8D,KAAK;wBAAEhC;qBAAM;;YAElC;YAEA,OAAOgB;QACT,GAEA;;GAEC,QACMoB,gBAAkD,CAAClC;YACxD,6EAA6E;YAC7E,MAAMmC,aAAa,IAAI,CAACnE,KAAK,CAACe,MAAM,CAACqD,IAAI,CAACR,CAAAA,OAAQA,KAAK5B,UAAU,KAAKA;YACtE,IAAI7C,UAAU6C,eAAemC,cAAcA,WAAWlC,OAAO,EAAE;gBAC7DkC,WAAWlC,OAAO,CAAC,MAAMzC,QAAQ6E,UAAU,EAAErC;YAC/C;YAEA,IAAI,CAACE,gBAAgB,CAAC,MAAM1C,QAAQ6E,UAAU,EAAErC;QAClD,GAkEA;;;GAGC,QACOiC,qBAA8B,CAACjE;YACrC,MAAM,EAACe,MAAM,EAAC,GAAGf;YACjB,IAAIe,OAAOuD,MAAM,IAAI,IAAI,CAAC1E,QAAQ,EAAE;gBAClC,OAAO,IAAI,CAAC2E,mBAAmB,CAACvE;YAClC;YACA,OAAO,IAAI,CAACwE,YAAY,CAACxE;QAC3B,GAEA;;GAEC,QACOwE,eAAwB,CAACxE;YAC/B,MAAM,EAAC8D,KAAK,EAAE/C,MAAM,EAAC,GAAGf;YACxB,IAAI8D,MAAMQ,MAAM,GAAG,GAAG;gBACpB,OAAO,aACFtE;oBACHe,QAAQ;2BAAIA;wBAAQ+C,KAAK,CAAC,EAAE;qBAAC;oBAC7BA,OAAOA,MAAMW,KAAK,CAAC,GAAGX,MAAMQ,MAAM;;YAEtC;YACA,OAAOtE;QACT,GAEA;;;;;;;;GAQC,QACOuE,sBAA+B,CAACvE;YACtC,IAAIA,MAAMe,MAAM,CAAC2D,IAAI,CAACd,CAAAA,OAAQ,CAACA,KAAKR,IAAI,IAAIQ,KAAKN,YAAY,GAAG;gBAC9D,OAAOtD;YACT;YAEA,IAAI2E,SAAS;YACb,IAAIC,SAAS;YAEb,MAAMC,kBAAkB7E,MAAMe,MAAM,CAACC,MAAM,CAAC,CAACC,KAAKC,UAChDD,MAAOC,CAAAA,QAAQkC,IAAI,IAAIlC,QAAQsC,OAAO,GAAG,IAAI,CAAA,GAC5C;YAEH,IAAIqB,oBAAoB,IAAI,CAACjF,QAAQ,EAAE;gBACrCF,QAAQL,SAASyF,cAAc;gBAC/BF,SAAS;YACX;YAEA,MAAM7D,SAASf,MAAMe,MAAM,CAACS,GAAG,CAAC,CAACoC;gBAC/B,IAAI,CAACe,UAAW,CAAA,CAACf,KAAKJ,OAAO,IAAIoB,MAAK,GAAI;oBACxCD,SAAS;oBAET,IAAI,CAACf,KAAKP,OAAO,EAAE;wBACjB,OAAO,aACFO;4BACHN,cAAc;;oBAElB;oBAEA,IAAIM,KAAK3B,OAAO,EAAE2B,KAAK3B,OAAO,CAAC,MAAMzC,QAAQuF,QAAQ,EAAEnB,KAAK5B,UAAU;oBACtE,IAAI,IAAI,CAACnC,KAAK,CAACoC,OAAO,EAAE,IAAI,CAACpC,KAAK,CAACoC,OAAO,CAAC,MAAMzC,QAAQuF,QAAQ,EAAEnB,KAAK5B,UAAU;oBAElF,OAAO,aACF4B;wBACHR,MAAM;;gBAEV;gBAEA,OAAO,aAAIQ;YACb;YAEA,OAAO,aAAI5D;gBAAOe;;QACpB,GAEA;;GAEC,QACOuB,qBAA0D,CAAC0C,MAAMC,aAAajD;YACpF,IAAI,CAAC7C,UAAU6C,aAAa;gBAC1B,MAAM,IAAIkD,MAAM;YAClB;YAEA,IAAI,CAACxB,QAAQ,CAAC,CAAC,EAAC3C,MAAM,EAAC,GAAM,CAAA;oBAC3BA,QAAQA,OAAOS,GAAG,CAACoC,CAAAA,OACjBA,KAAK5B,UAAU,KAAKA,aAAa,aAAI4B;4BAAMP,SAAS;6BAAQ,aAAIO;gBAEpE,CAAA;QACF,GAEA;;GAEC,QACO1B,mBAAsD,CAACiD,OAAOC,QAAQpD;YAC5E,oDAAoD;YACpD,kDAAkD;YAClD,IAAI,IAAI,CAACnC,KAAK,CAACoC,OAAO,EAAE;gBACtB,IAAI,CAACpC,KAAK,CAACoC,OAAO,CAACkD,OAAOC,QAAQpD;YACpC;YAEA,IAAIoD,WAAW5F,QAAQ6F,SAAS,EAAE;YAClC,MAAMC,iBAAiBtD,eAAeyB;YAEtC,IAAI,CAACC,QAAQ,CAAC,CAAC,EAAC3C,MAAM,EAAE+C,KAAK,EAAC,GAAM,CAAA;oBAClC/C,QAAQA,OAAOS,GAAG,CAAC,CAACoC;wBAClB,IAAI,CAAC0B,kBAAkB1B,KAAK5B,UAAU,KAAKA,YAAY;4BACrD,OAAO,aAAI4B;wBACb;wBAEA,OAAOA,KAAKP,OAAO,GACf,aAAIO;4BAAMR,MAAM;6BAChB,aAAIQ;4BAAMN,cAAc;;oBAC9B;oBACAQ,OAAOA,MAAMyB,MAAM,CAAC3B,CAAAA,OAAQA,KAAK5B,UAAU,KAAKA;gBAClD,CAAA;QACF,GAEA;;;;;;GAMC,GACD,wFAAwF;aAChFI,oBAAwD,CAAC+C,OAAOK,aAAaC;YACnF,MAAMzD,aAAawD,eAAeC;YAClC,IAAI,CAACtG,UAAU6C,aAAa;gBAC1B,MAAM,IAAIkD,MAAM;YAClB;YAEA,IAAI,CAACxB,QAAQ,CAAC,CAAC1D;gBACb,MAAM0F,WAAW,IAAI,CAAClB,YAAY,CAAC,aAC9BxE;oBACHe,QAAQf,MAAMe,MAAM,CAACwE,MAAM,CAAC3B,CAAAA,OAAQA,KAAK5B,UAAU,KAAKA;;gBAG1D,IAAI0D,SAAS5B,KAAK,CAACQ,MAAM,KAAK,GAAG;oBAC/B,OAAOoB;gBACT;gBAEA,OAAO,IAAI,CAACnB,mBAAmB,CAACmB;YAClC;QACF;QA/RE,IAAI,CAAC1F,KAAK,GAAG;YACXe,QAAQ,EAAE;YACV+C,OAAO,EAAE;YACT/D,cAAc;gBACZ0C,iBAAiB,IAAI,CAACA,eAAe,CAACkD,IAAI,CAAC,IAAI;gBAC/CzB,eAAe,IAAI,CAACA,aAAa,CAACyB,IAAI,CAAC,IAAI;YAC7C;QACF;IACF;AAwRF;AAGA,SAAQhG,gBAAgB,GAAC;AACzB,eAAeA,iBAAgB"}

package/src/lib/types.d.ts

@@ -0,0 +1,270 @@
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Part of the following typing and documentation is from
+ * material-ui/src/Snackbar/Snackbar.d.ts
+ */
+import type { ClickAwayListenerProps, SnackbarClassKey, StandardProps } from '@mui/material';
+import { TransitionProps } from '@mui/material/transitions';
+import type { AriaAttributes, ComponentType, HTMLAttributes, Ref, SyntheticEvent } from 'react';
+import type SnackbarProvider from './SnackbarProvider';
+export type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+export type ClassNameMap<ClassKey extends string = string> = Record<ClassKey, string>;
+type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+export type SnackbarId = string | number;
+export type VariantType = 'default' | 'error' | 'success' | 'warning' | 'info';
+export type CloseReason = 'timeout' | 'clickaway' | 'maxsnack' | 'instructed';
+export type SnackbarMessage = string | JSX.Node;
+export type SnackbarAction = JSX.Node | ((snackbarId: SnackbarId) => JSX.Node);
+export type SnackbarContentCallback = JSX.Node | ((snackbarId: SnackbarId, message: SnackbarMessage) => JSX.Node);
+export type TransitionCloseHandler = (event: SyntheticEvent<any> | null, reason: CloseReason, snackbarId?: SnackbarId) => void;
+export type TransitionEnterHandler = (node: HTMLElement, isAppearing: boolean, snackbarId: SnackbarId) => void;
+export type TransitionHandler = (node: HTMLElement, snackbarId: SnackbarId) => void;
+export type ContainerClassKey = 'containerRoot' | 'containerAnchorOriginTopCenter' | 'containerAnchorOriginBottomCenter' | 'containerAnchorOriginTopRight' | 'containerAnchorOriginBottomRight' | 'containerAnchorOriginTopLeft' | 'containerAnchorOriginBottomLeft';
+export type VariantClassKey = 'variantSuccess' | 'variantError' | 'variantInfo' | 'variantWarning';
+export type CombinedClassKey = VariantClassKey | ContainerClassKey | SnackbarClassKey;
+export interface SnackbarOrigin {
+    vertical: 'top' | 'bottom';
+    horizontal: 'left' | 'center' | 'right';
+}
+export interface IconVariant {
+    /**
+     * Icon displayed when variant of a snackbar is set to `default`.
+     */
+    default: JSX.Node;
+    /**
+     * Icon displayed when variant of a snackbar is set to `error`.
+     */
+    error: JSX.Node;
+    /**
+     * Icon displayed when variant of a snackbar is set to `success`.
+     */
+    success: JSX.Node;
+    /**
+     * Icon displayed when variant of a snackbar is set to `warning`.
+     */
+    warning: JSX.Node;
+    /**
+     * Icon displayed when variant of a snackbar is set to `info`.
+     */
+    info: JSX.Node;
+}
+/**
+ * @category Shared
+ */
+export interface TransitionHandlerProps {
+    /**
+     * Callback fired before snackbar requests to get closed.
+     * The `reason` parameter can optionally be used to control the response to
+     * `onClose`.
+     *
+     * @param {object} event The event source of the callback
+     * @param {string} reason Can be:`"timeout"` (`autoHideDuration` expired) or:
+     *   `"clickaway"` or: `"maxsnack"` (snackbar was closed because `maxSnack`
+     *   has reached) or: `"instructed"`
+     * (snackbar was closed programmatically)
+     * @param {string|number|undefined} snackbarId ID of a Snackbar. snackbarId
+     *   will be `undefined` if closeSnackbar is called with no snackbarId (user
+     *   requested all the snackbars to be closed)
+     */
+    onClose: TransitionCloseHandler;
+    /**
+     * Callback fired before the transition is entering.
+     */
+    onEnter: TransitionHandler;
+    /**
+     * Callback fired when the transition is entering.
+     */
+    onEntering: TransitionHandler;
+    /**
+     * Callback fired when the transition has entered.
+     */
+    onEntered: TransitionEnterHandler;
+    /**
+     * Callback fired before the transition is exiting.
+     */
+    onExit: TransitionHandler;
+    /**
+     * Callback fired when the transition is exiting.
+     */
+    onExiting: TransitionHandler;
+    /**
+     * Callback fired when the transition has exited.
+     */
+    onExited: TransitionHandler;
+}
+export type SnackbarContentProps = HTMLAttributes<HTMLDivElement>;
+export type WithSnackbarProps = ProviderContext;
+/**
+ * @category Shared
+ */
+export interface SnackbarProps extends StandardProps<HTMLAttributes<HTMLDivElement>, SnackbarClassKey> {
+    /**
+     * The anchor of the `Snackbar`.
+     * @default { horizontal: left, vertical: bottom }
+     */
+    anchorOrigin?: SnackbarOrigin;
+    /**
+     * The number of milliseconds to wait before automatically calling the
+     * `onClose` function. By default snackbars get closed after 5000
+     * milliseconds. Set autoHideDuration to 'null' if you don't want snackbars
+     * to automatically close. Alternatively pass `persist: true` in the options
+     * parameter of enqueueSnackbar.
+     * @default 5000
+     */
+    autoHideDuration?: number | null;
+    /**
+     * @ignore
+     * Properties applied to ClickAwayListener component
+     */
+    ClickAwayListenerProps?: Partial<ClickAwayListenerProps>;
+    /**
+     * Aria attributes applied to snackbar's content component
+     */
+    ariaAttributes?: AriaAttributes;
+    /**
+     * If `true`, the `autoHideDuration` timer will expire even if the window is
+     * not focused.
+     * @default false
+     */
+    disableWindowBlurListener?: boolean;
+    /**
+     * The number of milliseconds to wait before dismissing after user
+     * interaction. If `autoHideDuration` property isn't specified, it does
+     * nothing. If `autoHideDuration` property is specified but
+     * `resumeHideDuration` isn't, we use the default value.
+     * @default autoHideDuration / 2 ms.
+     */
+    resumeHideDuration?: number;
+    /**
+     * The component used for the transition. (e.g. Slide, Grow, Zoom, etc.)
+     * @default Slide
+     */
+    TransitionComponent?: ComponentType<TransitionProps>;
+    /**
+     * The duration for the transition, in milliseconds.
+     * You may specify the duration with an object in the following shape:
+     * ```js
+     * transitionDuration={{ enter: 300, exit: 500 }}
+     * ```
+     * @default { enter: 225, exit: 195 }
+     */
+    transitionDuration?: {
+        appear?: number;
+        enter?: number;
+        exit?: number;
+    };
+    /**
+     * Properties applied to Transition component (e.g. Slide, Grow, Zoom, etc.)
+     */
+    TransitionProps?: TransitionProps;
+}
+/**
+ * @category Shared
+ */
+export interface SharedProps extends Omit<SnackbarProps, 'classes' | 'content'>, Partial<TransitionHandlerProps> {
+    /**
+     * Used to easily display different variant of snackbars. When passed to
+     * `SnackbarProvider` all snackbars inherit the `variant`, unless you
+     * override it in `enqueueSnackbar` options.
+     * @default default
+     */
+    variant?: VariantType;
+    /**
+     * Ignores displaying multiple snackbars with the same `message`
+     * @default false
+     */
+    allowDuplicate?: boolean;
+    /**
+     * Replace the snackbar. Callback used for displaying entirely customized
+     * snackbar.
+     * @param {string|number} snackbarId ID of a snackbar
+     */
+    content?: SnackbarContentCallback;
+    /**
+     * Callback used for getting action(s). actions are mostly buttons displayed
+     * in Snackbar.
+     * @param {string|number} snackbarId ID of a snackbar
+     */
+    action?: SnackbarAction;
+}
+/**
+ * @category Enqueue
+ */
+export interface OptionsObject extends SharedProps {
+    /**
+     * Unique identifier to reference a snackbar.
+     * @default random unique string
+     */
+    snackbarId?: SnackbarId;
+    /**
+     * Snackbar stays on the screen, unless it is dismissed (programmatically or
+     * through user interaction).
+     * @default false
+     */
+    persist?: boolean;
+}
+/**
+ * All material-ui props, including class keys for notistack and material-ui
+ * with additional notistack props
+ * @category Provider
+ */
+export interface SnackbarProviderProps extends SharedProps {
+    /**
+     * Most of the time this is your App. every component from this point onward
+     * will be able to show snackbars.
+     */
+    children: JSX.Children;
+    /**
+     * Denser margins for snackbars. Recommended to be used on mobile devices.
+     * @default false
+     */
+    dense?: boolean;
+    /**
+     * Maximum snackbars that can be stacked on top of one another.
+     * @default 3
+     */
+    maxSnack?: number;
+    /**
+     * Hides iconVariant if set to `true`.
+     * @default false
+     */
+    hideIconVariant?: boolean;
+    /**
+     * Valid and exist HTML Node element, used to target `ReactDOM.createPortal`
+     */
+    domRoot?: HTMLElement;
+    /**
+     * Override or extend the styles applied to the container component or
+     * Snackbars.
+     */
+    classes?: Partial<ClassNameMap<CombinedClassKey>>;
+    /**
+     * Little icon that is displayed at left corner of a snackbar.
+     */
+    iconVariant?: Partial<IconVariant>;
+    /**
+     * @ignore
+     * SnackbarProvider's ref
+     */
+    ref?: Ref<SnackbarProvider>;
+}
+export interface ProviderContext {
+    enqueueSnackbar: (message: SnackbarMessage, options?: OptionsObject) => SnackbarId;
+    closeSnackbar: (snackbarId?: SnackbarId) => void;
+}
+export {};

package/src/lib/types.js

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ /**
+ * Part of the following typing and documentation is from
+ * material-ui/src/Snackbar/Snackbar.d.ts
+ */ export { };
+
+//# sourceMappingURL=types.js.map

package/src/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/shared/ui/snackstack/src/lib/types.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2022 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * Part of the following typing and documentation is from\n * material-ui/src/Snackbar/Snackbar.d.ts\n */\nimport type {\n  ClickAwayListenerProps,\n  SnackbarClassKey,\n  StandardProps,\n} from '@mui/material'\nimport { TransitionProps } from '@mui/material/transitions'\nimport type {\n  AriaAttributes,\n  ComponentType,\n  HTMLAttributes,\n  Ref,\n  SyntheticEvent,\n} from 'react'\nimport type SnackbarProvider from './SnackbarProvider'\n\nexport type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>\nexport type ClassNameMap<ClassKey extends string = string> = Record<\n  ClassKey,\n  string\n>\ntype Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>\ntype Modify<T, R> = Pick<T, Exclude<keyof T, keyof R>> & R\n\nexport type SnackbarId = string | number\nexport type VariantType = 'default' | 'error' | 'success' | 'warning' | 'info'\nexport type CloseReason = 'timeout' | 'clickaway' | 'maxsnack' | 'instructed'\n\nexport type SnackbarMessage = string | JSX.Node\nexport type SnackbarAction = JSX.Node | ((snackbarId: SnackbarId) => JSX.Node)\nexport type SnackbarContentCallback =\n  | JSX.Node\n  | ((snackbarId: SnackbarId, message: SnackbarMessage) => JSX.Node)\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type TransitionCloseHandler = (\n  event: SyntheticEvent<any> | null,\n  reason: CloseReason,\n  snackbarId?: SnackbarId,\n) => void\nexport type TransitionEnterHandler = (\n  node: HTMLElement,\n  isAppearing: boolean,\n  snackbarId: SnackbarId,\n) => void\nexport type TransitionHandler = (\n  node: HTMLElement,\n  snackbarId: SnackbarId,\n) => void\n\nexport type ContainerClassKey =\n  | 'containerRoot'\n  | 'containerAnchorOriginTopCenter'\n  | 'containerAnchorOriginBottomCenter'\n  | 'containerAnchorOriginTopRight'\n  | 'containerAnchorOriginBottomRight'\n  | 'containerAnchorOriginTopLeft'\n  | 'containerAnchorOriginBottomLeft'\n\nexport type VariantClassKey =\n  | 'variantSuccess'\n  | 'variantError'\n  | 'variantInfo'\n  | 'variantWarning'\nexport type CombinedClassKey =\n  | VariantClassKey\n  | ContainerClassKey\n  | SnackbarClassKey\n\nexport interface SnackbarOrigin {\n  vertical: 'top' | 'bottom'\n  horizontal: 'left' | 'center' | 'right'\n}\n\nexport interface IconVariant {\n  /**\n   * Icon displayed when variant of a snackbar is set to `default`.\n   */\n  default: JSX.Node\n  /**\n   * Icon displayed when variant of a snackbar is set to `error`.\n   */\n  error: JSX.Node\n  /**\n   * Icon displayed when variant of a snackbar is set to `success`.\n   */\n  success: JSX.Node\n  /**\n   * Icon displayed when variant of a snackbar is set to `warning`.\n   */\n  warning: JSX.Node\n  /**\n   * Icon displayed when variant of a snackbar is set to `info`.\n   */\n  info: JSX.Node\n}\n\n/**\n * @category Shared\n */\nexport interface TransitionHandlerProps {\n  /**\n   * Callback fired before snackbar requests to get closed.\n   * The `reason` parameter can optionally be used to control the response to\n   * `onClose`.\n   *\n   * @param {object} event The event source of the callback\n   * @param {string} reason Can be:`\"timeout\"` (`autoHideDuration` expired) or:\n   *   `\"clickaway\"` or: `\"maxsnack\"` (snackbar was closed because `maxSnack`\n   *   has reached) or: `\"instructed\"`\n   * (snackbar was closed programmatically)\n   * @param {string|number|undefined} snackbarId ID of a Snackbar. snackbarId\n   *   will be `undefined` if closeSnackbar is called with no snackbarId (user\n   *   requested all the snackbars to be closed)\n   */\n  onClose: TransitionCloseHandler\n  /**\n   * Callback fired before the transition is entering.\n   */\n  onEnter: TransitionHandler\n  /**\n   * Callback fired when the transition is entering.\n   */\n  onEntering: TransitionHandler\n  /**\n   * Callback fired when the transition has entered.\n   */\n  onEntered: TransitionEnterHandler\n  /**\n   * Callback fired before the transition is exiting.\n   */\n  onExit: TransitionHandler\n  /**\n   * Callback fired when the transition is exiting.\n   */\n  onExiting: TransitionHandler\n  /**\n   * Callback fired when the transition has exited.\n   */\n  onExited: TransitionHandler\n}\n\nexport type SnackbarContentProps = HTMLAttributes<HTMLDivElement>\n\n// backwards compatibility\nexport type WithSnackbarProps = ProviderContext\n\n/**\n * @category Shared\n */\nexport interface SnackbarProps\n  extends StandardProps<HTMLAttributes<HTMLDivElement>, SnackbarClassKey> {\n  /**\n   * The anchor of the `Snackbar`.\n   * @default { horizontal: left, vertical: bottom }\n   */\n  anchorOrigin?: SnackbarOrigin\n  /**\n   * The number of milliseconds to wait before automatically calling the\n   * `onClose` function. By default snackbars get closed after 5000\n   * milliseconds. Set autoHideDuration to 'null' if you don't want snackbars\n   * to automatically close. Alternatively pass `persist: true` in the options\n   * parameter of enqueueSnackbar.\n   * @default 5000\n   */\n  autoHideDuration?: number | null\n  /**\n   * @ignore\n   * Properties applied to ClickAwayListener component\n   */\n  ClickAwayListenerProps?: Partial<ClickAwayListenerProps>\n  /**\n   * Aria attributes applied to snackbar's content component\n   */\n  ariaAttributes?: AriaAttributes\n  /**\n   * If `true`, the `autoHideDuration` timer will expire even if the window is\n   * not focused.\n   * @default false\n   */\n  disableWindowBlurListener?: boolean\n  /**\n   * The number of milliseconds to wait before dismissing after user\n   * interaction. If `autoHideDuration` property isn't specified, it does\n   * nothing. If `autoHideDuration` property is specified but\n   * `resumeHideDuration` isn't, we use the default value.\n   * @default autoHideDuration / 2 ms.\n   */\n  resumeHideDuration?: number\n  /**\n   * The component used for the transition. (e.g. Slide, Grow, Zoom, etc.)\n   * @default Slide\n   */\n  TransitionComponent?: ComponentType<TransitionProps>\n  /**\n   * The duration for the transition, in milliseconds.\n   * You may specify the duration with an object in the following shape:\n   * ```js\n   * transitionDuration={{ enter: 300, exit: 500 }}\n   * ```\n   * @default { enter: 225, exit: 195 }\n   */\n  transitionDuration?: { appear?: number; enter?: number; exit?: number }\n  /**\n   * Properties applied to Transition component (e.g. Slide, Grow, Zoom, etc.)\n   */\n  TransitionProps?: TransitionProps\n}\n\n/**\n * @category Shared\n */\nexport interface SharedProps\n  extends Omit<SnackbarProps, 'classes' | 'content'>,\n    Partial<TransitionHandlerProps> {\n  /**\n   * Used to easily display different variant of snackbars. When passed to\n   * `SnackbarProvider` all snackbars inherit the `variant`, unless you\n   * override it in `enqueueSnackbar` options.\n   * @default default\n   */\n  variant?: VariantType\n  /**\n   * Ignores displaying multiple snackbars with the same `message`\n   * @default false\n   */\n  allowDuplicate?: boolean\n  /**\n   * Replace the snackbar. Callback used for displaying entirely customized\n   * snackbar.\n   * @param {string|number} snackbarId ID of a snackbar\n   */\n  content?: SnackbarContentCallback\n  /**\n   * Callback used for getting action(s). actions are mostly buttons displayed\n   * in Snackbar.\n   * @param {string|number} snackbarId ID of a snackbar\n   */\n  action?: SnackbarAction\n}\n\n/**\n * @category Enqueue\n */\nexport interface OptionsObject extends SharedProps {\n  /**\n   * Unique identifier to reference a snackbar.\n   * @default random unique string\n   */\n  snackbarId?: SnackbarId\n  /**\n   * Snackbar stays on the screen, unless it is dismissed (programmatically or\n   * through user interaction).\n   * @default false\n   */\n  persist?: boolean\n}\n\n/**\n * All material-ui props, including class keys for notistack and material-ui\n * with additional notistack props\n * @category Provider\n */\nexport interface SnackbarProviderProps extends SharedProps {\n  /**\n   * Most of the time this is your App. every component from this point onward\n   * will be able to show snackbars.\n   */\n  children: JSX.Children\n  /**\n   * Denser margins for snackbars. Recommended to be used on mobile devices.\n   * @default false\n   */\n  dense?: boolean\n  /**\n   * Maximum snackbars that can be stacked on top of one another.\n   * @default 3\n   */\n  maxSnack?: number\n  /**\n   * Hides iconVariant if set to `true`.\n   * @default false\n   */\n  hideIconVariant?: boolean\n  /**\n   * Valid and exist HTML Node element, used to target `ReactDOM.createPortal`\n   */\n  domRoot?: HTMLElement\n  /**\n   * Override or extend the styles applied to the container component or\n   * Snackbars.\n   */\n  classes?: Partial<ClassNameMap<CombinedClassKey>>\n  /**\n   * Little icon that is displayed at left corner of a snackbar.\n   */\n  iconVariant?: Partial<IconVariant>\n  /**\n   * @ignore\n   * SnackbarProvider's ref\n   */\n  ref?: Ref<SnackbarProvider>\n}\n\nexport interface ProviderContext {\n  enqueueSnackbar: (\n    message: SnackbarMessage,\n    options?: OptionsObject,\n  ) => SnackbarId\n  closeSnackbar: (snackbarId?: SnackbarId) => void\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;CAGC,GAgTD,WAMC"}

package/src/lib/useSnackbar.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { ProviderContext } from './types';
+export declare function useSnackbar(): ProviderContext;
+export default useSnackbar;