@react-md/core 1.0.0-next.12 → 1.0.0-next.14

package/dist/transition/collapseStyles.js

@@ -3,7 +3,7 @@ import { bem } from "../utils/bem.js";
 import { DISPLAY_NONE_CLASS } from "../utils/isElementVisible.js";
 const styles = bem("rmd-collapse");
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function collapse(options = {}) {
     const { enter, leave, exited, disableOverflow, className } = options;
     return cnb(styles({

package/dist/transition/collapseStyles.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/collapseStyles.ts"],"sourcesContent":["import { cnb } from \"cnbuilder\";\nimport { bem } from \"../utils/bem.js\";\nimport { DISPLAY_NONE_CLASS } from \"../utils/isElementVisible.js\";\n\nconst styles = bem(\"rmd-collapse\");\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface CollapseClassNameOptions {\n  className?: string;\n  enter?: boolean;\n  leave?: boolean;\n  exited?: boolean;\n  disableOverflow?: boolean;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function collapse(options: CollapseClassNameOptions = {}): string {\n  const { enter, leave, exited, disableOverflow, className } = options;\n\n  return cnb(\n    styles({\n      enter,\n      leave,\n      \"no-overflow\": disableOverflow,\n    }),\n    exited && DISPLAY_NONE_CLASS,\n    className\n  );\n}\n"],"names":["cnb","bem","DISPLAY_NONE_CLASS","styles","collapse","options","enter","leave","exited","disableOverflow","className"],"rangeMappings":";;;;;;;;;;;;;","mappings":"AAAA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,GAAG,QAAQ,kBAAkB;AACtC,SAASC,kBAAkB,QAAQ,+BAA+B;AAElE,MAAMC,SAASF,IAAI;AAanB;;CAEC,GACD,OAAO,SAASG,SAASC,UAAoC,CAAC,CAAC;IAC7D,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,MAAM,EAAEC,eAAe,EAAEC,SAAS,EAAE,GAAGL;IAE7D,OAAOL,IACLG,OAAO;QACLG;QACAC;QACA,eAAeE;IACjB,IACAD,UAAUN,oBACVQ;AAEJ"}
+{"version":3,"sources":["../../src/transition/collapseStyles.ts"],"sourcesContent":["import { cnb } from \"cnbuilder\";\nimport { bem } from \"../utils/bem.js\";\nimport { DISPLAY_NONE_CLASS } from \"../utils/isElementVisible.js\";\n\nconst styles = bem(\"rmd-collapse\");\n\n/**\n * @since 6.0.0\n */\nexport interface CollapseClassNameOptions {\n  className?: string;\n  enter?: boolean;\n  leave?: boolean;\n  exited?: boolean;\n  disableOverflow?: boolean;\n}\n\n/**\n * @since 6.0.0\n */\nexport function collapse(options: CollapseClassNameOptions = {}): string {\n  const { enter, leave, exited, disableOverflow, className } = options;\n\n  return cnb(\n    styles({\n      enter,\n      leave,\n      \"no-overflow\": disableOverflow,\n    }),\n    exited && DISPLAY_NONE_CLASS,\n    className\n  );\n}\n"],"names":["cnb","bem","DISPLAY_NONE_CLASS","styles","collapse","options","enter","leave","exited","disableOverflow","className"],"rangeMappings":";;;;;;;;;;;;;","mappings":"AAAA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,GAAG,QAAQ,kBAAkB;AACtC,SAASC,kBAAkB,QAAQ,+BAA+B;AAElE,MAAMC,SAASF,IAAI;AAanB;;CAEC,GACD,OAAO,SAASG,SAASC,UAAoC,CAAC,CAAC;IAC7D,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,MAAM,EAAEC,eAAe,EAAEC,SAAS,EAAE,GAAGL;IAE7D,OAAOL,IACLG,OAAO;QACLG;QACAC;QACA,eAAeE;IACjB,IACAD,UAAUN,oBACVQ;AAEJ"}

package/dist/transition/config.d.ts

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface TransitionConfig {
     /**
@@ -17,6 +17,6 @@ export interface TransitionConfig {
     disabled: boolean;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const TRANSITION_CONFIG: TransitionConfig;

package/dist/transition/config.js

@@ -1,9 +1,9 @@
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ // NOTE: Uses get/set for test mocking
 let disabled = false;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const TRANSITION_CONFIG = {
     get disabled () {
         return disabled;

package/dist/transition/config.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/config.ts"],"sourcesContent":["/**\n * @remarks \\@since 6.0.0\n */\nexport interface TransitionConfig {\n  /**\n   * Set this to `true` to disable all transitions from `react-md`.\n   *\n   * Note: It is recommended to set this to `true` in testing to keep things\n   * simple and will automatically be set when using:\n   *\n   * ```ts\n   * import \"@react-md/core/test-utils/jest-setup.js\";\n   * ```\n   *\n   * @defaultValue `false`\n   */\n  disabled: boolean;\n}\n\n// NOTE: Uses get/set for test mocking\n\nlet disabled = false;\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport const TRANSITION_CONFIG: TransitionConfig = {\n  get disabled() {\n    return disabled;\n  },\n  set disabled(nextDisabled: boolean) {\n    disabled = nextDisabled;\n  },\n};\n"],"names":["disabled","TRANSITION_CONFIG","nextDisabled"],"rangeMappings":";;;;;;;;;;;;;","mappings":"AAAA;;CAEC,GAiBD,sCAAsC;AAEtC,IAAIA,WAAW;AAEf;;CAEC,GACD,OAAO,MAAMC,oBAAsC;IACjD,IAAID,YAAW;QACb,OAAOA;IACT;IACA,IAAIA,UAASE,aAAuB;QAClCF,WAAWE;IACb;AACF,EAAE"}
+{"version":3,"sources":["../../src/transition/config.ts"],"sourcesContent":["/**\n * @since 6.0.0\n */\nexport interface TransitionConfig {\n  /**\n   * Set this to `true` to disable all transitions from `react-md`.\n   *\n   * Note: It is recommended to set this to `true` in testing to keep things\n   * simple and will automatically be set when using:\n   *\n   * ```ts\n   * import \"@react-md/core/test-utils/jest-setup.js\";\n   * ```\n   *\n   * @defaultValue `false`\n   */\n  disabled: boolean;\n}\n\n// NOTE: Uses get/set for test mocking\n\nlet disabled = false;\n\n/**\n * @since 6.0.0\n */\nexport const TRANSITION_CONFIG: TransitionConfig = {\n  get disabled() {\n    return disabled;\n  },\n  set disabled(nextDisabled: boolean) {\n    disabled = nextDisabled;\n  },\n};\n"],"names":["disabled","TRANSITION_CONFIG","nextDisabled"],"rangeMappings":";;;;;;;;;;;;;","mappings":"AAAA;;CAEC,GAiBD,sCAAsC;AAEtC,IAAIA,WAAW;AAEf;;CAEC,GACD,OAAO,MAAMC,oBAAsC;IACjD,IAAID,YAAW;QACb,OAAOA;IACT;IACA,IAAIA,UAASE,aAAuB;QAClCF,WAAWE;IACb;AACF,EAAE"}

package/dist/transition/skeletonPlaceholderUtils.d.ts

@@ -1,10 +1,10 @@
 import { type CSSProperties } from "react";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const skeletonPlaceholder: import("../utils/bem.js").BEMResult;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface SkeletonPlaceholderRandomOptions {
     /**
@@ -72,6 +72,6 @@ export interface SkeletonPlaceholderRandomOptions {
  *   );
  * }
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function randomSkeletonPlaceholder(options?: SkeletonPlaceholderRandomOptions): CSSProperties;

package/dist/transition/skeletonPlaceholderUtils.js

@@ -1,7 +1,7 @@
 import { bem } from "../utils/bem.js";
 import { randomInt } from "../utils/randomInt.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const skeletonPlaceholder = bem("rmd-skeleton-placeholder");
 /**
  * A server-only safe util to generate a random skeleton placeholder.
@@ -20,7 +20,7 @@ import { randomInt } from "../utils/randomInt.js";
  *   );
  * }
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function randomSkeletonPlaceholder(options = {}) {
     const { minDelay = 0, maxDelay = 400, minPercentage = 40, maxPercentage = 85 } = options;
     return {

package/dist/transition/skeletonPlaceholderUtils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/skeletonPlaceholderUtils.ts"],"sourcesContent":["import { type CSSProperties } from \"react\";\nimport { bem } from \"../utils/bem.js\";\nimport { randomInt } from \"../utils/randomInt.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport const skeletonPlaceholder = bem(\"rmd-skeleton-placeholder\");\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface SkeletonPlaceholderRandomOptions {\n  /**\n   * The minimum `animation-delay` milliseconds allowed in the random generator.\n   * This value should be: `0 <= minDelay < maxDelay`.\n   *\n   * The `animation-delay` will be generated by:\n   * ```ts\n   * const delay = randomInt({\n   *   min: minDelay,\n   *   max: maxDelay,\n   * });\n   *\n   * return {\n   *   animationDelay: `-${delay}ms`,\n   * };\n   * ```\n   *\n   * @defaultValue `0`\n   */\n  minDelay?: number;\n\n  /**\n   * @see {@link minDelay}\n   * @defaultValue `400`\n   */\n  maxDelay?: number;\n\n  /**\n   * The minimum width percentage allowed in the random generator. This value\n   * should be: `0 >= minPercentage < maxPercentage`.\n   *\n   * The `width` will be generated by:\n   * ```ts\n   * const width = randomInt({\n   *   min: minPercentage,\n   *   max: maxPercentage,\n   * });\n   *\n   * return {\n   *   width: `${width}%`,\n   * };\n   * ```\n   * @defaultValue `40`\n   */\n  minPercentage?: number;\n\n  /**\n   * @see {@link minPercentage}\n   * @defaultValue `85`\n   */\n  maxPercentage?: number;\n}\n\n/**\n * A server-only safe util to generate a random skeleton placeholder.\n *\n * @example\n * ```tsx\n * import { skeletonPlaceholder, randomSkeletonPlaceholder } from \"@react-md/core\";\n * import \"server-only\";\n *\n * export function RandomSkeletonPlaceholder(): ReactElement {\n *   return\n *     <div\n *       style={randomSkeletonPlaceholder()}\n *       className={skeletonPlaceholder()}\n *     />\n *   );\n * }\n * ```\n * @remarks \\@since 6.0.0\n */\nexport function randomSkeletonPlaceholder(\n  options: SkeletonPlaceholderRandomOptions = {}\n): CSSProperties {\n  const {\n    minDelay = 0,\n    maxDelay = 400,\n    minPercentage = 40,\n    maxPercentage = 85,\n  } = options;\n\n  return {\n    animationDelay: `-${randomInt({\n      min: minDelay,\n      max: maxDelay,\n    })}ms`,\n    width: `${randomInt({\n      min: minPercentage,\n      max: maxPercentage,\n    })}%`,\n  };\n}\n"],"names":["bem","randomInt","skeletonPlaceholder","randomSkeletonPlaceholder","options","minDelay","maxDelay","minPercentage","maxPercentage","animationDelay","min","max","width"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AACA,SAASA,GAAG,QAAQ,kBAAkB;AACtC,SAASC,SAAS,QAAQ,wBAAwB;AAElD;;CAEC,GACD,OAAO,MAAMC,sBAAsBF,IAAI,4BAA4B;AA0DnE;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASG,0BACdC,UAA4C,CAAC,CAAC;IAE9C,MAAM,EACJC,WAAW,CAAC,EACZC,WAAW,GAAG,EACdC,gBAAgB,EAAE,EAClBC,gBAAgB,EAAE,EACnB,GAAGJ;IAEJ,OAAO;QACLK,gBAAgB,CAAC,CAAC,EAAER,UAAU;YAC5BS,KAAKL;YACLM,KAAKL;QACP,GAAG,EAAE,CAAC;QACNM,OAAO,CAAC,EAAEX,UAAU;YAClBS,KAAKH;YACLI,KAAKH;QACP,GAAG,CAAC,CAAC;IACP;AACF"}
+{"version":3,"sources":["../../src/transition/skeletonPlaceholderUtils.ts"],"sourcesContent":["import { type CSSProperties } from \"react\";\nimport { bem } from \"../utils/bem.js\";\nimport { randomInt } from \"../utils/randomInt.js\";\n\n/**\n * @since 6.0.0\n */\nexport const skeletonPlaceholder = bem(\"rmd-skeleton-placeholder\");\n\n/**\n * @since 6.0.0\n */\nexport interface SkeletonPlaceholderRandomOptions {\n  /**\n   * The minimum `animation-delay` milliseconds allowed in the random generator.\n   * This value should be: `0 <= minDelay < maxDelay`.\n   *\n   * The `animation-delay` will be generated by:\n   * ```ts\n   * const delay = randomInt({\n   *   min: minDelay,\n   *   max: maxDelay,\n   * });\n   *\n   * return {\n   *   animationDelay: `-${delay}ms`,\n   * };\n   * ```\n   *\n   * @defaultValue `0`\n   */\n  minDelay?: number;\n\n  /**\n   * @see {@link minDelay}\n   * @defaultValue `400`\n   */\n  maxDelay?: number;\n\n  /**\n   * The minimum width percentage allowed in the random generator. This value\n   * should be: `0 >= minPercentage < maxPercentage`.\n   *\n   * The `width` will be generated by:\n   * ```ts\n   * const width = randomInt({\n   *   min: minPercentage,\n   *   max: maxPercentage,\n   * });\n   *\n   * return {\n   *   width: `${width}%`,\n   * };\n   * ```\n   * @defaultValue `40`\n   */\n  minPercentage?: number;\n\n  /**\n   * @see {@link minPercentage}\n   * @defaultValue `85`\n   */\n  maxPercentage?: number;\n}\n\n/**\n * A server-only safe util to generate a random skeleton placeholder.\n *\n * @example\n * ```tsx\n * import { skeletonPlaceholder, randomSkeletonPlaceholder } from \"@react-md/core\";\n * import \"server-only\";\n *\n * export function RandomSkeletonPlaceholder(): ReactElement {\n *   return\n *     <div\n *       style={randomSkeletonPlaceholder()}\n *       className={skeletonPlaceholder()}\n *     />\n *   );\n * }\n * ```\n * @since 6.0.0\n */\nexport function randomSkeletonPlaceholder(\n  options: SkeletonPlaceholderRandomOptions = {}\n): CSSProperties {\n  const {\n    minDelay = 0,\n    maxDelay = 400,\n    minPercentage = 40,\n    maxPercentage = 85,\n  } = options;\n\n  return {\n    animationDelay: `-${randomInt({\n      min: minDelay,\n      max: maxDelay,\n    })}ms`,\n    width: `${randomInt({\n      min: minPercentage,\n      max: maxPercentage,\n    })}%`,\n  };\n}\n"],"names":["bem","randomInt","skeletonPlaceholder","randomSkeletonPlaceholder","options","minDelay","maxDelay","minPercentage","maxPercentage","animationDelay","min","max","width"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AACA,SAASA,GAAG,QAAQ,kBAAkB;AACtC,SAASC,SAAS,QAAQ,wBAAwB;AAElD;;CAEC,GACD,OAAO,MAAMC,sBAAsBF,IAAI,4BAA4B;AA0DnE;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASG,0BACdC,UAA4C,CAAC,CAAC;IAE9C,MAAM,EACJC,WAAW,CAAC,EACZC,WAAW,GAAG,EACdC,gBAAgB,EAAE,EAClBC,gBAAgB,EAAE,EACnB,GAAGJ;IAEJ,OAAO;QACLK,gBAAgB,CAAC,CAAC,EAAER,UAAU;YAC5BS,KAAKL;YACLM,KAAKL;QACP,GAAG,EAAE,CAAC;QACNM,OAAO,CAAC,EAAEX,UAAU;YAClBS,KAAKH;YACLI,KAAKH;QACP,GAAG,CAAC,CAAC;IACP;AACF"}

package/dist/transition/types.d.ts

@@ -1,6 +1,6 @@
 import type { ReactElement, Ref, RefCallback } from "react";
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface TransitionActions {
     /**
@@ -32,7 +32,7 @@ export interface TransitionActions {
  * {@link TransitionActions}. If a value is set to `0` or `undefined`, the
  * transition will not occur.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type TransitionTimeoutObject = {
     [action in keyof TransitionActions]?: number;
@@ -42,7 +42,7 @@ export type TransitionTimeoutObject = {
  * {@link TransitionActions} stages, or an object of transition durations.
  *
  * @see {@link TransitionTimeout}
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type TransitionTimeout = number | Readonly<TransitionTimeoutObject>;
 /**
@@ -51,7 +51,7 @@ export type TransitionTimeout = number | Readonly<TransitionTimeoutObject>;
  * begin the enter transition going from `enter -> entering -> entered` while
  * setting the stage to `exit` will transition from `exit -> exiting -> exited`.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type TransitionStage = "enter" | "entering" | "entered" | "exit" | "exiting" | "exited";
 /**
@@ -61,19 +61,20 @@ export type TransitionStage = "enter" | "entering" | "entered" | "exit" | "exiti
  * calculations.
  *
  * @param appearing - Boolean if this is the initial `appear` flow.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type TransitionEnterHandler = (appearing: boolean) => void;
 /**
- * THis function is called at each `"exit"` {@link TransitionStage}. If a {@link
- * TransitionOptions.nodeRef} was provided, the DOM node should be available in
- * `nodeRef.current` by this point if the transition requires DOM calculations.
+ * This function is called at each `"exit"` {@link TransitionStage}. If a
+ * {@link TransitionOptions.nodeRef} was provided, the DOM node should be
+ * available in `nodeRef.current` by this point if the transition requires DOM
+ * calculations.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type TransitionExitHandler = () => void;
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface TransitionCallbacks {
     /**
@@ -122,7 +123,7 @@ export interface TransitionCallbacks {
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface PreconfiguredTransitionInDefaultedOptions<E extends HTMLElement> extends TransitionActions, TransitionCallbacks {
     /**
@@ -150,7 +151,7 @@ export interface PreconfiguredTransitionInDefaultedOptions<E extends HTMLElement
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface PreconfiguredTransitionOptions<E extends HTMLElement> extends PreconfiguredTransitionInDefaultedOptions<E> {
     /** {@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn} */
@@ -159,7 +160,7 @@ export interface PreconfiguredTransitionOptions<E extends HTMLElement> extends P
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface TransitionOptions<E extends HTMLElement> extends PreconfiguredTransitionOptions<E> {
     /** {@inheritDoc TransitionTimeout} */
@@ -170,8 +171,7 @@ export interface TransitionOptions<E extends HTMLElement> extends PreconfiguredT
  * {@link TransitionStage} where all the classes in the previous stages will
  * also be applied.
  *
- * @example
- * Explaining className application
+ * @example Explaining className application
  * ```ts
  * const { ref, className, stage, appearing } = useCSSTransition({
  *   appear: true,
@@ -221,7 +221,7 @@ export interface TransitionOptions<E extends HTMLElement> extends PreconfiguredT
  * // className === "exit--done exit--complete"
  * ```
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface CSSTransitionClassNamesObject {
     /**
@@ -283,13 +283,13 @@ export interface CSSTransitionClassNamesObject {
     exitDone?: string;
 }
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export type CSSTransitionClassNames = string | Readonly<CSSTransitionClassNamesObject>;
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface PreconfiguredCSSTransitionInDefaultedOptions<E extends HTMLElement> extends PreconfiguredTransitionInDefaultedOptions<E> {
     /**
@@ -302,14 +302,14 @@ export interface PreconfiguredCSSTransitionInDefaultedOptions<E extends HTMLElem
      * conditionally rendering the element.
      *
      * @defaultValue `false`
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      */
     exitedHidden?: boolean;
 }
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface PreconfiguredCSSTransitionOptions<E extends HTMLElement> extends PreconfiguredCSSTransitionInDefaultedOptions<E> {
     /** {@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn} */
@@ -318,7 +318,7 @@ export interface PreconfiguredCSSTransitionOptions<E extends HTMLElement> extend
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface TransitionHookOptions<E extends HTMLElement> extends TransitionOptions<E> {
     /**
@@ -330,13 +330,13 @@ export interface TransitionHookOptions<E extends HTMLElement> extends Transition
      */
     reflow?: boolean;
     /**
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      * @defaultValue `false`
      */
     disablePortal?: boolean;
 }
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface TransitionState {
     /** {@inheritDoc TransitionStage} */
@@ -358,7 +358,7 @@ export interface TransitionState {
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface TransitionHookReturnValue<E extends HTMLElement> extends TransitionState {
     /**
@@ -372,8 +372,7 @@ export interface TransitionHookReturnValue<E extends HTMLElement> extends Transi
      * useful for "appear only transitions" that do not unmount the child
      * elements.
      *
-     * @example
-     * Simple Example
+     * @example Simple Example
      * ```tsx
      * import { ReactElement, useEffect, useRef } from "react";
      * import { useCSSTransition } from "@react-md/transition";
@@ -413,14 +412,14 @@ export interface TransitionHookReturnValue<E extends HTMLElement> extends Transi
      * from the server and remain true until it unmounts from the DOM.
      *
      * @defaultValue `false`
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      */
     disablePortal: boolean;
 }
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface CSSTransitionHookOptions<E extends HTMLElement> extends PreconfiguredCSSTransitionOptions<E> {
     /** {@inheritDoc TransitionTimeout} */
@@ -428,14 +427,14 @@ export interface CSSTransitionHookOptions<E extends HTMLElement> extends Preconf
     /** {@inheritDoc CSSTransitionClassNames} */
     classNames: CSSTransitionClassNames;
     /**
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      */
     disablePortal?: boolean;
 }
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface CSSTransitionElementProps<E extends HTMLElement> {
     /** @see {@link TransitionHookReturnValue.ref} */
@@ -448,15 +447,14 @@ export interface CSSTransitionElementProps<E extends HTMLElement> {
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface CSSTransitionHookReturnValue<E extends HTMLElement> extends TransitionHookReturnValue<E>, CSSTransitionElementProps<E> {
     /**
      * This can be used so that you don't need to destructure multiple props from
      * the hook return value to pass to the transitioning component.
      *
-     * @example
-     * Simple Example
+     * @example Simple Example
      * ```tsx
      * import type { ReactElement } from "react";
      * import { useCSSTransition } from "@react-md/transition";
@@ -481,8 +479,7 @@ export interface CSSTransitionHookReturnValue<E extends HTMLElement> extends Tra
      * }
      * ```
      *
-     * @example
-     * Verbose Version
+     * @example Verbose Version
      * ```tsx
      * import type { ReactElement } from "react";
      * import { useCSSTransition } from "@react-md/transition";
@@ -513,7 +510,7 @@ export interface CSSTransitionHookReturnValue<E extends HTMLElement> extends Tra
  * This is mostly an internal type that can be used to help with transitionable
  * components.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface CSSTransitionComponentProps extends TransitionCallbacks {
     /** @see {@link CSSTransitionHookOptions.temporary} */
@@ -528,7 +525,7 @@ export interface CSSTransitionComponentProps extends TransitionCallbacks {
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export interface CSSTransitionComponentImplementation<E extends HTMLElement> {
     /**

package/dist/transition/types.js

@@ -5,7 +5,7 @@
 /**
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */ export { };
 
 //# sourceMappingURL=types.js.map

package/dist/transition/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/types.ts"],"sourcesContent":["// This is pretty much `react-transition-group` since I liked the API wanted a\n// hook implementation. I also had to redo most of the types for v4.0.0 due to\n// the new `nodeRef` stuff, so it made it easier to create the types and hooks\n// here.\n\nimport type { ReactElement, Ref, RefCallback } from \"react\";\n\n/**\n * @remarks \\@since 4.0.0\n */\nexport interface TransitionActions {\n  /**\n   * Boolean if the transition should occur immediately once the component\n   * mounts if the {@link TransitionOptions.transitionIn} is `true`\n   *\n   * @defaultValue `false`\n   */\n  appear?: boolean;\n\n  /**\n   * Boolean if the transition should occur whenever the\n   * {@link TransitionOptions.transitionIn} is switch to `true` after the\n   * component has been rendered in the DOM.\n   *\n   * @defaultValue `true`\n   */\n  enter?: boolean;\n\n  /**\n   * Boolean if the transition should occur whenever the\n   * {@link TransitionOptions.transitionIn} is switch to `false` after the\n   * component has been rendered in the DOM.\n   *\n   * @defaultValue `true`\n   */\n  exit?: boolean;\n}\n\n/**\n * An object timeout values that would be used for each\n * {@link TransitionActions}. If a value is set to `0` or `undefined`, the\n * transition will not occur.\n *\n * @remarks \\@since 4.0.0\n */\nexport type TransitionTimeoutObject = {\n  [action in keyof TransitionActions]?: number;\n};\n\n/**\n * Either a single timeout duration in milliseconds to use for each of the\n * {@link TransitionActions} stages, or an object of transition durations.\n *\n * @see {@link TransitionTimeout}\n * @remarks \\@since 4.0.0\n */\nexport type TransitionTimeout = number | Readonly<TransitionTimeoutObject>;\n\n/**\n * The way the transition works is by flowing through the different stages and\n * assigning waiting for a timeout to occur. Setting the `stage` to `enter` will\n * begin the enter transition going from `enter -> entering -> entered` while\n * setting the stage to `exit` will transition from `exit -> exiting -> exited`.\n *\n * @remarks \\@since 4.0.0\n */\nexport type TransitionStage =\n  | \"enter\"\n  | \"entering\"\n  | \"entered\"\n  | \"exit\"\n  | \"exiting\"\n  | \"exited\";\n\n/**\n * This function is called at each `\"enter\"` {@link TransitionStage}. If a\n * {@link TransitionOptions.nodeRef} was provided, the DOM node should be\n * available in `nodeRef.current` by this point if the transition requires DOM\n * calculations.\n *\n * @param appearing - Boolean if this is the initial `appear` flow.\n * @remarks \\@since 4.0.0\n */\nexport type TransitionEnterHandler = (appearing: boolean) => void;\n\n/**\n * THis function is called at each `\"exit\"` {@link TransitionStage}. If a {@link\n * TransitionOptions.nodeRef} was provided, the DOM node should be available in\n * `nodeRef.current` by this point if the transition requires DOM calculations.\n *\n * @remarks \\@since 4.0.0\n */\nexport type TransitionExitHandler = () => void;\n\n/**\n * @remarks \\@since 4.0.0\n */\nexport interface TransitionCallbacks {\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"enter\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onEnter?: TransitionEnterHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"enter\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onEntering?: TransitionEnterHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"entering\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onEntered?: TransitionEnterHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"entered\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onExit?: TransitionExitHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"exiting\"`.\n   *\n   * @see {@link TransitionExitHandler}\n   */\n  onExiting?: TransitionExitHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"exited\"`.\n   *\n   * @see {@link TransitionExitHandler}\n   */\n  onExited?: TransitionExitHandler;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface PreconfiguredTransitionInDefaultedOptions<\n  E extends HTMLElement,\n> extends TransitionActions,\n    TransitionCallbacks {\n  /**\n   * An optional ref that will be merged with the\n   * {@link TransitionHookReturnValue.ref}\n   */\n  nodeRef?: Ref<E>;\n\n  /**\n   * Boolean if the element should mount and unmount based on the\n   * {@link PreconfiguredTransitionInDefaultedOptions.transitionIn} value.\n   *\n   * @defaultValue `false`\n   */\n  temporary?: boolean;\n\n  /**\n   * This boolean controls the transition by activating flowing through the\n   * {@link TransitionStage}.\n   *\n   * @see {@link TransitionActions} for a description around the transitions.\n   */\n  transitionIn?: boolean;\n\n  /** {@inheritDoc TransitionTimeout} */\n  timeout?: TransitionTimeout;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface PreconfiguredTransitionOptions<E extends HTMLElement>\n  extends PreconfiguredTransitionInDefaultedOptions<E> {\n  /** {@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn} */\n  transitionIn: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface TransitionOptions<E extends HTMLElement>\n  extends PreconfiguredTransitionOptions<E> {\n  /** {@inheritDoc TransitionTimeout} */\n  timeout: TransitionTimeout;\n}\n\n/**\n * An object of classnames that will be applied based on the\n * {@link TransitionStage} where all the classes in the previous stages will\n * also be applied.\n *\n * @example\n * Explaining className application\n * ```ts\n * const { ref, className, stage, appearing } = useCSSTransition({\n *   appear: true,\n *   enter: true,\n *   exit: true,\n *   timeout: 300,\n *   classNames: {\n *     appear: \"appear\",\n *     appearEnter: \"appear--enter\",\n *     appearDone: \"appear--done appear--complete\",\n *     enter: \"enter\",\n *     enterEnter: \"\",\n *     enterDone: \"enter--done enter--complete\",\n *     exit: \"\",\n *     exitEnter: \"\",\n *     exitDone: \"exit--done exit--complete\",\n *   }\n * });\n *\n * // stage === \"enter\" && appearing\n * // className === \"appear\"\n * //\n * // stage === \"entering\" && appearing\n * // className === \"appear appear--enter\"\n * //\n * // stage === \"entered\" && appearing\n * // className === \"appear--done appear--complete\"\n * //\n * //\n * // stage === \"enter\" && !appearing\n * // className === \"enter\"\n * //\n * // stage === \"entering\" && !appearing\n * // className === \"enter\"\n * //\n * // stage === \"entered\" && !appearing\n * // className === \"enter--done enter--complete\"\n * //\n * //\n * // stage === \"exit\"\n * // className === \"\"\n * //\n * // stage === \"exiting\"\n * // className === \"\"\n * //\n * // stage === \"exited\"\n * // className === \"exit--done exit--complete\"\n * ```\n *\n * @remarks \\@since 4.0.0\n */\nexport interface CSSTransitionClassNamesObject {\n  /**\n   * The class name to apply starting at the `\"enter\"` {@link TransitionStage}\n   * while {@link TransitionState.appearing}.\n   *\n   * @defaultValue `\"\"`\n   */\n  appear?: string;\n\n  /**\n   * The class name to apply starting at the `\"entering\"` {@link TransitionStage}\n   * while {@link TransitionState.appearing}.\n   *\n   * @defaultValue `\"\"`\n   */\n  appearActive?: string;\n\n  /**\n   * The class name to apply starting at the `\"entered\"` {@link TransitionStage}\n   * while {@link TransitionState.appearing}.\n   *\n   * @defaultValue `\"\"`\n   */\n  appearDone?: string;\n\n  /**\n   * The class name to apply starting at the `\"enter\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  enter?: string;\n\n  /**\n   * The class name to apply starting at the `\"entering\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  enterActive?: string;\n\n  /**\n   * The class name to apply starting at the `\"entered\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  enterDone?: string;\n\n  /**\n   * The class name to apply starting at the `\"exit\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  exit?: string;\n\n  /**\n   * The class name to apply starting at the `\"exiting\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  exitActive?: string;\n\n  /**\n   * The class name to apply starting at the `\"exited\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  exitDone?: string;\n}\n\n/**\n * @remarks \\@since 4.0.0\n */\nexport type CSSTransitionClassNames =\n  | string\n  | Readonly<CSSTransitionClassNamesObject>;\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface PreconfiguredCSSTransitionInDefaultedOptions<\n  E extends HTMLElement,\n> extends PreconfiguredTransitionInDefaultedOptions<E> {\n  /**\n   * An optional className to be merged with the transition classes.\n   */\n  className?: string;\n\n  /**\n   * When this is `true` and the {@link temporary} option is `false`, the\n   * element will gain a class name to hide it with `display: none` instead of\n   * conditionally rendering the element.\n   *\n   * @defaultValue `false`\n   * @remarks \\@since 6.0.0\n   */\n  exitedHidden?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface PreconfiguredCSSTransitionOptions<E extends HTMLElement>\n  extends PreconfiguredCSSTransitionInDefaultedOptions<E> {\n  /** {@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn} */\n  transitionIn: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface TransitionHookOptions<E extends HTMLElement>\n  extends TransitionOptions<E> {\n  /**\n   * Boolean if the DOM should forcefully be reflow each time a transition\n   * change occurs. This is generally required for any CSS transition and is\n   * set to `true` for the {@link useCSSTransition} hook.\n   *\n   * @defaultValue `false`\n   */\n  reflow?: boolean;\n\n  /**\n   * @remarks \\@since 6.0.0\n   * @defaultValue `false`\n   */\n  disablePortal?: boolean;\n}\n\n/**\n * @remarks \\@since 4.0.0\n */\nexport interface TransitionState {\n  /** {@inheritDoc TransitionStage} */\n  stage: TransitionStage;\n\n  /**\n   * Boolean if the element should be rendered or not. This will always be\n   * `true` if the {@link TransitionOptions.temporary} is `false`. Otherwise, it\n   * will be `true` when not the `\"exited\"` {@link TransitionStage}.\n   */\n  rendered: boolean;\n\n  /**\n   * Boolean if this is the first {@link TransitionActions.appear} transition.\n   * This will be `true` during the first transition if\n   * {@link TransitionActions.appear} was also `true`. Otherwise it will be\n   * `false`.\n   */\n  appearing: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface TransitionHookReturnValue<E extends HTMLElement>\n  extends TransitionState {\n  /**\n   * A ref that is required for the transition to occur and should be passed to\n   * the element affected by the transition.\n   */\n  ref: RefCallback<E>;\n\n  /**\n   * A function that can be used to specifically set the transition to a\n   * specific stage. This shouldn't really be used too much and is really just\n   * useful for \"appear only transitions\" that do not unmount the child\n   * elements.\n   *\n   * @example\n   * Simple Example\n   * ```tsx\n   * import { ReactElement, useEffect, useRef } from \"react\";\n   * import { useCSSTransition } from \"@react-md/transition\";\n   * import { useRouter } from \"react-router-dom\";\n   *\n   * function Example(): ReactElement {\n   *   const { pathname } = useRouter();\n   *   const { elementProps, transitionTo } = useCSSTransition({\n   *     transitionIn: true,\n   *     timeout: 1000,\n   *     classNames: \"some-enter-transition\",\n   *   });\n   *\n   *   useEffect(() => {\n   *     // Do not trigger transition on first load.\n   *     if (prevPathname.current === pathname) {\n   *       return;\n   *     }\n   *\n   *     prevPathname.current = pathname;\n   *     transitionTo(\"enter\");\n   *   }, [pathname, transitionTo]);\n   *\n   *   return <div {...elementProps}>{content}</div>;\n   * }\n   * ```\n   *\n   * @param stage - The {@link TransitionStage} to set to\n   */\n  transitionTo(stage: TransitionStage): void;\n\n  /**\n   * This is mostly used internally to make it so that you can render portalled\n   * elements inline with content if SSR is enabled in your app. To enable this\n   * feature, the {@link CoreProvidersProps.ssr} must be set to `true`.\n   *\n   * This value will be `true` if a portalled element was rendered by default\n   * from the server and remain true until it unmounts from the DOM.\n   *\n   * @defaultValue `false`\n   * @remarks \\@since 6.0.0\n   */\n  disablePortal: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface CSSTransitionHookOptions<E extends HTMLElement>\n  extends PreconfiguredCSSTransitionOptions<E> {\n  /** {@inheritDoc TransitionTimeout} */\n  timeout: TransitionTimeout;\n  /** {@inheritDoc CSSTransitionClassNames} */\n  classNames: CSSTransitionClassNames;\n\n  /**\n   * @remarks \\@since 6.0.0\n   */\n  disablePortal?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface CSSTransitionElementProps<E extends HTMLElement> {\n  /** @see {@link TransitionHookReturnValue.ref} */\n  ref: RefCallback<E>;\n\n  /**\n   * The current transition class name or `undefined`.\n   */\n  className: string | undefined;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface CSSTransitionHookReturnValue<E extends HTMLElement>\n  extends TransitionHookReturnValue<E>,\n    CSSTransitionElementProps<E> {\n  /**\n   * This can be used so that you don't need to destructure multiple props from\n   * the hook return value to pass to the transitioning component.\n   *\n   * @example\n   * Simple Example\n   * ```tsx\n   * import type { ReactElement } from \"react\";\n   * import { useCSSTransition } from \"@react-md/transition\";\n   *\n   * interface ExampleProps {\n   *   transitionIn: boolean;\n   *   children: ReactNode;\n   * }\n   *\n   * function Example({ transitionIn, children }: ExampleProps): ReactElement | null {\n   *   const { elementProps, rendered } = useCSSTransition({\n   *     timeout: 150,\n   *     classNames: \"example\",\n   *     transitionIn,\n   *   });\n   *\n   *   if (!rendered) {\n   *     return null;\n   *   }\n   *\n   *   return <div {...elementProps}>{children}</div>\n   * }\n   * ```\n   *\n   * @example\n   * Verbose Version\n   * ```tsx\n   * import type { ReactElement } from \"react\";\n   * import { useCSSTransition } from \"@react-md/transition\";\n   *\n   * interface ExampleProps {\n   *   transitionIn: boolean;\n   *   children: ReactNode;\n   * }\n   *\n   * function Example({ transitionIn, children }: ExampleProps): ReactElement | null {\n   *   const { ref, className, rendered } = useCSSTransition({\n   *     timeout: 150,\n   *     classNames: \"example\",\n   *     transitionIn,\n   *   });\n   *\n   *   if (!rendered) {\n   *     return null;\n   *   }\n   *\n   *   return <div ref={ref} className={className}>{children}</div>\n   * }\n   * ```\n   */\n  elementProps: CSSTransitionElementProps<E>;\n}\n\n/**\n * This is mostly an internal type that can be used to help with transitionable\n * components.\n *\n * @remarks \\@since 4.0.0\n */\nexport interface CSSTransitionComponentProps extends TransitionCallbacks {\n  /** @see {@link CSSTransitionHookOptions.temporary} */\n  temporary?: boolean;\n  /** @see {@link TransitionTimeout} */\n  timeout?: TransitionTimeout;\n  /** @see {@link CSSTransitionClassNames} */\n  classNames?: CSSTransitionClassNames;\n  /** @see {@link CSSTransitionHookOptions.exitedHidden} */\n  exitedHidden?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport interface CSSTransitionComponentImplementation<E extends HTMLElement> {\n  /**\n   * The child element that should have a `ref` and `className` cloned into\n   * using the `cloneElement` API. If the child is a custom component, you\n   * **must** use `React.forwardRef` and pass both of these to a DOM element for\n   * the transition to work.\n   */\n  children: ReactElement<{ ref: Ref<E>; className: string | undefined }>;\n}\n"],"names":[],"rangeMappings":";;;;;;;;","mappings":"AAAA,8EAA8E;AAC9E,8EAA8E;AAC9E,8EAA8E;AAC9E,QAAQ;AAslBR;;;;CAIC,GACD,WAQC"}
+{"version":3,"sources":["../../src/transition/types.ts"],"sourcesContent":["// This is pretty much `react-transition-group` since I liked the API wanted a\n// hook implementation. I also had to redo most of the types for v4.0.0 due to\n// the new `nodeRef` stuff, so it made it easier to create the types and hooks\n// here.\n\nimport type { ReactElement, Ref, RefCallback } from \"react\";\n\n/**\n * @since 4.0.0\n */\nexport interface TransitionActions {\n  /**\n   * Boolean if the transition should occur immediately once the component\n   * mounts if the {@link TransitionOptions.transitionIn} is `true`\n   *\n   * @defaultValue `false`\n   */\n  appear?: boolean;\n\n  /**\n   * Boolean if the transition should occur whenever the\n   * {@link TransitionOptions.transitionIn} is switch to `true` after the\n   * component has been rendered in the DOM.\n   *\n   * @defaultValue `true`\n   */\n  enter?: boolean;\n\n  /**\n   * Boolean if the transition should occur whenever the\n   * {@link TransitionOptions.transitionIn} is switch to `false` after the\n   * component has been rendered in the DOM.\n   *\n   * @defaultValue `true`\n   */\n  exit?: boolean;\n}\n\n/**\n * An object timeout values that would be used for each\n * {@link TransitionActions}. If a value is set to `0` or `undefined`, the\n * transition will not occur.\n *\n * @since 4.0.0\n */\nexport type TransitionTimeoutObject = {\n  [action in keyof TransitionActions]?: number;\n};\n\n/**\n * Either a single timeout duration in milliseconds to use for each of the\n * {@link TransitionActions} stages, or an object of transition durations.\n *\n * @see {@link TransitionTimeout}\n * @since 4.0.0\n */\nexport type TransitionTimeout = number | Readonly<TransitionTimeoutObject>;\n\n/**\n * The way the transition works is by flowing through the different stages and\n * assigning waiting for a timeout to occur. Setting the `stage` to `enter` will\n * begin the enter transition going from `enter -> entering -> entered` while\n * setting the stage to `exit` will transition from `exit -> exiting -> exited`.\n *\n * @since 4.0.0\n */\nexport type TransitionStage =\n  | \"enter\"\n  | \"entering\"\n  | \"entered\"\n  | \"exit\"\n  | \"exiting\"\n  | \"exited\";\n\n/**\n * This function is called at each `\"enter\"` {@link TransitionStage}. If a\n * {@link TransitionOptions.nodeRef} was provided, the DOM node should be\n * available in `nodeRef.current` by this point if the transition requires DOM\n * calculations.\n *\n * @param appearing - Boolean if this is the initial `appear` flow.\n * @since 4.0.0\n */\nexport type TransitionEnterHandler = (appearing: boolean) => void;\n\n/**\n * This function is called at each `\"exit\"` {@link TransitionStage}. If a\n * {@link TransitionOptions.nodeRef} was provided, the DOM node should be\n * available in `nodeRef.current` by this point if the transition requires DOM\n * calculations.\n *\n * @since 4.0.0\n */\nexport type TransitionExitHandler = () => void;\n\n/**\n * @since 4.0.0\n */\nexport interface TransitionCallbacks {\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"enter\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onEnter?: TransitionEnterHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"enter\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onEntering?: TransitionEnterHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"entering\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onEntered?: TransitionEnterHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"entered\"`.\n   *\n   * @see {@link TransitionEnterHandler}\n   */\n  onExit?: TransitionExitHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"exiting\"`.\n   *\n   * @see {@link TransitionExitHandler}\n   */\n  onExiting?: TransitionExitHandler;\n\n  /**\n   * This function will be called once the {@link TransitionStage} has been set\n   * to `\"exited\"`.\n   *\n   * @see {@link TransitionExitHandler}\n   */\n  onExited?: TransitionExitHandler;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface PreconfiguredTransitionInDefaultedOptions<\n  E extends HTMLElement,\n> extends TransitionActions,\n    TransitionCallbacks {\n  /**\n   * An optional ref that will be merged with the\n   * {@link TransitionHookReturnValue.ref}\n   */\n  nodeRef?: Ref<E>;\n\n  /**\n   * Boolean if the element should mount and unmount based on the\n   * {@link PreconfiguredTransitionInDefaultedOptions.transitionIn} value.\n   *\n   * @defaultValue `false`\n   */\n  temporary?: boolean;\n\n  /**\n   * This boolean controls the transition by activating flowing through the\n   * {@link TransitionStage}.\n   *\n   * @see {@link TransitionActions} for a description around the transitions.\n   */\n  transitionIn?: boolean;\n\n  /** {@inheritDoc TransitionTimeout} */\n  timeout?: TransitionTimeout;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface PreconfiguredTransitionOptions<E extends HTMLElement>\n  extends PreconfiguredTransitionInDefaultedOptions<E> {\n  /** {@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn} */\n  transitionIn: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface TransitionOptions<E extends HTMLElement>\n  extends PreconfiguredTransitionOptions<E> {\n  /** {@inheritDoc TransitionTimeout} */\n  timeout: TransitionTimeout;\n}\n\n/**\n * An object of classnames that will be applied based on the\n * {@link TransitionStage} where all the classes in the previous stages will\n * also be applied.\n *\n * @example Explaining className application\n * ```ts\n * const { ref, className, stage, appearing } = useCSSTransition({\n *   appear: true,\n *   enter: true,\n *   exit: true,\n *   timeout: 300,\n *   classNames: {\n *     appear: \"appear\",\n *     appearEnter: \"appear--enter\",\n *     appearDone: \"appear--done appear--complete\",\n *     enter: \"enter\",\n *     enterEnter: \"\",\n *     enterDone: \"enter--done enter--complete\",\n *     exit: \"\",\n *     exitEnter: \"\",\n *     exitDone: \"exit--done exit--complete\",\n *   }\n * });\n *\n * // stage === \"enter\" && appearing\n * // className === \"appear\"\n * //\n * // stage === \"entering\" && appearing\n * // className === \"appear appear--enter\"\n * //\n * // stage === \"entered\" && appearing\n * // className === \"appear--done appear--complete\"\n * //\n * //\n * // stage === \"enter\" && !appearing\n * // className === \"enter\"\n * //\n * // stage === \"entering\" && !appearing\n * // className === \"enter\"\n * //\n * // stage === \"entered\" && !appearing\n * // className === \"enter--done enter--complete\"\n * //\n * //\n * // stage === \"exit\"\n * // className === \"\"\n * //\n * // stage === \"exiting\"\n * // className === \"\"\n * //\n * // stage === \"exited\"\n * // className === \"exit--done exit--complete\"\n * ```\n *\n * @since 4.0.0\n */\nexport interface CSSTransitionClassNamesObject {\n  /**\n   * The class name to apply starting at the `\"enter\"` {@link TransitionStage}\n   * while {@link TransitionState.appearing}.\n   *\n   * @defaultValue `\"\"`\n   */\n  appear?: string;\n\n  /**\n   * The class name to apply starting at the `\"entering\"` {@link TransitionStage}\n   * while {@link TransitionState.appearing}.\n   *\n   * @defaultValue `\"\"`\n   */\n  appearActive?: string;\n\n  /**\n   * The class name to apply starting at the `\"entered\"` {@link TransitionStage}\n   * while {@link TransitionState.appearing}.\n   *\n   * @defaultValue `\"\"`\n   */\n  appearDone?: string;\n\n  /**\n   * The class name to apply starting at the `\"enter\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  enter?: string;\n\n  /**\n   * The class name to apply starting at the `\"entering\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  enterActive?: string;\n\n  /**\n   * The class name to apply starting at the `\"entered\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  enterDone?: string;\n\n  /**\n   * The class name to apply starting at the `\"exit\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  exit?: string;\n\n  /**\n   * The class name to apply starting at the `\"exiting\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  exitActive?: string;\n\n  /**\n   * The class name to apply starting at the `\"exited\"` {@link TransitionStage}\n   *\n   * @defaultValue `\"\"`\n   */\n  exitDone?: string;\n}\n\n/**\n * @since 4.0.0\n */\nexport type CSSTransitionClassNames =\n  | string\n  | Readonly<CSSTransitionClassNamesObject>;\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface PreconfiguredCSSTransitionInDefaultedOptions<\n  E extends HTMLElement,\n> extends PreconfiguredTransitionInDefaultedOptions<E> {\n  /**\n   * An optional className to be merged with the transition classes.\n   */\n  className?: string;\n\n  /**\n   * When this is `true` and the {@link temporary} option is `false`, the\n   * element will gain a class name to hide it with `display: none` instead of\n   * conditionally rendering the element.\n   *\n   * @defaultValue `false`\n   * @since 6.0.0\n   */\n  exitedHidden?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface PreconfiguredCSSTransitionOptions<E extends HTMLElement>\n  extends PreconfiguredCSSTransitionInDefaultedOptions<E> {\n  /** {@inheritDoc PreconfiguredTransitionInDefaultedOptions.transitionIn} */\n  transitionIn: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface TransitionHookOptions<E extends HTMLElement>\n  extends TransitionOptions<E> {\n  /**\n   * Boolean if the DOM should forcefully be reflow each time a transition\n   * change occurs. This is generally required for any CSS transition and is\n   * set to `true` for the {@link useCSSTransition} hook.\n   *\n   * @defaultValue `false`\n   */\n  reflow?: boolean;\n\n  /**\n   * @since 6.0.0\n   * @defaultValue `false`\n   */\n  disablePortal?: boolean;\n}\n\n/**\n * @since 4.0.0\n */\nexport interface TransitionState {\n  /** {@inheritDoc TransitionStage} */\n  stage: TransitionStage;\n\n  /**\n   * Boolean if the element should be rendered or not. This will always be\n   * `true` if the {@link TransitionOptions.temporary} is `false`. Otherwise, it\n   * will be `true` when not the `\"exited\"` {@link TransitionStage}.\n   */\n  rendered: boolean;\n\n  /**\n   * Boolean if this is the first {@link TransitionActions.appear} transition.\n   * This will be `true` during the first transition if\n   * {@link TransitionActions.appear} was also `true`. Otherwise it will be\n   * `false`.\n   */\n  appearing: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface TransitionHookReturnValue<E extends HTMLElement>\n  extends TransitionState {\n  /**\n   * A ref that is required for the transition to occur and should be passed to\n   * the element affected by the transition.\n   */\n  ref: RefCallback<E>;\n\n  /**\n   * A function that can be used to specifically set the transition to a\n   * specific stage. This shouldn't really be used too much and is really just\n   * useful for \"appear only transitions\" that do not unmount the child\n   * elements.\n   *\n   * @example Simple Example\n   * ```tsx\n   * import { ReactElement, useEffect, useRef } from \"react\";\n   * import { useCSSTransition } from \"@react-md/transition\";\n   * import { useRouter } from \"react-router-dom\";\n   *\n   * function Example(): ReactElement {\n   *   const { pathname } = useRouter();\n   *   const { elementProps, transitionTo } = useCSSTransition({\n   *     transitionIn: true,\n   *     timeout: 1000,\n   *     classNames: \"some-enter-transition\",\n   *   });\n   *\n   *   useEffect(() => {\n   *     // Do not trigger transition on first load.\n   *     if (prevPathname.current === pathname) {\n   *       return;\n   *     }\n   *\n   *     prevPathname.current = pathname;\n   *     transitionTo(\"enter\");\n   *   }, [pathname, transitionTo]);\n   *\n   *   return <div {...elementProps}>{content}</div>;\n   * }\n   * ```\n   *\n   * @param stage - The {@link TransitionStage} to set to\n   */\n  transitionTo(stage: TransitionStage): void;\n\n  /**\n   * This is mostly used internally to make it so that you can render portalled\n   * elements inline with content if SSR is enabled in your app. To enable this\n   * feature, the {@link CoreProvidersProps.ssr} must be set to `true`.\n   *\n   * This value will be `true` if a portalled element was rendered by default\n   * from the server and remain true until it unmounts from the DOM.\n   *\n   * @defaultValue `false`\n   * @since 6.0.0\n   */\n  disablePortal: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface CSSTransitionHookOptions<E extends HTMLElement>\n  extends PreconfiguredCSSTransitionOptions<E> {\n  /** {@inheritDoc TransitionTimeout} */\n  timeout: TransitionTimeout;\n  /** {@inheritDoc CSSTransitionClassNames} */\n  classNames: CSSTransitionClassNames;\n\n  /**\n   * @since 6.0.0\n   */\n  disablePortal?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface CSSTransitionElementProps<E extends HTMLElement> {\n  /** @see {@link TransitionHookReturnValue.ref} */\n  ref: RefCallback<E>;\n\n  /**\n   * The current transition class name or `undefined`.\n   */\n  className: string | undefined;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface CSSTransitionHookReturnValue<E extends HTMLElement>\n  extends TransitionHookReturnValue<E>,\n    CSSTransitionElementProps<E> {\n  /**\n   * This can be used so that you don't need to destructure multiple props from\n   * the hook return value to pass to the transitioning component.\n   *\n   * @example Simple Example\n   * ```tsx\n   * import type { ReactElement } from \"react\";\n   * import { useCSSTransition } from \"@react-md/transition\";\n   *\n   * interface ExampleProps {\n   *   transitionIn: boolean;\n   *   children: ReactNode;\n   * }\n   *\n   * function Example({ transitionIn, children }: ExampleProps): ReactElement | null {\n   *   const { elementProps, rendered } = useCSSTransition({\n   *     timeout: 150,\n   *     classNames: \"example\",\n   *     transitionIn,\n   *   });\n   *\n   *   if (!rendered) {\n   *     return null;\n   *   }\n   *\n   *   return <div {...elementProps}>{children}</div>\n   * }\n   * ```\n   *\n   * @example Verbose Version\n   * ```tsx\n   * import type { ReactElement } from \"react\";\n   * import { useCSSTransition } from \"@react-md/transition\";\n   *\n   * interface ExampleProps {\n   *   transitionIn: boolean;\n   *   children: ReactNode;\n   * }\n   *\n   * function Example({ transitionIn, children }: ExampleProps): ReactElement | null {\n   *   const { ref, className, rendered } = useCSSTransition({\n   *     timeout: 150,\n   *     classNames: \"example\",\n   *     transitionIn,\n   *   });\n   *\n   *   if (!rendered) {\n   *     return null;\n   *   }\n   *\n   *   return <div ref={ref} className={className}>{children}</div>\n   * }\n   * ```\n   */\n  elementProps: CSSTransitionElementProps<E>;\n}\n\n/**\n * This is mostly an internal type that can be used to help with transitionable\n * components.\n *\n * @since 4.0.0\n */\nexport interface CSSTransitionComponentProps extends TransitionCallbacks {\n  /** @see {@link CSSTransitionHookOptions.temporary} */\n  temporary?: boolean;\n  /** @see {@link TransitionTimeout} */\n  timeout?: TransitionTimeout;\n  /** @see {@link CSSTransitionClassNames} */\n  classNames?: CSSTransitionClassNames;\n  /** @see {@link CSSTransitionHookOptions.exitedHidden} */\n  exitedHidden?: boolean;\n}\n\n/**\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport interface CSSTransitionComponentImplementation<E extends HTMLElement> {\n  /**\n   * The child element that should have a `ref` and `className` cloned into\n   * using the `cloneElement` API. If the child is a custom component, you\n   * **must** use `React.forwardRef` and pass both of these to a DOM element for\n   * the transition to work.\n   */\n  children: ReactElement<{ ref: Ref<E>; className: string | undefined }>;\n}\n"],"names":[],"rangeMappings":";;;;;;;;","mappings":"AAAA,8EAA8E;AAC9E,8EAA8E;AAC9E,8EAA8E;AAC9E,QAAQ;AAmlBR;;;;CAIC,GACD,WAQC"}

package/dist/transition/useCSSTransition.d.ts

@@ -3,8 +3,7 @@ import type { CSSTransitionHookOptions, CSSTransitionHookReturnValue } from "./t
  * This hook is used to create CSS transitions for different components whenever
  * a {@link TransitionHookOptions.transitionIn} flag is changed.
  *
- * @example
- * Simple Transition
+ * @example Simple Transition
  * ```tsx
  * import { ReactElement, useState } from "react";
  * import { Button, Typography, useCSSTransition } from "@react-md/core";
@@ -54,8 +53,7 @@ import type { CSSTransitionHookOptions, CSSTransitionHookReturnValue } from "./t
  * }
  * ```
  *
- * @example
- * Visibility Transition
+ * @example Visibility Transition
  * ```tsx
  * import { ReactElement, useState } from "react";
  * import { Button, Typography, useCSSTransition } from "@react-md/core";
@@ -111,8 +109,7 @@ import type { CSSTransitionHookOptions, CSSTransitionHookReturnValue } from "./t
  * }
  * ```
  *
- * @example
- * Mount Transition
+ * @example Mount Transition
  * ```tsx
  * import type { ReactElement } from "react";
  * import { useCSSTransition } from "@react-md/transition";
@@ -142,6 +139,6 @@ import type { CSSTransitionHookOptions, CSSTransitionHookReturnValue } from "./t
  *
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */
 export declare function useCSSTransition<E extends HTMLElement>(options: CSSTransitionHookOptions<E>): CSSTransitionHookReturnValue<E>;

package/dist/transition/useCSSTransition.js

@@ -7,8 +7,7 @@ import { getTransitionClassNames } from "./utils.js";
  * This hook is used to create CSS transitions for different components whenever
  * a {@link TransitionHookOptions.transitionIn} flag is changed.
  *
- * @example
- * Simple Transition
+ * @example Simple Transition
  * ```tsx
  * import { ReactElement, useState } from "react";
  * import { Button, Typography, useCSSTransition } from "@react-md/core";
@@ -58,8 +57,7 @@ import { getTransitionClassNames } from "./utils.js";
  * }
  * ```
  *
- * @example
- * Visibility Transition
+ * @example Visibility Transition
  * ```tsx
  * import { ReactElement, useState } from "react";
  * import { Button, Typography, useCSSTransition } from "@react-md/core";
@@ -115,8 +113,7 @@ import { getTransitionClassNames } from "./utils.js";
  * }
  * ```
  *
- * @example
- * Mount Transition
+ * @example Mount Transition
  * ```tsx
  * import type { ReactElement } from "react";
  * import { useCSSTransition } from "@react-md/transition";
@@ -146,7 +143,7 @@ import { getTransitionClassNames } from "./utils.js";
  *
  * @typeParam E - An HTMLElement type used for the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  */ export function useCSSTransition(options) {
     const { className, classNames, appear = false, enter = true, exit = true, timeout, temporary = false, exitedHidden = false, ...transitionOptions } = options;
     const { ref, stage, rendered, appearing, transitionTo, disablePortal } = useTransition({

package/dist/transition/useCSSTransition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/useCSSTransition.ts"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport { DISPLAY_NONE_CLASS } from \"../utils/isElementVisible.js\";\nimport type {\n  CSSTransitionElementProps,\n  CSSTransitionHookOptions,\n  CSSTransitionHookReturnValue,\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  TransitionHookOptions,\n} from \"./types.js\";\nimport { useTransition } from \"./useTransition.js\";\nimport { getTransitionClassNames } from \"./utils.js\";\n\n/**\n * This hook is used to create CSS transitions for different components whenever\n * a {@link TransitionHookOptions.transitionIn} flag is changed.\n *\n * @example\n * Simple Transition\n * ```tsx\n * import { ReactElement, useState } from \"react\";\n * import { Button, Typography, useCSSTransition } from \"@react-md/core\";\n *\n * // Pretend styles\n * // .enter {\n * //   opacity: 0.5;\n * //   transition: opacity .15s;\n * // }\n * //\n * // .enter--active {\n * //   opacity: 1;\n * // }\n * //\n * // .exit {\n * //   opacity: 1;\n * //   transition: opacity .15s;\n * // }\n * //\n * // .exit--active {\n * //   opacity: 0.5;\n * // }\n *\n * function Example(): ReactElement {\n *   const [transitionIn, setTransitionIn] = useState(false);\n *   const { elementProps } = useCSSTransition({\n *     timeout: 150,\n *     classNames: {\n *       enter: \"enter\",\n *       enterActive: \"enter--active\",\n *       exit: \"exit\",\n *       exitActive: \"exit--active\",\n *     },\n *     transitionIn,\n *   });\n *\n *   return (\n *     <>\n *       <Button onClick={() => setTransitionIn(!transitionIn)}>\n *         Toggle\n *       </Button>\n *       <Typography {...elementProps}>\n *         Some Opacity Changing Text\n *       </Typography>\n *     </>\n *   );\n * }\n * ```\n *\n * @example\n * Visibility Transition\n * ```tsx\n * import { ReactElement, useState } from \"react\";\n * import { Button, Typography, useCSSTransition } from \"@react-md/core\";\n *\n * // Pretend styles\n * // .enter {\n * //   opacity: 0;\n * //   transition: opacity .2s;\n * // }\n * //\n * // .enter--active {\n * //   opacity: 1;\n * // }\n * //\n * // .exit {\n * //   opacity: 1;\n * //   transition: opacity .15s;\n * // }\n * //\n * // .exit--active {\n * //   opacity: 0;\n * // }\n *\n * function Example(): ReactElement {\n *   const [transitionIn, setTransitionIn] = useState(false);\n *   const { elementProps, rendered } = useCSSTransition({\n *     timeout: {\n *       enter: 200,\n *       exit: 150,\n *     },\n *     classNames: {\n *       enter: \"enter\",\n *       enterActive: \"enter--active\",\n *       exit: \"exit\",\n *       exitActive: \"exit--active\",\n *     },\n *     transitionIn,\n *     temporary: true,\n *   });\n *\n *   return (\n *     <>\n *       <Button onClick={() => setTransitionIn(!transitionIn)}>\n *         Toggle\n *       </Button>\n *       {rendered && (\n *         <Typography {...elementProps}>\n *           Some Opacity Changing Text\n *         </Typography>\n *       )}\n *     </>\n *   );\n * }\n * ```\n *\n * @example\n * Mount Transition\n * ```tsx\n * import type { ReactElement } from \"react\";\n * import { useCSSTransition } from \"@react-md/transition\";\n *\n * // Pretend styles\n * // .opacity {\n * //   opacity: 0;\n * //   transition: opacity .3s;\n * // }\n * //\n * // .opacity--active {\n * //   opacity: 1;\n * // }\n * //\n *\n * function Example(): ReactElement {\n *   const { elementProps } = useCSSTransition({\n *     appear: true,\n *     transitionIn: true,\n *     timeout: 300,\n *     classNames: \"opacity\",\n *   })\n *\n *   return <div {...elementProps}>Some Content!</div>;\n * }\n * ```\n *\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport function useCSSTransition<E extends HTMLElement>(\n  options: CSSTransitionHookOptions<E>\n): CSSTransitionHookReturnValue<E> {\n  const {\n    className,\n    classNames,\n    appear = false,\n    enter = true,\n    exit = true,\n    timeout,\n    temporary = false,\n    exitedHidden = false,\n    ...transitionOptions\n  } = options;\n\n  const { ref, stage, rendered, appearing, transitionTo, disablePortal } =\n    useTransition({\n      ...transitionOptions,\n      appear,\n      enter,\n      exit,\n      timeout,\n      reflow: true,\n      temporary,\n    });\n  const isEntering = stage === \"entering\";\n  const isEnter = isEntering || stage === \"enter\";\n  const isEntered = stage === \"entered\";\n  const isExiting = stage === \"exiting\";\n  const isExit = isExiting || stage === \"exit\";\n  const isExited = stage === \"exited\";\n  const transitionClassNames = getTransitionClassNames({\n    timeout,\n    appear,\n    enter,\n    exit,\n    classNames,\n  });\n\n  const elementProps: CSSTransitionElementProps<E> = {\n    ref,\n    className:\n      cnb(\n        // always apply the provided className first since it makes snapshot\n        // tests easier to parse if dynamic classes come afterwards\n        className,\n        !temporary && exitedHidden && stage === \"exited\" && DISPLAY_NONE_CLASS,\n        appearing && isEnter && transitionClassNames.appear,\n        appearing && isEntering && transitionClassNames.appearActive,\n        appearing && isEntered && transitionClassNames.appearDone,\n        !appearing && isEnter && transitionClassNames.enter,\n        !appearing && isEntering && transitionClassNames.enterActive,\n        !appearing && isEntered && transitionClassNames.enterDone,\n        isExit && transitionClassNames.exit,\n        isExiting && transitionClassNames.exitActive,\n        isExited && transitionClassNames.exitDone\n      ) || undefined,\n  };\n\n  return {\n    ...elementProps,\n    stage,\n    rendered,\n    appearing,\n    elementProps,\n    transitionTo,\n    disablePortal,\n  };\n}\n"],"names":["cnb","DISPLAY_NONE_CLASS","useTransition","getTransitionClassNames","useCSSTransition","options","className","classNames","appear","enter","exit","timeout","temporary","exitedHidden","transitionOptions","ref","stage","rendered","appearing","transitionTo","disablePortal","reflow","isEntering","isEnter","isEntered","isExiting","isExit","isExited","transitionClassNames","elementProps","appearActive","appearDone","enterActive","enterDone","exitActive","exitDone","undefined"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,kBAAkB,QAAQ,+BAA+B;AAQlE,SAASC,aAAa,QAAQ,qBAAqB;AACnD,SAASC,uBAAuB,QAAQ,aAAa;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgJC,GACD,OAAO,SAASC,iBACdC,OAAoC;IAEpC,MAAM,EACJC,SAAS,EACTC,UAAU,EACVC,SAAS,KAAK,EACdC,QAAQ,IAAI,EACZC,OAAO,IAAI,EACXC,OAAO,EACPC,YAAY,KAAK,EACjBC,eAAe,KAAK,EACpB,GAAGC,mBACJ,GAAGT;IAEJ,MAAM,EAAEU,GAAG,EAAEC,KAAK,EAAEC,QAAQ,EAAEC,SAAS,EAAEC,YAAY,EAAEC,aAAa,EAAE,GACpElB,cAAc;QACZ,GAAGY,iBAAiB;QACpBN;QACAC;QACAC;QACAC;QACAU,QAAQ;QACRT;IACF;IACF,MAAMU,aAAaN,UAAU;IAC7B,MAAMO,UAAUD,cAAcN,UAAU;IACxC,MAAMQ,YAAYR,UAAU;IAC5B,MAAMS,YAAYT,UAAU;IAC5B,MAAMU,SAASD,aAAaT,UAAU;IACtC,MAAMW,WAAWX,UAAU;IAC3B,MAAMY,uBAAuBzB,wBAAwB;QACnDQ;QACAH;QACAC;QACAC;QACAH;IACF;IAEA,MAAMsB,eAA6C;QACjDd;QACAT,WACEN,IACE,oEAAoE;QACpE,2DAA2D;QAC3DM,WACA,CAACM,aAAaC,gBAAgBG,UAAU,YAAYf,oBACpDiB,aAAaK,WAAWK,qBAAqBpB,MAAM,EACnDU,aAAaI,cAAcM,qBAAqBE,YAAY,EAC5DZ,aAAaM,aAAaI,qBAAqBG,UAAU,EACzD,CAACb,aAAaK,WAAWK,qBAAqBnB,KAAK,EACnD,CAACS,aAAaI,cAAcM,qBAAqBI,WAAW,EAC5D,CAACd,aAAaM,aAAaI,qBAAqBK,SAAS,EACzDP,UAAUE,qBAAqBlB,IAAI,EACnCe,aAAaG,qBAAqBM,UAAU,EAC5CP,YAAYC,qBAAqBO,QAAQ,KACtCC;IACT;IAEA,OAAO;QACL,GAAGP,YAAY;QACfb;QACAC;QACAC;QACAW;QACAV;QACAC;IACF;AACF"}
+{"version":3,"sources":["../../src/transition/useCSSTransition.ts"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport { DISPLAY_NONE_CLASS } from \"../utils/isElementVisible.js\";\nimport type {\n  CSSTransitionElementProps,\n  CSSTransitionHookOptions,\n  CSSTransitionHookReturnValue,\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  TransitionHookOptions,\n} from \"./types.js\";\nimport { useTransition } from \"./useTransition.js\";\nimport { getTransitionClassNames } from \"./utils.js\";\n\n/**\n * This hook is used to create CSS transitions for different components whenever\n * a {@link TransitionHookOptions.transitionIn} flag is changed.\n *\n * @example Simple Transition\n * ```tsx\n * import { ReactElement, useState } from \"react\";\n * import { Button, Typography, useCSSTransition } from \"@react-md/core\";\n *\n * // Pretend styles\n * // .enter {\n * //   opacity: 0.5;\n * //   transition: opacity .15s;\n * // }\n * //\n * // .enter--active {\n * //   opacity: 1;\n * // }\n * //\n * // .exit {\n * //   opacity: 1;\n * //   transition: opacity .15s;\n * // }\n * //\n * // .exit--active {\n * //   opacity: 0.5;\n * // }\n *\n * function Example(): ReactElement {\n *   const [transitionIn, setTransitionIn] = useState(false);\n *   const { elementProps } = useCSSTransition({\n *     timeout: 150,\n *     classNames: {\n *       enter: \"enter\",\n *       enterActive: \"enter--active\",\n *       exit: \"exit\",\n *       exitActive: \"exit--active\",\n *     },\n *     transitionIn,\n *   });\n *\n *   return (\n *     <>\n *       <Button onClick={() => setTransitionIn(!transitionIn)}>\n *         Toggle\n *       </Button>\n *       <Typography {...elementProps}>\n *         Some Opacity Changing Text\n *       </Typography>\n *     </>\n *   );\n * }\n * ```\n *\n * @example Visibility Transition\n * ```tsx\n * import { ReactElement, useState } from \"react\";\n * import { Button, Typography, useCSSTransition } from \"@react-md/core\";\n *\n * // Pretend styles\n * // .enter {\n * //   opacity: 0;\n * //   transition: opacity .2s;\n * // }\n * //\n * // .enter--active {\n * //   opacity: 1;\n * // }\n * //\n * // .exit {\n * //   opacity: 1;\n * //   transition: opacity .15s;\n * // }\n * //\n * // .exit--active {\n * //   opacity: 0;\n * // }\n *\n * function Example(): ReactElement {\n *   const [transitionIn, setTransitionIn] = useState(false);\n *   const { elementProps, rendered } = useCSSTransition({\n *     timeout: {\n *       enter: 200,\n *       exit: 150,\n *     },\n *     classNames: {\n *       enter: \"enter\",\n *       enterActive: \"enter--active\",\n *       exit: \"exit\",\n *       exitActive: \"exit--active\",\n *     },\n *     transitionIn,\n *     temporary: true,\n *   });\n *\n *   return (\n *     <>\n *       <Button onClick={() => setTransitionIn(!transitionIn)}>\n *         Toggle\n *       </Button>\n *       {rendered && (\n *         <Typography {...elementProps}>\n *           Some Opacity Changing Text\n *         </Typography>\n *       )}\n *     </>\n *   );\n * }\n * ```\n *\n * @example Mount Transition\n * ```tsx\n * import type { ReactElement } from \"react\";\n * import { useCSSTransition } from \"@react-md/transition\";\n *\n * // Pretend styles\n * // .opacity {\n * //   opacity: 0;\n * //   transition: opacity .3s;\n * // }\n * //\n * // .opacity--active {\n * //   opacity: 1;\n * // }\n * //\n *\n * function Example(): ReactElement {\n *   const { elementProps } = useCSSTransition({\n *     appear: true,\n *     transitionIn: true,\n *     timeout: 300,\n *     classNames: \"opacity\",\n *   })\n *\n *   return <div {...elementProps}>Some Content!</div>;\n * }\n * ```\n *\n * @typeParam E - An HTMLElement type used for the ref required for the\n * transition.\n * @since 4.0.0\n */\nexport function useCSSTransition<E extends HTMLElement>(\n  options: CSSTransitionHookOptions<E>\n): CSSTransitionHookReturnValue<E> {\n  const {\n    className,\n    classNames,\n    appear = false,\n    enter = true,\n    exit = true,\n    timeout,\n    temporary = false,\n    exitedHidden = false,\n    ...transitionOptions\n  } = options;\n\n  const { ref, stage, rendered, appearing, transitionTo, disablePortal } =\n    useTransition({\n      ...transitionOptions,\n      appear,\n      enter,\n      exit,\n      timeout,\n      reflow: true,\n      temporary,\n    });\n  const isEntering = stage === \"entering\";\n  const isEnter = isEntering || stage === \"enter\";\n  const isEntered = stage === \"entered\";\n  const isExiting = stage === \"exiting\";\n  const isExit = isExiting || stage === \"exit\";\n  const isExited = stage === \"exited\";\n  const transitionClassNames = getTransitionClassNames({\n    timeout,\n    appear,\n    enter,\n    exit,\n    classNames,\n  });\n\n  const elementProps: CSSTransitionElementProps<E> = {\n    ref,\n    className:\n      cnb(\n        // always apply the provided className first since it makes snapshot\n        // tests easier to parse if dynamic classes come afterwards\n        className,\n        !temporary && exitedHidden && stage === \"exited\" && DISPLAY_NONE_CLASS,\n        appearing && isEnter && transitionClassNames.appear,\n        appearing && isEntering && transitionClassNames.appearActive,\n        appearing && isEntered && transitionClassNames.appearDone,\n        !appearing && isEnter && transitionClassNames.enter,\n        !appearing && isEntering && transitionClassNames.enterActive,\n        !appearing && isEntered && transitionClassNames.enterDone,\n        isExit && transitionClassNames.exit,\n        isExiting && transitionClassNames.exitActive,\n        isExited && transitionClassNames.exitDone\n      ) || undefined,\n  };\n\n  return {\n    ...elementProps,\n    stage,\n    rendered,\n    appearing,\n    elementProps,\n    transitionTo,\n    disablePortal,\n  };\n}\n"],"names":["cnb","DISPLAY_NONE_CLASS","useTransition","getTransitionClassNames","useCSSTransition","options","className","classNames","appear","enter","exit","timeout","temporary","exitedHidden","transitionOptions","ref","stage","rendered","appearing","transitionTo","disablePortal","reflow","isEntering","isEnter","isEntered","isExiting","isExit","isExited","transitionClassNames","elementProps","appearActive","appearDone","enterActive","enterDone","exitActive","exitDone","undefined"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,kBAAkB,QAAQ,+BAA+B;AAQlE,SAASC,aAAa,QAAQ,qBAAqB;AACnD,SAASC,uBAAuB,QAAQ,aAAa;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6IC,GACD,OAAO,SAASC,iBACdC,OAAoC;IAEpC,MAAM,EACJC,SAAS,EACTC,UAAU,EACVC,SAAS,KAAK,EACdC,QAAQ,IAAI,EACZC,OAAO,IAAI,EACXC,OAAO,EACPC,YAAY,KAAK,EACjBC,eAAe,KAAK,EACpB,GAAGC,mBACJ,GAAGT;IAEJ,MAAM,EAAEU,GAAG,EAAEC,KAAK,EAAEC,QAAQ,EAAEC,SAAS,EAAEC,YAAY,EAAEC,aAAa,EAAE,GACpElB,cAAc;QACZ,GAAGY,iBAAiB;QACpBN;QACAC;QACAC;QACAC;QACAU,QAAQ;QACRT;IACF;IACF,MAAMU,aAAaN,UAAU;IAC7B,MAAMO,UAAUD,cAAcN,UAAU;IACxC,MAAMQ,YAAYR,UAAU;IAC5B,MAAMS,YAAYT,UAAU;IAC5B,MAAMU,SAASD,aAAaT,UAAU;IACtC,MAAMW,WAAWX,UAAU;IAC3B,MAAMY,uBAAuBzB,wBAAwB;QACnDQ;QACAH;QACAC;QACAC;QACAH;IACF;IAEA,MAAMsB,eAA6C;QACjDd;QACAT,WACEN,IACE,oEAAoE;QACpE,2DAA2D;QAC3DM,WACA,CAACM,aAAaC,gBAAgBG,UAAU,YAAYf,oBACpDiB,aAAaK,WAAWK,qBAAqBpB,MAAM,EACnDU,aAAaI,cAAcM,qBAAqBE,YAAY,EAC5DZ,aAAaM,aAAaI,qBAAqBG,UAAU,EACzD,CAACb,aAAaK,WAAWK,qBAAqBnB,KAAK,EACnD,CAACS,aAAaI,cAAcM,qBAAqBI,WAAW,EAC5D,CAACd,aAAaM,aAAaI,qBAAqBK,SAAS,EACzDP,UAAUE,qBAAqBlB,IAAI,EACnCe,aAAaG,qBAAqBM,UAAU,EAC5CP,YAAYC,qBAAqBO,QAAQ,KACtCC;IACT;IAEA,OAAO;QACL,GAAGP,YAAY;QACfb;QACAC;QACAC;QACAW;QACAV;QACAC;IACF;AACF"}

package/dist/transition/useCarousel.d.ts

@@ -1,15 +1,15 @@
 import type { UseStateSetter } from "../types.js";
 import type { SlideDirection } from "./SlideContainer.js";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CarouselSlideState {
     direction: SlideDirection;
     activeIndex: number;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CarouselState extends CarouselSlideState {
     paused: boolean;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CarouselImplementation extends CarouselState {
     /**
      * Increments the carousel slide active index by 1 ensuring it does not
@@ -42,7 +42,7 @@ export interface CarouselImplementation extends CarouselState {
     setCarouselSlideState: UseStateSetter<CarouselSlideState>;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface CarouselOptions {
     /**
@@ -59,8 +59,7 @@ export interface CarouselOptions {
     totalSlides: number;
 }
 /**
- * @example
- * Accessible Carousel Example
+ * @example Accessible Carousel Example
  * ```tsx
  * import { Button, SlideContainer, Slide, useCarousel } from "@react-md/core";
  * import ChevronLeftIcon from "@react-md/material-icons/ChevronLeftIcon";
@@ -151,7 +150,7 @@ export interface CarouselOptions {
  * }
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @see {@link https://www.w3.org/WAI/ARIA/apg/patterns/carousel/}
  * @see {@link https://www.w3.org/WAI/ARIA/apg/example-index/carousel/carousel-2-tablist.html}
  */