Merge pull request #125 from cristidumitrescutotalsoft/feature/autoCl…

…ose-default-on-useToast Add tooltip documentation for default false, on autoClose param, of useToast
osstotalsoft · Sep 5, 2024 · f1909fc · f1909fc
2 parents f18f506 + edb0b20
commit f1909fc
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/src/components/feedback/Toast/ToastContainer.tsx b/src/components/feedback/Toast/ToastContainer.tsx
@@ -11,7 +11,7 @@ import { ToastContainerProps } from './types'
 
 const ToastContainer: React.FC<ToastContainerProps> = ({
   position = toast.POSITION.TOP_CENTER,
-  autoClose = 3000,
+  autoClose = false,
   newestOnTop = true,
   transitionType = 'Slide',
   limit = 5,
@@ -37,7 +37,7 @@ ToastContainer.propTypes = {
   /**
    * Set the delay in ms to close the toast automatically.
    * Use `false` to prevent the toast from closing.
-   * @default 3000
+   * @default false
    */
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore

diff --git a/src/components/feedback/Toast/types.ts b/src/components/feedback/Toast/types.ts
@@ -8,4 +8,10 @@ export interface ToastContainerProps extends Omit<ReactToastifyProps, 'transitio
    * @default Slide
    */
   transitionType?: 'Slide' | 'Bounce' | 'Zoom' | 'Flip'
+  /**
+   * Set the delay in ms to close the toast automatically.
+   * Use `false` to prevent the toast from closing.
+   * `Default: false`
+   */
+  autoClose?: number | false
 }
diff --git a/src/components/feedback/Toast/useToast.ts b/src/components/feedback/Toast/useToast.ts
@@ -25,8 +25,7 @@ const useToast = () => {
      * @param {('success'|'info'|'warning'|'error')} variant The type of the toast
      * @param {ToastOptions} options Additional options passed to the toast
      */
-    (message: ToastContent, variant?: ToastifyTypeOptions, { transitionType, autoClose, ...restOptions } = {} as ToastOptions) => {
-
+    (message: ToastContent, variant?: ToastifyTypeOptions, { transitionType, ...restOptions } = {} as ToastOptions) => {
       const toastClasses = cx({
         [classes[variant]]: variant,
         [classes['default']]: true
@@ -41,7 +40,6 @@ const useToast = () => {
 
       const options: ToastifyToastOptions = {
         ...restOptions,
-        autoClose: autoClose || false,
         transition: getTransitionType(transitionType),
         className: toastClasses
       }