@react-md/core 1.0.0-next.2 → 1.0.0-next.21

package/dist/transition/useTransition.js

@@ -1,10 +1,10 @@
 "use client";
-import { useEffect, useReducer, useRef, useState } from "react";
+import { useReducer, useRef, useState } from "react";
 import { useSsr } from "../SsrProvider.js";
 import { useEnsuredRef } from "../useEnsuredRef.js";
 import { useIsomorphicLayoutEffect } from "../useIsomorphicLayoutEffect.js";
-import { getTransitionTimeout } from "./utils.js";
 import { TRANSITION_CONFIG } from "./config.js";
+import { getTransitionTimeout } from "./utils.js";
 const INITIAL_STATE = {
     appearing: false,
     rendered: true,
@@ -18,9 +18,11 @@ const noop = ()=>{
  * since this is just a low-level hook that can be used to transition using
  * timeouts.
  *
+ * @see {@link https://next.react-md.dev/hooks/use-transition | useTransition Demos}
  * @typeParam E - The HTMLElement type used or the ref required for the
  * transition.
- * @remarks \@since 4.0.0
+ * @since 4.0.0
+ * @since 6.0.0 Added the `disablePortal` flag to the return value for SSR.
  */ export function useTransition(options) {
     const { nodeRef, timeout, transitionIn, reflow = false, temporary = false, appear = false, enter = true, exit = true, onEnter = noop, onEntering = noop, onEntered = noop, onExit = noop, onExiting = noop, onExited = noop, disablePortal: propDisablePortal } = options;
     const configurationRef = useRef({
@@ -131,7 +133,7 @@ const noop = ()=>{
     const isFirstRender = useRef(true);
     const isRehydrateAppear = useRef(ssr && !transitionIn);
     const defaultTransitionIn = useRef(transitionIn);
-    useEffect(()=>{
+    useIsomorphicLayoutEffect(()=>{
         const { timeout, reflow, onEnter, onEntering, onEntered, onExit, onExiting } = configurationRef.current;
         let { onExited } = configurationRef.current;
         if (isFirstRender.current) {
@@ -160,6 +162,7 @@ const noop = ()=>{
         }
         if (reflow && ref.current && stage !== "exited" && stage !== "entered") {
             // force reflow by accessing scrollTop
+            // eslint-disable-next-line @typescript-eslint/no-unused-expressions
             ref.current.scrollTop;
         }
         let duration = 0;

package/dist/transition/useTransition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/useTransition.ts"],"sourcesContent":["\"use client\";\nimport { useEffect, useReducer, useRef, useState } from \"react\";\nimport { useSsr } from \"../SsrProvider.js\";\nimport { useEnsuredRef } from \"../useEnsuredRef.js\";\nimport { useIsomorphicLayoutEffect } from \"../useIsomorphicLayoutEffect.js\";\nimport type {\n  TransitionHookOptions,\n  TransitionHookReturnValue,\n  TransitionStage,\n  TransitionState,\n} from \"./types.js\";\nimport { getTransitionTimeout } from \"./utils.js\";\nimport { TRANSITION_CONFIG } from \"./config.js\";\n\nconst INITIAL_STATE: TransitionState = {\n  appearing: false,\n  rendered: true,\n  stage: \"exited\",\n};\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * You'll most likely want to use the {@link useCSSTransition} hook instead\n * since this is just a low-level hook that can be used to transition using\n * timeouts.\n *\n * @typeParam E - The HTMLElement type used or the ref required for the\n * transition.\n * @remarks \\@since 4.0.0\n */\nexport function useTransition<E extends HTMLElement>(\n  options: TransitionHookOptions<E>\n): TransitionHookReturnValue<E> {\n  const {\n    nodeRef,\n    timeout,\n    transitionIn,\n    reflow = false,\n    temporary = false,\n    appear = false,\n    enter = true,\n    exit = true,\n    onEnter = noop,\n    onEntering = noop,\n    onEntered = noop,\n    onExit = noop,\n    onExiting = noop,\n    onExited = noop,\n    disablePortal: propDisablePortal,\n  } = options;\n\n  const configurationRef = useRef({\n    timeout: getTransitionTimeout({ timeout, appear, enter, exit }),\n    reflow,\n    onEnter,\n    onEntering,\n    onEntered,\n    onExit,\n    onExiting,\n    onExited,\n  } as const);\n  useIsomorphicLayoutEffect(() => {\n    configurationRef.current = {\n      timeout: getTransitionTimeout({ timeout, appear, enter, exit }),\n      reflow,\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n      onExited,\n    };\n  }, [\n    appear,\n    enter,\n    exit,\n    onEnter,\n    onEntered,\n    onEntering,\n    onExit,\n    onExited,\n    onExiting,\n    reflow,\n    timeout,\n  ]);\n\n  const ssr = useSsr();\n  const [ref, refCallback] = useEnsuredRef<E>(nodeRef);\n  const [disablePortal, setDisablePortal] = useState(ssr);\n  const [state, dispatch] = useReducer(\n    function reducer(\n      state: TransitionState,\n      action: TransitionStage | \"unmount\"\n    ): TransitionState {\n      const { appear, enter, exit } = configurationRef.current.timeout;\n      const { appearing } = state;\n      switch (action) {\n        case \"enter\": {\n          const duration = appearing ? appear : enter;\n          return {\n            stage: duration > 0 ? \"enter\" : \"entered\",\n            rendered: true,\n            appearing,\n          };\n        }\n        case \"entering\":\n        case \"entered\":\n          return {\n            stage: action,\n            rendered: true,\n            appearing,\n          };\n        case \"exit\": {\n          const stage = exit > 0 ? \"exit\" : \"exited\";\n          return {\n            stage,\n            rendered: !temporary || stage !== \"exited\",\n            appearing: false,\n          };\n        }\n        case \"exiting\":\n        case \"exited\":\n          return {\n            stage: action,\n            rendered: true,\n            appearing: false,\n          };\n        case \"unmount\":\n          if (state.stage === \"exited\" && !state.appearing && !state.rendered) {\n            return state;\n          }\n\n          return {\n            stage: \"exited\",\n            rendered: false,\n            appearing: false,\n          };\n      }\n    },\n    INITIAL_STATE,\n    () => {\n      let stage: TransitionStage = \"exited\";\n      if (transitionIn) {\n        stage = appear && !TRANSITION_CONFIG.disabled ? \"enter\" : \"entered\";\n      }\n\n      return {\n        appearing: appear && transitionIn && !TRANSITION_CONFIG.disabled,\n        rendered: !temporary || transitionIn,\n        stage,\n      };\n    }\n  );\n  const { appearing, rendered, stage } = state;\n\n  const isFirstRender = useRef(true);\n  const isRehydrateAppear = useRef(ssr && !transitionIn);\n  const defaultTransitionIn = useRef(transitionIn);\n  useEffect(() => {\n    const {\n      timeout,\n      reflow,\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n    } = configurationRef.current;\n    let { onExited } = configurationRef.current;\n    if (isFirstRender.current) {\n      // The exited hook should **not** fire on first render since the element\n      // was never in the DOM.\n      isFirstRender.current = false;\n      onExited = noop;\n    }\n\n    // if the transitionIn did not change between initial render and rehydration,\n    // allow the enter transition to behave like normal.\n    if (\n      isRehydrateAppear.current &&\n      !ssr &&\n      !transitionIn &&\n      !defaultTransitionIn.current\n    ) {\n      isRehydrateAppear.current = false;\n    }\n\n    // Cancel any exiting/exited transitions and instead immediately start the\n    // enter transition\n    if (transitionIn && stage.startsWith(\"exit\")) {\n      const nextStage = isRehydrateAppear.current ? \"entered\" : \"enter\";\n      dispatch(nextStage);\n      return;\n    }\n\n    // Cancel any entering/entered transitions and instead immediately start the\n    // exit transition\n    if (!transitionIn && stage.startsWith(\"enter\")) {\n      dispatch(\"exit\");\n      return;\n    }\n\n    if (reflow && ref.current && stage !== \"exited\" && stage !== \"entered\") {\n      // force reflow by accessing scrollTop\n      ref.current.scrollTop;\n    }\n\n    let duration = 0;\n    let nextStage: TransitionStage = stage;\n    switch (stage) {\n      case \"enter\":\n        if (TRANSITION_CONFIG.disabled) {\n          nextStage = \"entered\";\n        } else {\n          onEnter(appearing);\n          nextStage = \"entering\";\n        }\n        break;\n      case \"entering\":\n        onEntering(appearing);\n        duration = timeout.enter;\n        nextStage = \"entered\";\n        break;\n      case \"entered\":\n        onEntered(appearing);\n        break;\n      case \"exit\":\n        if (TRANSITION_CONFIG.disabled) {\n          nextStage = \"exited\";\n        } else {\n          onExit();\n          nextStage = \"exiting\";\n        }\n        break;\n      case \"exiting\":\n        onExiting();\n        duration = timeout.exit;\n        nextStage = \"exited\";\n        break;\n      case \"exited\":\n        onExited();\n        setDisablePortal(false);\n        break;\n    }\n\n    if (stage === nextStage) {\n      // this is used to help catch changing the temporary prop.\n      // not sure if I should really support that though...\n      if (stage === \"exited\" && temporary) {\n        dispatch(\"unmount\");\n      }\n\n      return;\n    }\n\n    // I used to rely on the `dispatch(\"unmount\")` above, but it seems like\n    // there are some cases where re-rendering takes too long so the temporary\n    // element flashes\n    const dispatchStage =\n      temporary && nextStage === \"exited\" ? \"unmount\" : nextStage;\n    if (duration <= 0) {\n      dispatch(dispatchStage);\n      return;\n    }\n\n    const timer = window.setTimeout(() => {\n      dispatch(dispatchStage);\n    }, duration);\n\n    return () => {\n      window.clearTimeout(timer);\n    };\n  }, [appearing, ref, ssr, stage, temporary, transitionIn]);\n\n  return {\n    ref: refCallback,\n    stage,\n    rendered,\n    appearing,\n    transitionTo: dispatch,\n    disablePortal: propDisablePortal || disablePortal,\n  };\n}\n"],"names":["useEffect","useReducer","useRef","useState","useSsr","useEnsuredRef","useIsomorphicLayoutEffect","getTransitionTimeout","TRANSITION_CONFIG","INITIAL_STATE","appearing","rendered","stage","noop","useTransition","options","nodeRef","timeout","transitionIn","reflow","temporary","appear","enter","exit","onEnter","onEntering","onEntered","onExit","onExiting","onExited","disablePortal","propDisablePortal","configurationRef","current","ssr","ref","refCallback","setDisablePortal","state","dispatch","reducer","action","duration","disabled","isFirstRender","isRehydrateAppear","defaultTransitionIn","startsWith","nextStage","scrollTop","dispatchStage","timer","window","setTimeout","clearTimeout","transitionTo"],"mappings":"AAAA;AACA,SAASA,SAAS,EAAEC,UAAU,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AAChE,SAASC,MAAM,QAAQ,oBAAoB;AAC3C,SAASC,aAAa,QAAQ,sBAAsB;AACpD,SAASC,yBAAyB,QAAQ,kCAAkC;AAO5E,SAASC,oBAAoB,QAAQ,aAAa;AAClD,SAASC,iBAAiB,QAAQ,cAAc;AAEhD,MAAMC,gBAAiC;IACrCC,WAAW;IACXC,UAAU;IACVC,OAAO;AACT;AAEA,MAAMC,OAAO;AACX,aAAa;AACf;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC,cACdC,OAAiC;IAEjC,MAAM,EACJC,OAAO,EACPC,OAAO,EACPC,YAAY,EACZC,SAAS,KAAK,EACdC,YAAY,KAAK,EACjBC,SAAS,KAAK,EACdC,QAAQ,IAAI,EACZC,OAAO,IAAI,EACXC,UAAUX,IAAI,EACdY,aAAaZ,IAAI,EACjBa,YAAYb,IAAI,EAChBc,SAASd,IAAI,EACbe,YAAYf,IAAI,EAChBgB,WAAWhB,IAAI,EACfiB,eAAeC,iBAAiB,EACjC,GAAGhB;IAEJ,MAAMiB,mBAAmB9B,OAAO;QAC9Be,SAASV,qBAAqB;YAAEU;YAASI;YAAQC;YAAOC;QAAK;QAC7DJ;QACAK;QACAC;QACAC;QACAC;QACAC;QACAC;IACF;IACAvB,0BAA0B;QACxB0B,iBAAiBC,OAAO,GAAG;YACzBhB,SAASV,qBAAqB;gBAAEU;gBAASI;gBAAQC;gBAAOC;YAAK;YAC7DJ;YACAK;YACAC;YACAC;YACAC;YACAC;YACAC;QACF;IACF,GAAG;QACDR;QACAC;QACAC;QACAC;QACAE;QACAD;QACAE;QACAE;QACAD;QACAT;QACAF;KACD;IAED,MAAMiB,MAAM9B;IACZ,MAAM,CAAC+B,KAAKC,YAAY,GAAG/B,cAAiBW;IAC5C,MAAM,CAACc,eAAeO,iBAAiB,GAAGlC,SAAS+B;IACnD,MAAM,CAACI,OAAOC,SAAS,GAAGtC,WACxB,SAASuC,QACPF,KAAsB,EACtBG,MAAmC;QAEnC,MAAM,EAAEpB,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAE,GAAGS,iBAAiBC,OAAO,CAAChB,OAAO;QAChE,MAAM,EAAEP,SAAS,EAAE,GAAG4B;QACtB,OAAQG;YACN,KAAK;gBAAS;oBACZ,MAAMC,WAAWhC,YAAYW,SAASC;oBACtC,OAAO;wBACLV,OAAO8B,WAAW,IAAI,UAAU;wBAChC/B,UAAU;wBACVD;oBACF;gBACF;YACA,KAAK;YACL,KAAK;gBACH,OAAO;oBACLE,OAAO6B;oBACP9B,UAAU;oBACVD;gBACF;YACF,KAAK;gBAAQ;oBACX,MAAME,QAAQW,OAAO,IAAI,SAAS;oBAClC,OAAO;wBACLX;wBACAD,UAAU,CAACS,aAAaR,UAAU;wBAClCF,WAAW;oBACb;gBACF;YACA,KAAK;YACL,KAAK;gBACH,OAAO;oBACLE,OAAO6B;oBACP9B,UAAU;oBACVD,WAAW;gBACb;YACF,KAAK;gBACH,IAAI4B,MAAM1B,KAAK,KAAK,YAAY,CAAC0B,MAAM5B,SAAS,IAAI,CAAC4B,MAAM3B,QAAQ,EAAE;oBACnE,OAAO2B;gBACT;gBAEA,OAAO;oBACL1B,OAAO;oBACPD,UAAU;oBACVD,WAAW;gBACb;QACJ;IACF,GACAD,eACA;QACE,IAAIG,QAAyB;QAC7B,IAAIM,cAAc;YAChBN,QAAQS,UAAU,CAACb,kBAAkBmC,QAAQ,GAAG,UAAU;QAC5D;QAEA,OAAO;YACLjC,WAAWW,UAAUH,gBAAgB,CAACV,kBAAkBmC,QAAQ;YAChEhC,UAAU,CAACS,aAAaF;YACxBN;QACF;IACF;IAEF,MAAM,EAAEF,SAAS,EAAEC,QAAQ,EAAEC,KAAK,EAAE,GAAG0B;IAEvC,MAAMM,gBAAgB1C,OAAO;IAC7B,MAAM2C,oBAAoB3C,OAAOgC,OAAO,CAAChB;IACzC,MAAM4B,sBAAsB5C,OAAOgB;IACnClB,UAAU;QACR,MAAM,EACJiB,OAAO,EACPE,MAAM,EACNK,OAAO,EACPC,UAAU,EACVC,SAAS,EACTC,MAAM,EACNC,SAAS,EACV,GAAGI,iBAAiBC,OAAO;QAC5B,IAAI,EAAEJ,QAAQ,EAAE,GAAGG,iBAAiBC,OAAO;QAC3C,IAAIW,cAAcX,OAAO,EAAE;YACzB,wEAAwE;YACxE,wBAAwB;YACxBW,cAAcX,OAAO,GAAG;YACxBJ,WAAWhB;QACb;QAEA,6EAA6E;QAC7E,oDAAoD;QACpD,IACEgC,kBAAkBZ,OAAO,IACzB,CAACC,OACD,CAAChB,gBACD,CAAC4B,oBAAoBb,OAAO,EAC5B;YACAY,kBAAkBZ,OAAO,GAAG;QAC9B;QAEA,0EAA0E;QAC1E,mBAAmB;QACnB,IAAIf,gBAAgBN,MAAMmC,UAAU,CAAC,SAAS;YAC5C,MAAMC,YAAYH,kBAAkBZ,OAAO,GAAG,YAAY;YAC1DM,SAASS;YACT;QACF;QAEA,4EAA4E;QAC5E,kBAAkB;QAClB,IAAI,CAAC9B,gBAAgBN,MAAMmC,UAAU,CAAC,UAAU;YAC9CR,SAAS;YACT;QACF;QAEA,IAAIpB,UAAUgB,IAAIF,OAAO,IAAIrB,UAAU,YAAYA,UAAU,WAAW;YACtE,sCAAsC;YACtCuB,IAAIF,OAAO,CAACgB,SAAS;QACvB;QAEA,IAAIP,WAAW;QACf,IAAIM,YAA6BpC;QACjC,OAAQA;YACN,KAAK;gBACH,IAAIJ,kBAAkBmC,QAAQ,EAAE;oBAC9BK,YAAY;gBACd,OAAO;oBACLxB,QAAQd;oBACRsC,YAAY;gBACd;gBACA;YACF,KAAK;gBACHvB,WAAWf;gBACXgC,WAAWzB,QAAQK,KAAK;gBACxB0B,YAAY;gBACZ;YACF,KAAK;gBACHtB,UAAUhB;gBACV;YACF,KAAK;gBACH,IAAIF,kBAAkBmC,QAAQ,EAAE;oBAC9BK,YAAY;gBACd,OAAO;oBACLrB;oBACAqB,YAAY;gBACd;gBACA;YACF,KAAK;gBACHpB;gBACAc,WAAWzB,QAAQM,IAAI;gBACvByB,YAAY;gBACZ;YACF,KAAK;gBACHnB;gBACAQ,iBAAiB;gBACjB;QACJ;QAEA,IAAIzB,UAAUoC,WAAW;YACvB,0DAA0D;YAC1D,qDAAqD;YACrD,IAAIpC,UAAU,YAAYQ,WAAW;gBACnCmB,SAAS;YACX;YAEA;QACF;QAEA,uEAAuE;QACvE,0EAA0E;QAC1E,kBAAkB;QAClB,MAAMW,gBACJ9B,aAAa4B,cAAc,WAAW,YAAYA;QACpD,IAAIN,YAAY,GAAG;YACjBH,SAASW;YACT;QACF;QAEA,MAAMC,QAAQC,OAAOC,UAAU,CAAC;YAC9Bd,SAASW;QACX,GAAGR;QAEH,OAAO;YACLU,OAAOE,YAAY,CAACH;QACtB;IACF,GAAG;QAACzC;QAAWyB;QAAKD;QAAKtB;QAAOQ;QAAWF;KAAa;IAExD,OAAO;QACLiB,KAAKC;QACLxB;QACAD;QACAD;QACA6C,cAAchB;QACdT,eAAeC,qBAAqBD;IACtC;AACF"}
+{"version":3,"sources":["../../src/transition/useTransition.ts"],"sourcesContent":["\"use client\";\n\nimport { useReducer, useRef, useState } from \"react\";\n\nimport { useSsr } from \"../SsrProvider.js\";\nimport { useEnsuredRef } from \"../useEnsuredRef.js\";\nimport { useIsomorphicLayoutEffect } from \"../useIsomorphicLayoutEffect.js\";\nimport { TRANSITION_CONFIG } from \"./config.js\";\nimport type {\n  TransitionHookOptions,\n  TransitionHookReturnValue,\n  TransitionStage,\n  TransitionState,\n} from \"./types.js\";\nimport { getTransitionTimeout } from \"./utils.js\";\n\nconst INITIAL_STATE: TransitionState = {\n  appearing: false,\n  rendered: true,\n  stage: \"exited\",\n};\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * You'll most likely want to use the {@link useCSSTransition} hook instead\n * since this is just a low-level hook that can be used to transition using\n * timeouts.\n *\n * @see {@link https://next.react-md.dev/hooks/use-transition | useTransition Demos}\n * @typeParam E - The HTMLElement type used or the ref required for the\n * transition.\n * @since 4.0.0\n * @since 6.0.0 Added the `disablePortal` flag to the return value for SSR.\n */\nexport function useTransition<E extends HTMLElement>(\n  options: TransitionHookOptions<E>\n): TransitionHookReturnValue<E> {\n  const {\n    nodeRef,\n    timeout,\n    transitionIn,\n    reflow = false,\n    temporary = false,\n    appear = false,\n    enter = true,\n    exit = true,\n    onEnter = noop,\n    onEntering = noop,\n    onEntered = noop,\n    onExit = noop,\n    onExiting = noop,\n    onExited = noop,\n    disablePortal: propDisablePortal,\n  } = options;\n\n  const configurationRef = useRef({\n    timeout: getTransitionTimeout({ timeout, appear, enter, exit }),\n    reflow,\n    onEnter,\n    onEntering,\n    onEntered,\n    onExit,\n    onExiting,\n    onExited,\n  } as const);\n  useIsomorphicLayoutEffect(() => {\n    configurationRef.current = {\n      timeout: getTransitionTimeout({ timeout, appear, enter, exit }),\n      reflow,\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n      onExited,\n    };\n  }, [\n    appear,\n    enter,\n    exit,\n    onEnter,\n    onEntered,\n    onEntering,\n    onExit,\n    onExited,\n    onExiting,\n    reflow,\n    timeout,\n  ]);\n\n  const ssr = useSsr();\n  const [ref, refCallback] = useEnsuredRef<E>(nodeRef);\n  const [disablePortal, setDisablePortal] = useState(ssr);\n  const [state, dispatch] = useReducer(\n    function reducer(\n      state: TransitionState,\n      action: TransitionStage | \"unmount\"\n    ): TransitionState {\n      const { appear, enter, exit } = configurationRef.current.timeout;\n      const { appearing } = state;\n      switch (action) {\n        case \"enter\": {\n          const duration = appearing ? appear : enter;\n          return {\n            stage: duration > 0 ? \"enter\" : \"entered\",\n            rendered: true,\n            appearing,\n          };\n        }\n        case \"entering\":\n        case \"entered\":\n          return {\n            stage: action,\n            rendered: true,\n            appearing,\n          };\n        case \"exit\": {\n          const stage = exit > 0 ? \"exit\" : \"exited\";\n          return {\n            stage,\n            rendered: !temporary || stage !== \"exited\",\n            appearing: false,\n          };\n        }\n        case \"exiting\":\n        case \"exited\":\n          return {\n            stage: action,\n            rendered: true,\n            appearing: false,\n          };\n        case \"unmount\":\n          if (state.stage === \"exited\" && !state.appearing && !state.rendered) {\n            return state;\n          }\n\n          return {\n            stage: \"exited\",\n            rendered: false,\n            appearing: false,\n          };\n      }\n    },\n    INITIAL_STATE,\n    () => {\n      let stage: TransitionStage = \"exited\";\n      if (transitionIn) {\n        stage = appear && !TRANSITION_CONFIG.disabled ? \"enter\" : \"entered\";\n      }\n\n      return {\n        appearing: appear && transitionIn && !TRANSITION_CONFIG.disabled,\n        rendered: !temporary || transitionIn,\n        stage,\n      };\n    }\n  );\n  const { appearing, rendered, stage } = state;\n\n  const isFirstRender = useRef(true);\n  const isRehydrateAppear = useRef(ssr && !transitionIn);\n  const defaultTransitionIn = useRef(transitionIn);\n  useIsomorphicLayoutEffect(() => {\n    const {\n      timeout,\n      reflow,\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n    } = configurationRef.current;\n    let { onExited } = configurationRef.current;\n    if (isFirstRender.current) {\n      // The exited hook should **not** fire on first render since the element\n      // was never in the DOM.\n      isFirstRender.current = false;\n      onExited = noop;\n    }\n\n    // if the transitionIn did not change between initial render and rehydration,\n    // allow the enter transition to behave like normal.\n    if (\n      isRehydrateAppear.current &&\n      !ssr &&\n      !transitionIn &&\n      !defaultTransitionIn.current\n    ) {\n      isRehydrateAppear.current = false;\n    }\n\n    // Cancel any exiting/exited transitions and instead immediately start the\n    // enter transition\n    if (transitionIn && stage.startsWith(\"exit\")) {\n      const nextStage = isRehydrateAppear.current ? \"entered\" : \"enter\";\n      dispatch(nextStage);\n      return;\n    }\n\n    // Cancel any entering/entered transitions and instead immediately start the\n    // exit transition\n    if (!transitionIn && stage.startsWith(\"enter\")) {\n      dispatch(\"exit\");\n      return;\n    }\n\n    if (reflow && ref.current && stage !== \"exited\" && stage !== \"entered\") {\n      // force reflow by accessing scrollTop\n      // eslint-disable-next-line @typescript-eslint/no-unused-expressions\n      ref.current.scrollTop;\n    }\n\n    let duration = 0;\n    let nextStage: TransitionStage = stage;\n    switch (stage) {\n      case \"enter\":\n        if (TRANSITION_CONFIG.disabled) {\n          nextStage = \"entered\";\n        } else {\n          onEnter(appearing);\n          nextStage = \"entering\";\n        }\n        break;\n      case \"entering\":\n        onEntering(appearing);\n        duration = timeout.enter;\n        nextStage = \"entered\";\n        break;\n      case \"entered\":\n        onEntered(appearing);\n        break;\n      case \"exit\":\n        if (TRANSITION_CONFIG.disabled) {\n          nextStage = \"exited\";\n        } else {\n          onExit();\n          nextStage = \"exiting\";\n        }\n        break;\n      case \"exiting\":\n        onExiting();\n        duration = timeout.exit;\n        nextStage = \"exited\";\n        break;\n      case \"exited\":\n        onExited();\n        setDisablePortal(false);\n        break;\n    }\n\n    if (stage === nextStage) {\n      // this is used to help catch changing the temporary prop.\n      // not sure if I should really support that though...\n      if (stage === \"exited\" && temporary) {\n        dispatch(\"unmount\");\n      }\n\n      return;\n    }\n\n    // I used to rely on the `dispatch(\"unmount\")` above, but it seems like\n    // there are some cases where re-rendering takes too long so the temporary\n    // element flashes\n    const dispatchStage =\n      temporary && nextStage === \"exited\" ? \"unmount\" : nextStage;\n    if (duration <= 0) {\n      dispatch(dispatchStage);\n      return;\n    }\n\n    const timer = window.setTimeout(() => {\n      dispatch(dispatchStage);\n    }, duration);\n\n    return () => {\n      window.clearTimeout(timer);\n    };\n  }, [appearing, ref, ssr, stage, temporary, transitionIn]);\n\n  return {\n    ref: refCallback,\n    stage,\n    rendered,\n    appearing,\n    transitionTo: dispatch,\n    disablePortal: propDisablePortal || disablePortal,\n  };\n}\n"],"names":["useReducer","useRef","useState","useSsr","useEnsuredRef","useIsomorphicLayoutEffect","TRANSITION_CONFIG","getTransitionTimeout","INITIAL_STATE","appearing","rendered","stage","noop","useTransition","options","nodeRef","timeout","transitionIn","reflow","temporary","appear","enter","exit","onEnter","onEntering","onEntered","onExit","onExiting","onExited","disablePortal","propDisablePortal","configurationRef","current","ssr","ref","refCallback","setDisablePortal","state","dispatch","reducer","action","duration","disabled","isFirstRender","isRehydrateAppear","defaultTransitionIn","startsWith","nextStage","scrollTop","dispatchStage","timer","window","setTimeout","clearTimeout","transitionTo"],"mappings":"AAAA;AAEA,SAASA,UAAU,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AAErD,SAASC,MAAM,QAAQ,oBAAoB;AAC3C,SAASC,aAAa,QAAQ,sBAAsB;AACpD,SAASC,yBAAyB,QAAQ,kCAAkC;AAC5E,SAASC,iBAAiB,QAAQ,cAAc;AAOhD,SAASC,oBAAoB,QAAQ,aAAa;AAElD,MAAMC,gBAAiC;IACrCC,WAAW;IACXC,UAAU;IACVC,OAAO;AACT;AAEA,MAAMC,OAAO;AACX,aAAa;AACf;AAEA;;;;;;;;;;CAUC,GACD,OAAO,SAASC,cACdC,OAAiC;IAEjC,MAAM,EACJC,OAAO,EACPC,OAAO,EACPC,YAAY,EACZC,SAAS,KAAK,EACdC,YAAY,KAAK,EACjBC,SAAS,KAAK,EACdC,QAAQ,IAAI,EACZC,OAAO,IAAI,EACXC,UAAUX,IAAI,EACdY,aAAaZ,IAAI,EACjBa,YAAYb,IAAI,EAChBc,SAASd,IAAI,EACbe,YAAYf,IAAI,EAChBgB,WAAWhB,IAAI,EACfiB,eAAeC,iBAAiB,EACjC,GAAGhB;IAEJ,MAAMiB,mBAAmB9B,OAAO;QAC9Be,SAAST,qBAAqB;YAAES;YAASI;YAAQC;YAAOC;QAAK;QAC7DJ;QACAK;QACAC;QACAC;QACAC;QACAC;QACAC;IACF;IACAvB,0BAA0B;QACxB0B,iBAAiBC,OAAO,GAAG;YACzBhB,SAAST,qBAAqB;gBAAES;gBAASI;gBAAQC;gBAAOC;YAAK;YAC7DJ;YACAK;YACAC;YACAC;YACAC;YACAC;YACAC;QACF;IACF,GAAG;QACDR;QACAC;QACAC;QACAC;QACAE;QACAD;QACAE;QACAE;QACAD;QACAT;QACAF;KACD;IAED,MAAMiB,MAAM9B;IACZ,MAAM,CAAC+B,KAAKC,YAAY,GAAG/B,cAAiBW;IAC5C,MAAM,CAACc,eAAeO,iBAAiB,GAAGlC,SAAS+B;IACnD,MAAM,CAACI,OAAOC,SAAS,GAAGtC,WACxB,SAASuC,QACPF,KAAsB,EACtBG,MAAmC;QAEnC,MAAM,EAAEpB,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAE,GAAGS,iBAAiBC,OAAO,CAAChB,OAAO;QAChE,MAAM,EAAEP,SAAS,EAAE,GAAG4B;QACtB,OAAQG;YACN,KAAK;gBAAS;oBACZ,MAAMC,WAAWhC,YAAYW,SAASC;oBACtC,OAAO;wBACLV,OAAO8B,WAAW,IAAI,UAAU;wBAChC/B,UAAU;wBACVD;oBACF;gBACF;YACA,KAAK;YACL,KAAK;gBACH,OAAO;oBACLE,OAAO6B;oBACP9B,UAAU;oBACVD;gBACF;YACF,KAAK;gBAAQ;oBACX,MAAME,QAAQW,OAAO,IAAI,SAAS;oBAClC,OAAO;wBACLX;wBACAD,UAAU,CAACS,aAAaR,UAAU;wBAClCF,WAAW;oBACb;gBACF;YACA,KAAK;YACL,KAAK;gBACH,OAAO;oBACLE,OAAO6B;oBACP9B,UAAU;oBACVD,WAAW;gBACb;YACF,KAAK;gBACH,IAAI4B,MAAM1B,KAAK,KAAK,YAAY,CAAC0B,MAAM5B,SAAS,IAAI,CAAC4B,MAAM3B,QAAQ,EAAE;oBACnE,OAAO2B;gBACT;gBAEA,OAAO;oBACL1B,OAAO;oBACPD,UAAU;oBACVD,WAAW;gBACb;QACJ;IACF,GACAD,eACA;QACE,IAAIG,QAAyB;QAC7B,IAAIM,cAAc;YAChBN,QAAQS,UAAU,CAACd,kBAAkBoC,QAAQ,GAAG,UAAU;QAC5D;QAEA,OAAO;YACLjC,WAAWW,UAAUH,gBAAgB,CAACX,kBAAkBoC,QAAQ;YAChEhC,UAAU,CAACS,aAAaF;YACxBN;QACF;IACF;IAEF,MAAM,EAAEF,SAAS,EAAEC,QAAQ,EAAEC,KAAK,EAAE,GAAG0B;IAEvC,MAAMM,gBAAgB1C,OAAO;IAC7B,MAAM2C,oBAAoB3C,OAAOgC,OAAO,CAAChB;IACzC,MAAM4B,sBAAsB5C,OAAOgB;IACnCZ,0BAA0B;QACxB,MAAM,EACJW,OAAO,EACPE,MAAM,EACNK,OAAO,EACPC,UAAU,EACVC,SAAS,EACTC,MAAM,EACNC,SAAS,EACV,GAAGI,iBAAiBC,OAAO;QAC5B,IAAI,EAAEJ,QAAQ,EAAE,GAAGG,iBAAiBC,OAAO;QAC3C,IAAIW,cAAcX,OAAO,EAAE;YACzB,wEAAwE;YACxE,wBAAwB;YACxBW,cAAcX,OAAO,GAAG;YACxBJ,WAAWhB;QACb;QAEA,6EAA6E;QAC7E,oDAAoD;QACpD,IACEgC,kBAAkBZ,OAAO,IACzB,CAACC,OACD,CAAChB,gBACD,CAAC4B,oBAAoBb,OAAO,EAC5B;YACAY,kBAAkBZ,OAAO,GAAG;QAC9B;QAEA,0EAA0E;QAC1E,mBAAmB;QACnB,IAAIf,gBAAgBN,MAAMmC,UAAU,CAAC,SAAS;YAC5C,MAAMC,YAAYH,kBAAkBZ,OAAO,GAAG,YAAY;YAC1DM,SAASS;YACT;QACF;QAEA,4EAA4E;QAC5E,kBAAkB;QAClB,IAAI,CAAC9B,gBAAgBN,MAAMmC,UAAU,CAAC,UAAU;YAC9CR,SAAS;YACT;QACF;QAEA,IAAIpB,UAAUgB,IAAIF,OAAO,IAAIrB,UAAU,YAAYA,UAAU,WAAW;YACtE,sCAAsC;YACtC,oEAAoE;YACpEuB,IAAIF,OAAO,CAACgB,SAAS;QACvB;QAEA,IAAIP,WAAW;QACf,IAAIM,YAA6BpC;QACjC,OAAQA;YACN,KAAK;gBACH,IAAIL,kBAAkBoC,QAAQ,EAAE;oBAC9BK,YAAY;gBACd,OAAO;oBACLxB,QAAQd;oBACRsC,YAAY;gBACd;gBACA;YACF,KAAK;gBACHvB,WAAWf;gBACXgC,WAAWzB,QAAQK,KAAK;gBACxB0B,YAAY;gBACZ;YACF,KAAK;gBACHtB,UAAUhB;gBACV;YACF,KAAK;gBACH,IAAIH,kBAAkBoC,QAAQ,EAAE;oBAC9BK,YAAY;gBACd,OAAO;oBACLrB;oBACAqB,YAAY;gBACd;gBACA;YACF,KAAK;gBACHpB;gBACAc,WAAWzB,QAAQM,IAAI;gBACvByB,YAAY;gBACZ;YACF,KAAK;gBACHnB;gBACAQ,iBAAiB;gBACjB;QACJ;QAEA,IAAIzB,UAAUoC,WAAW;YACvB,0DAA0D;YAC1D,qDAAqD;YACrD,IAAIpC,UAAU,YAAYQ,WAAW;gBACnCmB,SAAS;YACX;YAEA;QACF;QAEA,uEAAuE;QACvE,0EAA0E;QAC1E,kBAAkB;QAClB,MAAMW,gBACJ9B,aAAa4B,cAAc,WAAW,YAAYA;QACpD,IAAIN,YAAY,GAAG;YACjBH,SAASW;YACT;QACF;QAEA,MAAMC,QAAQC,OAAOC,UAAU,CAAC;YAC9Bd,SAASW;QACX,GAAGR;QAEH,OAAO;YACLU,OAAOE,YAAY,CAACH;QACtB;IACF,GAAG;QAACzC;QAAWyB;QAAKD;QAAKtB;QAAOQ;QAAWF;KAAa;IAExD,OAAO;QACLiB,KAAKC;QACLxB;QACAD;QACAD;QACA6C,cAAchB;QACdT,eAAeC,qBAAqBD;IACtC;AACF"}

package/dist/transition/utils.d.ts

@@ -1,18 +1,18 @@
 import type { CSSTransitionClassNames, CSSTransitionClassNamesObject, TransitionActions, TransitionTimeout, TransitionTimeoutObject } from "./types.js";
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */
 export interface TransitionTimeoutOptions extends Required<TransitionActions> {
     timeout: TransitionTimeout;
 }
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */
 export declare function getTransitionTimeout(options: Readonly<TransitionTimeoutOptions>): Readonly<Required<TransitionTimeoutObject>>;
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */
 export interface CollapseSizing {
@@ -26,19 +26,19 @@ export interface CollapseSizing {
  * max-height value since `max-height: auto` does not transition. The only way
  * to get transition is to change max-height values manually.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */
 export declare function getElementSizing(element: HTMLElement | null): CollapseSizing;
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */
 export interface TransitionClassNamesOptions extends TransitionTimeoutOptions {
     classNames: CSSTransitionClassNames;
 }
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */
 export declare function getTransitionClassNames(options: TransitionClassNamesOptions): Readonly<Required<CSSTransitionClassNamesObject>>;

package/dist/transition/utils.js

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */ export function getTransitionTimeout(options) {
     const { timeout, appear, enter, exit } = options;
@@ -22,7 +22,7 @@
  * max-height value since `max-height: auto` does not transition. The only way
  * to get transition is to change max-height values manually.
  *
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */ export function getElementSizing(element) {
     let maxHeight;
@@ -41,13 +41,18 @@
         container.appendChild(cloned);
         maxHeight = cloned.scrollHeight;
         const style = window.getComputedStyle(cloned);
+        const isContentBox = style.boxSizing === "content-box";
         if (style.paddingTop) {
             paddingTop = parseFloat(style.paddingTop);
-            maxHeight + paddingTop;
+            if (isContentBox) {
+                maxHeight += paddingTop;
+            }
         }
         if (style.paddingBottom) {
             paddingBottom = parseFloat(style.paddingBottom);
-            maxHeight + paddingBottom;
+            if (isContentBox) {
+                maxHeight += paddingBottom;
+            }
         }
         container.removeChild(cloned);
     }
@@ -58,7 +63,7 @@
     };
 }
 /**
- * @remarks \@since 4.0.0
+ * @since 4.0.0
  * @internal
  */ export function getTransitionClassNames(options) {
     const { classNames, ...timeoutOptions } = options;

package/dist/transition/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/transition/utils.ts"],"sourcesContent":["import type {\n  CSSTransitionClassNames,\n  CSSTransitionClassNamesObject,\n  TransitionActions,\n  TransitionTimeout,\n  TransitionTimeoutObject,\n} from \"./types.js\";\n\n/**\n * @remarks \\@since 4.0.0\n * @internal\n */\nexport interface TransitionTimeoutOptions extends Required<TransitionActions> {\n  timeout: TransitionTimeout;\n}\n\n/**\n * @remarks \\@since 4.0.0\n * @internal\n */\nexport function getTransitionTimeout(\n  options: Readonly<TransitionTimeoutOptions>\n): Readonly<Required<TransitionTimeoutObject>> {\n  const { timeout, appear, enter, exit } = options;\n  if (typeof timeout === \"number\") {\n    return {\n      appear: appear ? timeout : 0,\n      enter: enter ? timeout : 0,\n      exit: exit ? timeout : 0,\n    };\n  }\n\n  return {\n    appear: (appear && (timeout.appear ?? timeout.enter)) || 0,\n    enter: (enter && timeout.enter) || 0,\n    exit: (exit && timeout.exit) || 0,\n  };\n}\n\n/**\n * @remarks \\@since 4.0.0\n * @internal\n */\nexport interface CollapseSizing {\n  maxHeight?: number;\n  paddingTop?: number;\n  paddingBottom?: number;\n}\n\n/**\n * A small util that will find the max-height, padding-top, and padding-bottom\n * for the provided element. This is really used to be able to transition the\n * max-height value since `max-height: auto` does not transition. The only way\n * to get transition is to change max-height values manually.\n *\n * @remarks \\@since 4.0.0\n * @internal\n */\nexport function getElementSizing(element: HTMLElement | null): CollapseSizing {\n  let maxHeight;\n  let paddingTop;\n  let paddingBottom;\n  if (element) {\n    // clone the element so that the total height and padding can be calculated\n    // without being affected by the collapse transition inline styles\n    const cloned = element.cloneNode(true) as HTMLElement;\n    cloned.style.maxHeight = \"\";\n    cloned.style.padding = \"\";\n    cloned.style.paddingLeft = element.style.paddingLeft;\n    cloned.style.paddingRight = element.style.paddingRight;\n    cloned.style.visibility = \"hidden\";\n\n    const container = element.parentElement || document.body;\n    container.appendChild(cloned);\n    maxHeight = cloned.scrollHeight;\n    const style = window.getComputedStyle(cloned);\n    if (style.paddingTop) {\n      paddingTop = parseFloat(style.paddingTop);\n      maxHeight + paddingTop;\n    }\n\n    if (style.paddingBottom) {\n      paddingBottom = parseFloat(style.paddingBottom);\n      maxHeight + paddingBottom;\n    }\n    container.removeChild(cloned);\n  }\n\n  return { maxHeight, paddingTop, paddingBottom };\n}\n\n/**\n * @remarks \\@since 4.0.0\n * @internal\n */\nexport interface TransitionClassNamesOptions extends TransitionTimeoutOptions {\n  classNames: CSSTransitionClassNames;\n}\n\n/**\n * @remarks \\@since 4.0.0\n * @internal\n */\nexport function getTransitionClassNames(\n  options: TransitionClassNamesOptions\n): Readonly<Required<CSSTransitionClassNamesObject>> {\n  const { classNames, ...timeoutOptions } = options;\n  const timeout = getTransitionTimeout(timeoutOptions);\n\n  if (typeof classNames === \"string\") {\n    const { appear, enter, exit } = timeout;\n    return {\n      appear: appear ? `${classNames}--appear` : \"\",\n      appearActive: appear ? `${classNames}--appear-active` : \"\",\n      appearDone: \"\",\n      enter: enter ? `${classNames}--enter` : \"\",\n      enterActive: enter ? `${classNames}--enter-active` : \"\",\n      enterDone: \"\",\n      exit: exit ? `${classNames}--exit` : \"\",\n      exitActive: exit ? `${classNames}--exit-active` : \"\",\n      exitDone: \"\",\n    };\n  }\n\n  const {\n    enter = \"\",\n    enterActive = \"\",\n    enterDone = \"\",\n    exit = \"\",\n    exitActive = \"\",\n    exitDone = \"\",\n    appear = (timeout.appear && enter) || \"\",\n    appearActive = (timeout.appear && enterActive) || \"\",\n    appearDone = (timeout.appear && enterDone) || \"\",\n  } = classNames;\n\n  return {\n    appear,\n    appearActive,\n    appearDone,\n    enter,\n    enterActive,\n    enterDone,\n    exit,\n    exitActive,\n    exitDone,\n  };\n}\n"],"names":["getTransitionTimeout","options","timeout","appear","enter","exit","getElementSizing","element","maxHeight","paddingTop","paddingBottom","cloned","cloneNode","style","padding","paddingLeft","paddingRight","visibility","container","parentElement","document","body","appendChild","scrollHeight","window","getComputedStyle","parseFloat","removeChild","getTransitionClassNames","classNames","timeoutOptions","appearActive","appearDone","enterActive","enterDone","exitActive","exitDone"],"mappings":"AAgBA;;;CAGC,GACD,OAAO,SAASA,qBACdC,OAA2C;IAE3C,MAAM,EAAEC,OAAO,EAAEC,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAE,GAAGJ;IACzC,IAAI,OAAOC,YAAY,UAAU;QAC/B,OAAO;YACLC,QAAQA,SAASD,UAAU;YAC3BE,OAAOA,QAAQF,UAAU;YACzBG,MAAMA,OAAOH,UAAU;QACzB;IACF;IAEA,OAAO;QACLC,QAAQ,AAACA,UAAWD,CAAAA,QAAQC,MAAM,IAAID,QAAQE,KAAK,AAAD,KAAO;QACzDA,OAAO,AAACA,SAASF,QAAQE,KAAK,IAAK;QACnCC,MAAM,AAACA,QAAQH,QAAQG,IAAI,IAAK;IAClC;AACF;AAYA;;;;;;;;CAQC,GACD,OAAO,SAASC,iBAAiBC,OAA2B;IAC1D,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIH,SAAS;QACX,2EAA2E;QAC3E,kEAAkE;QAClE,MAAMI,SAASJ,QAAQK,SAAS,CAAC;QACjCD,OAAOE,KAAK,CAACL,SAAS,GAAG;QACzBG,OAAOE,KAAK,CAACC,OAAO,GAAG;QACvBH,OAAOE,KAAK,CAACE,WAAW,GAAGR,QAAQM,KAAK,CAACE,WAAW;QACpDJ,OAAOE,KAAK,CAACG,YAAY,GAAGT,QAAQM,KAAK,CAACG,YAAY;QACtDL,OAAOE,KAAK,CAACI,UAAU,GAAG;QAE1B,MAAMC,YAAYX,QAAQY,aAAa,IAAIC,SAASC,IAAI;QACxDH,UAAUI,WAAW,CAACX;QACtBH,YAAYG,OAAOY,YAAY;QAC/B,MAAMV,QAAQW,OAAOC,gBAAgB,CAACd;QACtC,IAAIE,MAAMJ,UAAU,EAAE;YACpBA,aAAaiB,WAAWb,MAAMJ,UAAU;YACxCD,YAAYC;QACd;QAEA,IAAII,MAAMH,aAAa,EAAE;YACvBA,gBAAgBgB,WAAWb,MAAMH,aAAa;YAC9CF,YAAYE;QACd;QACAQ,UAAUS,WAAW,CAAChB;IACxB;IAEA,OAAO;QAAEH;QAAWC;QAAYC;IAAc;AAChD;AAUA;;;CAGC,GACD,OAAO,SAASkB,wBACd3B,OAAoC;IAEpC,MAAM,EAAE4B,UAAU,EAAE,GAAGC,gBAAgB,GAAG7B;IAC1C,MAAMC,UAAUF,qBAAqB8B;IAErC,IAAI,OAAOD,eAAe,UAAU;QAClC,MAAM,EAAE1B,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAE,GAAGH;QAChC,OAAO;YACLC,QAAQA,SAAS,CAAC,EAAE0B,WAAW,QAAQ,CAAC,GAAG;YAC3CE,cAAc5B,SAAS,CAAC,EAAE0B,WAAW,eAAe,CAAC,GAAG;YACxDG,YAAY;YACZ5B,OAAOA,QAAQ,CAAC,EAAEyB,WAAW,OAAO,CAAC,GAAG;YACxCI,aAAa7B,QAAQ,CAAC,EAAEyB,WAAW,cAAc,CAAC,GAAG;YACrDK,WAAW;YACX7B,MAAMA,OAAO,CAAC,EAAEwB,WAAW,MAAM,CAAC,GAAG;YACrCM,YAAY9B,OAAO,CAAC,EAAEwB,WAAW,aAAa,CAAC,GAAG;YAClDO,UAAU;QACZ;IACF;IAEA,MAAM,EACJhC,QAAQ,EAAE,EACV6B,cAAc,EAAE,EAChBC,YAAY,EAAE,EACd7B,OAAO,EAAE,EACT8B,aAAa,EAAE,EACfC,WAAW,EAAE,EACbjC,SAAS,AAACD,QAAQC,MAAM,IAAIC,SAAU,EAAE,EACxC2B,eAAe,AAAC7B,QAAQC,MAAM,IAAI8B,eAAgB,EAAE,EACpDD,aAAa,AAAC9B,QAAQC,MAAM,IAAI+B,aAAc,EAAE,EACjD,GAAGL;IAEJ,OAAO;QACL1B;QACA4B;QACAC;QACA5B;QACA6B;QACAC;QACA7B;QACA8B;QACAC;IACF;AACF"}
+{"version":3,"sources":["../../src/transition/utils.ts"],"sourcesContent":["import type {\n  CSSTransitionClassNames,\n  CSSTransitionClassNamesObject,\n  TransitionActions,\n  TransitionTimeout,\n  TransitionTimeoutObject,\n} from \"./types.js\";\n\n/**\n * @since 4.0.0\n * @internal\n */\nexport interface TransitionTimeoutOptions extends Required<TransitionActions> {\n  timeout: TransitionTimeout;\n}\n\n/**\n * @since 4.0.0\n * @internal\n */\nexport function getTransitionTimeout(\n  options: Readonly<TransitionTimeoutOptions>\n): Readonly<Required<TransitionTimeoutObject>> {\n  const { timeout, appear, enter, exit } = options;\n  if (typeof timeout === \"number\") {\n    return {\n      appear: appear ? timeout : 0,\n      enter: enter ? timeout : 0,\n      exit: exit ? timeout : 0,\n    };\n  }\n\n  return {\n    appear: (appear && (timeout.appear ?? timeout.enter)) || 0,\n    enter: (enter && timeout.enter) || 0,\n    exit: (exit && timeout.exit) || 0,\n  };\n}\n\n/**\n * @since 4.0.0\n * @internal\n */\nexport interface CollapseSizing {\n  maxHeight?: number;\n  paddingTop?: number;\n  paddingBottom?: number;\n}\n\n/**\n * A small util that will find the max-height, padding-top, and padding-bottom\n * for the provided element. This is really used to be able to transition the\n * max-height value since `max-height: auto` does not transition. The only way\n * to get transition is to change max-height values manually.\n *\n * @since 4.0.0\n * @internal\n */\nexport function getElementSizing(element: HTMLElement | null): CollapseSizing {\n  let maxHeight: number | undefined;\n  let paddingTop: number | undefined;\n  let paddingBottom: number | undefined;\n  if (element) {\n    // clone the element so that the total height and padding can be calculated\n    // without being affected by the collapse transition inline styles\n    const cloned = element.cloneNode(true) as HTMLElement;\n    cloned.style.maxHeight = \"\";\n    cloned.style.padding = \"\";\n    cloned.style.paddingLeft = element.style.paddingLeft;\n    cloned.style.paddingRight = element.style.paddingRight;\n    cloned.style.visibility = \"hidden\";\n\n    const container = element.parentElement || document.body;\n    container.appendChild(cloned);\n    maxHeight = cloned.scrollHeight;\n    const style = window.getComputedStyle(cloned);\n    const isContentBox = style.boxSizing === \"content-box\";\n    if (style.paddingTop) {\n      paddingTop = parseFloat(style.paddingTop);\n      if (isContentBox) {\n        maxHeight += paddingTop;\n      }\n    }\n\n    if (style.paddingBottom) {\n      paddingBottom = parseFloat(style.paddingBottom);\n      if (isContentBox) {\n        maxHeight += paddingBottom;\n      }\n    }\n    container.removeChild(cloned);\n  }\n\n  return { maxHeight, paddingTop, paddingBottom };\n}\n\n/**\n * @since 4.0.0\n * @internal\n */\nexport interface TransitionClassNamesOptions extends TransitionTimeoutOptions {\n  classNames: CSSTransitionClassNames;\n}\n\n/**\n * @since 4.0.0\n * @internal\n */\nexport function getTransitionClassNames(\n  options: TransitionClassNamesOptions\n): Readonly<Required<CSSTransitionClassNamesObject>> {\n  const { classNames, ...timeoutOptions } = options;\n  const timeout = getTransitionTimeout(timeoutOptions);\n\n  if (typeof classNames === \"string\") {\n    const { appear, enter, exit } = timeout;\n    return {\n      appear: appear ? `${classNames}--appear` : \"\",\n      appearActive: appear ? `${classNames}--appear-active` : \"\",\n      appearDone: \"\",\n      enter: enter ? `${classNames}--enter` : \"\",\n      enterActive: enter ? `${classNames}--enter-active` : \"\",\n      enterDone: \"\",\n      exit: exit ? `${classNames}--exit` : \"\",\n      exitActive: exit ? `${classNames}--exit-active` : \"\",\n      exitDone: \"\",\n    };\n  }\n\n  const {\n    enter = \"\",\n    enterActive = \"\",\n    enterDone = \"\",\n    exit = \"\",\n    exitActive = \"\",\n    exitDone = \"\",\n    appear = (timeout.appear && enter) || \"\",\n    appearActive = (timeout.appear && enterActive) || \"\",\n    appearDone = (timeout.appear && enterDone) || \"\",\n  } = classNames;\n\n  return {\n    appear,\n    appearActive,\n    appearDone,\n    enter,\n    enterActive,\n    enterDone,\n    exit,\n    exitActive,\n    exitDone,\n  };\n}\n"],"names":["getTransitionTimeout","options","timeout","appear","enter","exit","getElementSizing","element","maxHeight","paddingTop","paddingBottom","cloned","cloneNode","style","padding","paddingLeft","paddingRight","visibility","container","parentElement","document","body","appendChild","scrollHeight","window","getComputedStyle","isContentBox","boxSizing","parseFloat","removeChild","getTransitionClassNames","classNames","timeoutOptions","appearActive","appearDone","enterActive","enterDone","exitActive","exitDone"],"mappings":"AAgBA;;;CAGC,GACD,OAAO,SAASA,qBACdC,OAA2C;IAE3C,MAAM,EAAEC,OAAO,EAAEC,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAE,GAAGJ;IACzC,IAAI,OAAOC,YAAY,UAAU;QAC/B,OAAO;YACLC,QAAQA,SAASD,UAAU;YAC3BE,OAAOA,QAAQF,UAAU;YACzBG,MAAMA,OAAOH,UAAU;QACzB;IACF;IAEA,OAAO;QACLC,QAAQ,AAACA,UAAWD,CAAAA,QAAQC,MAAM,IAAID,QAAQE,KAAK,AAAD,KAAO;QACzDA,OAAO,AAACA,SAASF,QAAQE,KAAK,IAAK;QACnCC,MAAM,AAACA,QAAQH,QAAQG,IAAI,IAAK;IAClC;AACF;AAYA;;;;;;;;CAQC,GACD,OAAO,SAASC,iBAAiBC,OAA2B;IAC1D,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIH,SAAS;QACX,2EAA2E;QAC3E,kEAAkE;QAClE,MAAMI,SAASJ,QAAQK,SAAS,CAAC;QACjCD,OAAOE,KAAK,CAACL,SAAS,GAAG;QACzBG,OAAOE,KAAK,CAACC,OAAO,GAAG;QACvBH,OAAOE,KAAK,CAACE,WAAW,GAAGR,QAAQM,KAAK,CAACE,WAAW;QACpDJ,OAAOE,KAAK,CAACG,YAAY,GAAGT,QAAQM,KAAK,CAACG,YAAY;QACtDL,OAAOE,KAAK,CAACI,UAAU,GAAG;QAE1B,MAAMC,YAAYX,QAAQY,aAAa,IAAIC,SAASC,IAAI;QACxDH,UAAUI,WAAW,CAACX;QACtBH,YAAYG,OAAOY,YAAY;QAC/B,MAAMV,QAAQW,OAAOC,gBAAgB,CAACd;QACtC,MAAMe,eAAeb,MAAMc,SAAS,KAAK;QACzC,IAAId,MAAMJ,UAAU,EAAE;YACpBA,aAAamB,WAAWf,MAAMJ,UAAU;YACxC,IAAIiB,cAAc;gBAChBlB,aAAaC;YACf;QACF;QAEA,IAAII,MAAMH,aAAa,EAAE;YACvBA,gBAAgBkB,WAAWf,MAAMH,aAAa;YAC9C,IAAIgB,cAAc;gBAChBlB,aAAaE;YACf;QACF;QACAQ,UAAUW,WAAW,CAAClB;IACxB;IAEA,OAAO;QAAEH;QAAWC;QAAYC;IAAc;AAChD;AAUA;;;CAGC,GACD,OAAO,SAASoB,wBACd7B,OAAoC;IAEpC,MAAM,EAAE8B,UAAU,EAAE,GAAGC,gBAAgB,GAAG/B;IAC1C,MAAMC,UAAUF,qBAAqBgC;IAErC,IAAI,OAAOD,eAAe,UAAU;QAClC,MAAM,EAAE5B,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAE,GAAGH;QAChC,OAAO;YACLC,QAAQA,SAAS,GAAG4B,WAAW,QAAQ,CAAC,GAAG;YAC3CE,cAAc9B,SAAS,GAAG4B,WAAW,eAAe,CAAC,GAAG;YACxDG,YAAY;YACZ9B,OAAOA,QAAQ,GAAG2B,WAAW,OAAO,CAAC,GAAG;YACxCI,aAAa/B,QAAQ,GAAG2B,WAAW,cAAc,CAAC,GAAG;YACrDK,WAAW;YACX/B,MAAMA,OAAO,GAAG0B,WAAW,MAAM,CAAC,GAAG;YACrCM,YAAYhC,OAAO,GAAG0B,WAAW,aAAa,CAAC,GAAG;YAClDO,UAAU;QACZ;IACF;IAEA,MAAM,EACJlC,QAAQ,EAAE,EACV+B,cAAc,EAAE,EAChBC,YAAY,EAAE,EACd/B,OAAO,EAAE,EACTgC,aAAa,EAAE,EACfC,WAAW,EAAE,EACbnC,SAAS,AAACD,QAAQC,MAAM,IAAIC,SAAU,EAAE,EACxC6B,eAAe,AAAC/B,QAAQC,MAAM,IAAIgC,eAAgB,EAAE,EACpDD,aAAa,AAAChC,QAAQC,MAAM,IAAIiC,aAAc,EAAE,EACjD,GAAGL;IAEJ,OAAO;QACL5B;QACA8B;QACAC;QACA9B;QACA+B;QACAC;QACA/B;QACAgC;QACAC;IACF;AACF"}

package/dist/tree/DefaultTreeItemRenderer.d.ts

@@ -1,6 +1,5 @@
 import { type ReactElement } from "react";
-import { type RenderRecursiveItemsProps } from "../utils/RenderRecursively.js";
-import { type DefaultTreeItemNode, type TreeItemNode } from "./types.js";
+import { type DefaultTreeItemNode, type TreeItemNode, type TreeItemRendererProps } from "./types.js";
 /**
  * **Client Component**
  *
@@ -11,6 +10,7 @@ import { type DefaultTreeItemNode, type TreeItemNode } from "./types.js";
  * Look at the `Tree` component for an example of creating a custom
  * implementation.
  *
- * @remarks \@since 6.0.0
+ * @see {@link https://next.react-md.dev/components/tree | Tree Demos}
+ * @since 6.0.0
  */
-export declare function DefaultTreeItemRenderer<T extends TreeItemNode = DefaultTreeItemNode>(props: RenderRecursiveItemsProps<T>): ReactElement;
+export declare function DefaultTreeItemRenderer<T extends TreeItemNode = DefaultTreeItemNode>(props: TreeItemRendererProps<T>): ReactElement;

package/dist/tree/DefaultTreeItemRenderer.js

@@ -10,9 +10,10 @@ import { TreeItem } from "./TreeItem.js";
  * Look at the `Tree` component for an example of creating a custom
  * implementation.
  *
- * @remarks \@since 6.0.0
+ * @see {@link https://next.react-md.dev/components/tree | Tree Demos}
+ * @since 6.0.0
  */ export function DefaultTreeItemRenderer(props) {
-    const { item: _item, parents, children: childItems } = props;
+    const { parents, children: childItems } = props;
     const item = props.item;
     const { itemId, to, href, disabled, className, contentClassName, leftAddon, leftAddonType, leftAddonPosition, leftAddonClassName, leftAddonForceWrap, rightAddon, rightAddonType, rightAddonPosition, rightAddonClassName, rightAddonForceWrap, disableLeftAddonCenteredMedia, disableRightAddonCenteredMedia } = item;
     const children = item.name ?? item.children;

package/dist/tree/DefaultTreeItemRenderer.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tree/DefaultTreeItemRenderer.tsx"],"sourcesContent":["import { type ReactElement } from \"react\";\nimport { type RenderRecursiveItemsProps } from \"../utils/RenderRecursively.js\";\nimport { TreeItem } from \"./TreeItem.js\";\nimport { type DefaultTreeItemNode, type TreeItemNode } from \"./types.js\";\n\n/**\n * **Client Component**\n *\n * A reasonable default for rendering tree items that will extract all the\n * `ListItemChildrenProps` from the item and attempt to pass them into the\n * `TreeItem`.\n *\n * Look at the `Tree` component for an example of creating a custom\n * implementation.\n *\n * @remarks \\@since 6.0.0\n */\nexport function DefaultTreeItemRenderer<\n  T extends TreeItemNode = DefaultTreeItemNode,\n>(props: RenderRecursiveItemsProps<T>): ReactElement {\n  const { item: _item, parents, children: childItems } = props;\n  const item = props.item as DefaultTreeItemNode;\n\n  const {\n    itemId,\n    to,\n    href,\n    disabled,\n    className,\n    contentClassName,\n    leftAddon,\n    leftAddonType,\n    leftAddonPosition,\n    leftAddonClassName,\n    leftAddonForceWrap,\n    rightAddon,\n    rightAddonType,\n    rightAddonPosition,\n    rightAddonClassName,\n    rightAddonForceWrap,\n    disableLeftAddonCenteredMedia,\n    disableRightAddonCenteredMedia,\n  } = item;\n  const children = item.name ?? item.children;\n\n  return (\n    <TreeItem\n      to={to}\n      href={href}\n      depth={parents.length}\n      childItems={childItems}\n      className={className}\n      contentClassName={contentClassName}\n      itemId={itemId}\n      disabled={disabled}\n      leftAddon={leftAddon}\n      leftAddonType={leftAddonType}\n      leftAddonPosition={leftAddonPosition}\n      leftAddonClassName={leftAddonClassName}\n      leftAddonForceWrap={leftAddonForceWrap}\n      rightAddon={rightAddon}\n      rightAddonType={rightAddonType}\n      rightAddonPosition={rightAddonPosition}\n      rightAddonClassName={rightAddonClassName}\n      rightAddonForceWrap={rightAddonForceWrap}\n      disableLeftAddonCenteredMedia={disableLeftAddonCenteredMedia}\n      disableRightAddonCenteredMedia={disableRightAddonCenteredMedia}\n    >\n      {children}\n    </TreeItem>\n  );\n}\n"],"names":["TreeItem","DefaultTreeItemRenderer","props","item","_item","parents","children","childItems","itemId","to","href","disabled","className","contentClassName","leftAddon","leftAddonType","leftAddonPosition","leftAddonClassName","leftAddonForceWrap","rightAddon","rightAddonType","rightAddonPosition","rightAddonClassName","rightAddonForceWrap","disableLeftAddonCenteredMedia","disableRightAddonCenteredMedia","name","depth","length"],"mappings":";AAEA,SAASA,QAAQ,QAAQ,gBAAgB;AAGzC;;;;;;;;;;;CAWC,GACD,OAAO,SAASC,wBAEdC,KAAmC;IACnC,MAAM,EAAEC,MAAMC,KAAK,EAAEC,OAAO,EAAEC,UAAUC,UAAU,EAAE,GAAGL;IACvD,MAAMC,OAAOD,MAAMC,IAAI;IAEvB,MAAM,EACJK,MAAM,EACNC,EAAE,EACFC,IAAI,EACJC,QAAQ,EACRC,SAAS,EACTC,gBAAgB,EAChBC,SAAS,EACTC,aAAa,EACbC,iBAAiB,EACjBC,kBAAkB,EAClBC,kBAAkB,EAClBC,UAAU,EACVC,cAAc,EACdC,kBAAkB,EAClBC,mBAAmB,EACnBC,mBAAmB,EACnBC,6BAA6B,EAC7BC,8BAA8B,EAC/B,GAAGtB;IACJ,MAAMG,WAAWH,KAAKuB,IAAI,IAAIvB,KAAKG,QAAQ;IAE3C,qBACE,KAACN;QACCS,IAAIA;QACJC,MAAMA;QACNiB,OAAOtB,QAAQuB,MAAM;QACrBrB,YAAYA;QACZK,WAAWA;QACXC,kBAAkBA;QAClBL,QAAQA;QACRG,UAAUA;QACVG,WAAWA;QACXC,eAAeA;QACfC,mBAAmBA;QACnBC,oBAAoBA;QACpBC,oBAAoBA;QACpBC,YAAYA;QACZC,gBAAgBA;QAChBC,oBAAoBA;QACpBC,qBAAqBA;QACrBC,qBAAqBA;QACrBC,+BAA+BA;QAC/BC,gCAAgCA;kBAE/BnB;;AAGP"}
+{"version":3,"sources":["../../src/tree/DefaultTreeItemRenderer.tsx"],"sourcesContent":["import { type ReactElement } from \"react\";\n\nimport { TreeItem } from \"./TreeItem.js\";\nimport {\n  type DefaultTreeItemNode,\n  type TreeItemNode,\n  type TreeItemRendererProps,\n} from \"./types.js\";\n\n/**\n * **Client Component**\n *\n * A reasonable default for rendering tree items that will extract all the\n * `ListItemChildrenProps` from the item and attempt to pass them into the\n * `TreeItem`.\n *\n * Look at the `Tree` component for an example of creating a custom\n * implementation.\n *\n * @see {@link https://next.react-md.dev/components/tree | Tree Demos}\n * @since 6.0.0\n */\nexport function DefaultTreeItemRenderer<\n  T extends TreeItemNode = DefaultTreeItemNode,\n>(props: TreeItemRendererProps<T>): ReactElement {\n  const { parents, children: childItems } = props;\n  const item = props.item as DefaultTreeItemNode;\n\n  const {\n    itemId,\n    to,\n    href,\n    disabled,\n    className,\n    contentClassName,\n    leftAddon,\n    leftAddonType,\n    leftAddonPosition,\n    leftAddonClassName,\n    leftAddonForceWrap,\n    rightAddon,\n    rightAddonType,\n    rightAddonPosition,\n    rightAddonClassName,\n    rightAddonForceWrap,\n    disableLeftAddonCenteredMedia,\n    disableRightAddonCenteredMedia,\n  } = item;\n  const children = item.name ?? item.children;\n\n  return (\n    <TreeItem\n      to={to}\n      href={href}\n      depth={parents.length}\n      childItems={childItems}\n      className={className}\n      contentClassName={contentClassName}\n      itemId={itemId}\n      disabled={disabled}\n      leftAddon={leftAddon}\n      leftAddonType={leftAddonType}\n      leftAddonPosition={leftAddonPosition}\n      leftAddonClassName={leftAddonClassName}\n      leftAddonForceWrap={leftAddonForceWrap}\n      rightAddon={rightAddon}\n      rightAddonType={rightAddonType}\n      rightAddonPosition={rightAddonPosition}\n      rightAddonClassName={rightAddonClassName}\n      rightAddonForceWrap={rightAddonForceWrap}\n      disableLeftAddonCenteredMedia={disableLeftAddonCenteredMedia}\n      disableRightAddonCenteredMedia={disableRightAddonCenteredMedia}\n    >\n      {children}\n    </TreeItem>\n  );\n}\n"],"names":["TreeItem","DefaultTreeItemRenderer","props","parents","children","childItems","item","itemId","to","href","disabled","className","contentClassName","leftAddon","leftAddonType","leftAddonPosition","leftAddonClassName","leftAddonForceWrap","rightAddon","rightAddonType","rightAddonPosition","rightAddonClassName","rightAddonForceWrap","disableLeftAddonCenteredMedia","disableRightAddonCenteredMedia","name","depth","length"],"mappings":";AAEA,SAASA,QAAQ,QAAQ,gBAAgB;AAOzC;;;;;;;;;;;;CAYC,GACD,OAAO,SAASC,wBAEdC,KAA+B;IAC/B,MAAM,EAAEC,OAAO,EAAEC,UAAUC,UAAU,EAAE,GAAGH;IAC1C,MAAMI,OAAOJ,MAAMI,IAAI;IAEvB,MAAM,EACJC,MAAM,EACNC,EAAE,EACFC,IAAI,EACJC,QAAQ,EACRC,SAAS,EACTC,gBAAgB,EAChBC,SAAS,EACTC,aAAa,EACbC,iBAAiB,EACjBC,kBAAkB,EAClBC,kBAAkB,EAClBC,UAAU,EACVC,cAAc,EACdC,kBAAkB,EAClBC,mBAAmB,EACnBC,mBAAmB,EACnBC,6BAA6B,EAC7BC,8BAA8B,EAC/B,GAAGlB;IACJ,MAAMF,WAAWE,KAAKmB,IAAI,IAAInB,KAAKF,QAAQ;IAE3C,qBACE,KAACJ;QACCQ,IAAIA;QACJC,MAAMA;QACNiB,OAAOvB,QAAQwB,MAAM;QACrBtB,YAAYA;QACZM,WAAWA;QACXC,kBAAkBA;QAClBL,QAAQA;QACRG,UAAUA;QACVG,WAAWA;QACXC,eAAeA;QACfC,mBAAmBA;QACnBC,oBAAoBA;QACpBC,oBAAoBA;QACpBC,YAAYA;QACZC,gBAAgBA;QAChBC,oBAAoBA;QACpBC,qBAAqBA;QACrBC,qBAAqBA;QACrBC,+BAA+BA;QAC/BC,gCAAgCA;kBAE/BpB;;AAGP"}

package/dist/tree/Tree.d.ts

@@ -1,9 +1,8 @@
 import { type ComponentType, type HTMLAttributes, type ReactElement, type ReactNode, type Ref } from "react";
 import { type CustomLinkComponent } from "../link/Link.js";
 import { type LabelRequiredForA11y } from "../types.js";
-import { type RenderRecursiveItemsProps } from "../utils/RenderRecursively.js";
 import { type TreeExpansionMode } from "./TreeProvider.js";
-import { type TreeData, type TreeItemNode, type TreeItemSorter } from "./types.js";
+import { type TreeData, type TreeItemNode, type TreeItemRendererProps, type TreeItemSorter } from "./types.js";
 import { type TreeExpansion } from "./useTreeExpansion.js";
 import { type TreeSelection } from "./useTreeSelection.js";
 declare module "react" {
@@ -15,12 +14,11 @@ declare module "react" {
     }
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type TreeHTMLAttributes = Omit<HTMLAttributes<HTMLUListElement>, "role" | "tabIndex" | "children">;
 /**
- * @remarks
- * \@since 6.0.0 There was a major API change and the `id` is now `optional`.
+ * @since 6.0.0 There was a major API change and the `id` is now `optional`.
  * In addition, the following props were removed:
  * - `itemRenderer`
  * - `labelKey`
@@ -35,13 +33,13 @@ export interface TreeProps<T extends TreeItemNode> extends TreeHTMLAttributes, T
     /**
      * An optional ref to pass to the tree element.
      *
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      */
     treeRef?: Ref<HTMLUListElement>;
     /** @defaultValue `identity` */
     sort?: TreeItemSorter<T>;
     /**
-     * Any nodes in the {@Link data} that have a `parentId` set to this value will
+     * Any nodes in the {@link data} that have a `parentId` set to this value will
      * appear at the root of the tree.
      *
      * @defaultValue `null`
@@ -79,14 +77,15 @@ export interface TreeProps<T extends TreeItemNode> extends TreeHTMLAttributes, T
      */
     temporaryChildItems?: boolean;
     /**
-     * @example
-     * Custom Tree Item Renderer
+     * @example Custom Tree Item Renderer
      * ```tsx
-     * import type { TreeItemRendererProps } from "@react-md/core";
-     * import { TreeItem, useKeyboardMovementContext, useTreeContext } from "@react-md/core";
+     * import { useTreeContext } from "@react-md/core/movement/TreeProvider"
+     * import { useKeyboardMovementContext } from "@react-md/core/movement/useKeyboardMovementProvider"
+     * import { TreeItem } from "@react-md/core/tree/TreeItem";
+     * import { type TreeItemRendererProps } from "@react-md/core/tree/types";
      * import FolderIcon from "@react-md/material-icons/FolderIcon";
      * import FolderOpenIcon from "@react-md/material-icons/FolderOpenIcon";
-     * import type { ReactElement } from "react";
+     * import { type ReactElement } from "react";
      *
      * export function CustomTreeItem(props: TreeItemRendererProps): ReactElement {
      *   const { item, ...remaining  } = props;
@@ -122,7 +121,7 @@ export interface TreeProps<T extends TreeItemNode> extends TreeHTMLAttributes, T
      * @see {@link DefaultTreeItemRenderer}
      * @defaultValue `DefaultTreeItemRenderer`
      */
-    renderer?: ComponentType<RenderRecursiveItemsProps<T>>;
+    renderer?: ComponentType<TreeItemRendererProps<T>>;
     /**
      * The link component to use for any tree item nodes that have a `to` or
      * `href`.
@@ -135,11 +134,11 @@ export interface TreeProps<T extends TreeItemNode> extends TreeHTMLAttributes, T
 /**
  * **Client Component**
  *
- * @example
- * Simple Tree
+ * @example Simple Tree
  * ```tsx
- * import type { TreeData } from "@react-md/core";
- * import { Tree, useTree } from "@react-md/core";
+ * import { Tree } from "@react-md/core/tree/Tree";
+ * import { type TreeData } from "@react-md/core/tree/types";
+ * import { useTree } from "@react-md/core/tree/useTree";
  * import type { ReactElement } from "react";
  *
  * const data: TreeData = {
@@ -180,10 +179,9 @@ export interface TreeProps<T extends TreeItemNode> extends TreeHTMLAttributes, T
  * }
  * ```
  *
+ * @see {@link https://next.react-md.dev/components/tree | Tree Demos}
  * @see {@link TreeProps.renderer} for a custom tree item example.
- *
- * @remarks
- * \@since 6.0.0 There was a major API change and the `id` is now `optional`.
+ * @since 6.0.0 There was a major API change and the `id` is now `optional`.
  * In addition, the following props were removed:
  * - `itemRenderer`
  * - `labelKey`

package/dist/tree/Tree.js

@@ -13,11 +13,11 @@ import { useTreeMovement } from "./useTreeMovement.js";
 /**
  * **Client Component**
  *
- * @example
- * Simple Tree
+ * @example Simple Tree
  * ```tsx
- * import type { TreeData } from "@react-md/core";
- * import { Tree, useTree } from "@react-md/core";
+ * import { Tree } from "@react-md/core/tree/Tree";
+ * import { type TreeData } from "@react-md/core/tree/types";
+ * import { useTree } from "@react-md/core/tree/useTree";
  * import type { ReactElement } from "react";
  *
  * const data: TreeData = {
@@ -58,10 +58,9 @@ import { useTreeMovement } from "./useTreeMovement.js";
  * }
  * ```
  *
+ * @see {@link https://next.react-md.dev/components/tree | Tree Demos}
  * @see {@link TreeProps.renderer} for a custom tree item example.
- *
- * @remarks
- * \@since 6.0.0 There was a major API change and the `id` is now `optional`.
+ * @since 6.0.0 There was a major API change and the `id` is now `optional`.
  * In addition, the following props were removed:
  * - `itemRenderer`
  * - `labelKey`
@@ -119,8 +118,8 @@ import { useTreeMovement } from "./useTreeMovement.js";
                 }),
                 children: /*#__PURE__*/ _jsx(RenderRecursively, {
                     items: items,
-                    getItemKey: (item)=>item.itemId,
-                    render: TreeItemRenderer
+                    render: TreeItemRenderer,
+                    getItemKey: (options)=>options.item.itemId
                 })
             })
         })

package/dist/tree/Tree.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tree/Tree.tsx"],"sourcesContent":["\"use client\";\nimport {\n  type ComponentType,\n  type HTMLAttributes,\n  type ReactElement,\n  type ReactNode,\n  type Ref,\n} from \"react\";\nimport { type CustomLinkComponent } from \"../link/Link.js\";\nimport { List } from \"../list/List.js\";\nimport { KeyboardMovementProvider } from \"../movement/useKeyboardMovementProvider.js\";\nimport { type LabelRequiredForA11y } from \"../types.js\";\nimport { useEnsuredId } from \"../useEnsuredId.js\";\nimport {\n  RenderRecursively,\n  type RenderRecursiveItemsProps,\n} from \"../utils/RenderRecursively.js\";\nimport { identity } from \"../utils/identity.js\";\nimport { DefaultTreeItemRenderer } from \"./DefaultTreeItemRenderer.js\";\nimport { TreeProvider, type TreeExpansionMode } from \"./TreeProvider.js\";\nimport { tree } from \"./styles.js\";\nimport {\n  type TreeData,\n  type TreeItemNode,\n  type TreeItemSorter,\n} from \"./types.js\";\nimport { type TreeExpansion } from \"./useTreeExpansion.js\";\nimport { useTreeItems } from \"./useTreeItems.js\";\nimport { useTreeMovement } from \"./useTreeMovement.js\";\nimport { type TreeSelection } from \"./useTreeSelection.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-tree-depth\"?: number;\n    \"--rmd-tree-item-padding\"?: string | number;\n    \"--rmd-tree-item-padding-base\"?: string | number;\n    \"--rmd-tree-item-padding-incrementor\"?: string | number;\n  }\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type TreeHTMLAttributes = Omit<\n  HTMLAttributes<HTMLUListElement>,\n  \"role\" | \"tabIndex\" | \"children\"\n>;\n\n/**\n * @remarks\n * \\@since 6.0.0 There was a major API change and the `id` is now `optional`.\n * In addition, the following props were removed:\n * - `itemRenderer`\n * - `labelKey`\n * - `valueKey`\n * - `getItemLabel`\n * - `getItemValue`\n * - `getItemProps`\n */\nexport interface TreeProps<T extends TreeItemNode>\n  extends TreeHTMLAttributes,\n    TreeExpansion,\n    TreeSelection {\n  /** @see {@link TreeData} */\n  data: TreeData<T>;\n\n  /**\n   * An optional ref to pass to the tree element.\n   *\n   * @remarks \\@since 6.0.0\n   */\n  treeRef?: Ref<HTMLUListElement>;\n\n  /** @defaultValue `identity` */\n  sort?: TreeItemSorter<T>;\n\n  /**\n   * Any nodes in the {@Link data} that have a `parentId` set to this value will\n   * appear at the root of the tree.\n   *\n   * @defaultValue `null`\n   */\n  rootId?: string | null;\n\n  /**\n   * @defaultValue `\"auto\"`\n   * @see {@link TreeExpansionMode}\n   */\n  expansionMode?: TreeExpansionMode;\n\n  /**\n   * Set this to `true` to display the expander icon to the left instead of the\n   * right. This will also update the styles slightly so you can still provide a\n   * `leftAddon`.\n   *\n   * @defaultValue `false`\n   */\n  expanderLeft?: boolean;\n\n  /**\n   * @defaultValue `getIcon(\"expander\")`\n   */\n  expanderIcon?: ReactNode;\n\n  /**\n   * Set this to `true` to disable the collapse transition for all tree items.\n   *\n   * @defaultValue `false`\n   */\n  disableTransition?: boolean;\n\n  /**\n   * Set this to `true` if the collapsed tree items should be removed from the\n   * DOM instead of hidden using `display: none`. This _might_ improve\n   * performance for large trees.\n   *\n   * @defaultValue `false`\n   */\n  temporaryChildItems?: boolean;\n\n  /**\n   * @example\n   * Custom Tree Item Renderer\n   * ```tsx\n   * import type { TreeItemRendererProps } from \"@react-md/core\";\n   * import { TreeItem, useKeyboardMovementContext, useTreeContext } from \"@react-md/core\";\n   * import FolderIcon from \"@react-md/material-icons/FolderIcon\";\n   * import FolderOpenIcon from \"@react-md/material-icons/FolderOpenIcon\";\n   * import type { ReactElement } from \"react\";\n   *\n   * export function CustomTreeItem(props: TreeItemRendererProps): ReactElement {\n   *   const { item, ...remaining  } = props;\n   *   const id = useId();\n   *   const { itemId } = item;\n   *   const {\n   *     data,\n   *     expandedIds,\n   *     selectedIds,\n   *     toggleTreeItemExpansion,\n   *     toggleTreeItemSelection,\n   *   } = useTreeContext()\n   *   const { activeDescendantId } = useKeyboardMovementContext();\n   *\n   *   const focused = id === activeDescendantId;\n   *   const expanded = expandedIds.has(itemId);\n   *   const selected = selectedIds.has(itemId);\n   *   const children = ...; // do whatever\n   *\n   *   return (\n   *     <TreeItem\n   *       {...remaining}\n   *       id={id}\n   *       itemId={itemId}\n   *       leftAddon={expanded ? <FolderOpenIcon /> : <FolderIcon />}\n   *     >\n   *       {children}\n   *     </TreeItem>\n   *   );\n   * }\n   * ```\n   *\n   * @see {@link DefaultTreeItemRenderer}\n   * @defaultValue `DefaultTreeItemRenderer`\n   */\n  renderer?: ComponentType<RenderRecursiveItemsProps<T>>;\n\n  /**\n   * The link component to use for any tree item nodes that have a `to` or\n   * `href`.\n   *\n   * @see {@link CustomLinkComponent}\n   * @defaultValue `Link`\n   */\n  linkComponent?: CustomLinkComponent;\n}\n\n/**\n * **Client Component**\n *\n * @example\n * Simple Tree\n * ```tsx\n * import type { TreeData } from \"@react-md/core\";\n * import { Tree, useTree } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * const data: TreeData = {\n *   \"item-1\": {\n *     itemId: \"item-1\",\n *     parentId: null,\n *     name: \"Root Level Item 1\",\n *   },\n *   \"item-2\": {\n *     itemId: \"item-2\",\n *     parentId: \"item-1\",\n *     name: \"A child for the first item\",\n *   },\n *   \"item-3\": {\n *     itemId: \"item-3\",\n *     parentId: \"item-1\",\n *     children: \"Another child for the first item\",\n *   },\n * };\n *\n * function Example(): ReactElement {\n *   const tree = useTree({\n *     // can enable multiple selected items\n *     // multiSelect: true,\n *\n *     // can set default expanded and selected items\n *     // defaultSelectedIds: [\"item-1\"],\n *     // defaultExpandedIds: [\"item-1\"],\n *   });\n *\n *   return (\n *     <Tree\n *       {...tree}\n *       aria-label=\"Tree\"\n *       data={data}\n *     />\n *   );\n * }\n * ```\n *\n * @see {@link TreeProps.renderer} for a custom tree item example.\n *\n * @remarks\n * \\@since 6.0.0 There was a major API change and the `id` is now `optional`.\n * In addition, the following props were removed:\n * - `itemRenderer`\n * - `labelKey`\n * - `valueKey`\n * - `getItemLabel`\n * - `getItemValue`\n * - `getItemProps`\n */\nexport function Tree<T extends TreeItemNode>(\n  props: LabelRequiredForA11y<TreeProps<T>>\n): ReactElement {\n  const {\n    id,\n    data,\n    sort = identity,\n    rootId = null,\n    treeRef,\n    className,\n    expandedIds,\n    selectedIds,\n    toggleTreeItemSelection,\n    selectMultipleTreeItems,\n    toggleTreeItemExpansion,\n    expandMultipleTreeItems,\n    onClick,\n    onFocus,\n    onKeyDown,\n    renderer: TreeItemRenderer = DefaultTreeItemRenderer,\n    multiSelect = false,\n    expansionMode = \"auto\",\n    expanderIcon,\n    expanderLeft = false,\n    linkComponent = \"a\",\n    disableTransition = false,\n    temporaryChildItems = false,\n    ...remaining\n  } = props;\n  const treeId = useEnsuredId(id, \"tree\");\n  const { items, treeItemChildIds } = useTreeItems({\n    data,\n    sort,\n    rootId,\n  });\n\n  const { metadataLookup, movementContext, movementProps } = useTreeMovement({\n    onClick,\n    onFocus,\n    onKeyDown,\n    data,\n    expandedIds,\n    selectedIds,\n    treeItemChildIds,\n    toggleTreeItemExpansion,\n    expandMultipleTreeItems,\n  });\n\n  return (\n    <TreeProvider\n      data={data}\n      rootId={rootId}\n      multiSelect={multiSelect}\n      linkComponent={linkComponent}\n      selectedIds={selectedIds}\n      expandedIds={expandedIds}\n      expanderIcon={expanderIcon}\n      expanderLeft={expanderLeft}\n      expansionMode={expansionMode}\n      metadataLookup={metadataLookup}\n      disableTransition={disableTransition}\n      temporaryChildItems={temporaryChildItems}\n      toggleTreeItemSelection={toggleTreeItemSelection}\n      toggleTreeItemExpansion={toggleTreeItemExpansion}\n      selectMultipleTreeItems={selectMultipleTreeItems}\n      expandMultipleTreeItems={expandMultipleTreeItems}\n    >\n      <KeyboardMovementProvider value={movementContext}>\n        <List\n          {...remaining}\n          {...movementProps}\n          id={treeId}\n          ref={treeRef}\n          role=\"tree\"\n          tabIndex={0}\n          className={tree({ className })}\n        >\n          <RenderRecursively\n            items={items}\n            getItemKey={(item) => item.itemId}\n            render={TreeItemRenderer}\n          />\n        </List>\n      </KeyboardMovementProvider>\n    </TreeProvider>\n  );\n}\n"],"names":["List","KeyboardMovementProvider","useEnsuredId","RenderRecursively","identity","DefaultTreeItemRenderer","TreeProvider","tree","useTreeItems","useTreeMovement","Tree","props","id","data","sort","rootId","treeRef","className","expandedIds","selectedIds","toggleTreeItemSelection","selectMultipleTreeItems","toggleTreeItemExpansion","expandMultipleTreeItems","onClick","onFocus","onKeyDown","renderer","TreeItemRenderer","multiSelect","expansionMode","expanderIcon","expanderLeft","linkComponent","disableTransition","temporaryChildItems","remaining","treeId","items","treeItemChildIds","metadataLookup","movementContext","movementProps","value","ref","role","tabIndex","getItemKey","item","itemId","render"],"mappings":"AAAA;;AASA,SAASA,IAAI,QAAQ,kBAAkB;AACvC,SAASC,wBAAwB,QAAQ,6CAA6C;AAEtF,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SACEC,iBAAiB,QAEZ,gCAAgC;AACvC,SAASC,QAAQ,QAAQ,uBAAuB;AAChD,SAASC,uBAAuB,QAAQ,+BAA+B;AACvE,SAASC,YAAY,QAAgC,oBAAoB;AACzE,SAASC,IAAI,QAAQ,cAAc;AAOnC,SAASC,YAAY,QAAQ,oBAAoB;AACjD,SAASC,eAAe,QAAQ,uBAAuB;AAoJvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2DC,GACD,OAAO,SAASC,KACdC,KAAyC;IAEzC,MAAM,EACJC,EAAE,EACFC,IAAI,EACJC,OAAOV,QAAQ,EACfW,SAAS,IAAI,EACbC,OAAO,EACPC,SAAS,EACTC,WAAW,EACXC,WAAW,EACXC,uBAAuB,EACvBC,uBAAuB,EACvBC,uBAAuB,EACvBC,uBAAuB,EACvBC,OAAO,EACPC,OAAO,EACPC,SAAS,EACTC,UAAUC,mBAAmBvB,uBAAuB,EACpDwB,cAAc,KAAK,EACnBC,gBAAgB,MAAM,EACtBC,YAAY,EACZC,eAAe,KAAK,EACpBC,gBAAgB,GAAG,EACnBC,oBAAoB,KAAK,EACzBC,sBAAsB,KAAK,EAC3B,GAAGC,WACJ,GAAGzB;IACJ,MAAM0B,SAASnC,aAAaU,IAAI;IAChC,MAAM,EAAE0B,KAAK,EAAEC,gBAAgB,EAAE,GAAG/B,aAAa;QAC/CK;QACAC;QACAC;IACF;IAEA,MAAM,EAAEyB,cAAc,EAAEC,eAAe,EAAEC,aAAa,EAAE,GAAGjC,gBAAgB;QACzEe;QACAC;QACAC;QACAb;QACAK;QACAC;QACAoB;QACAjB;QACAC;IACF;IAEA,qBACE,KAACjB;QACCO,MAAMA;QACNE,QAAQA;QACRc,aAAaA;QACbI,eAAeA;QACfd,aAAaA;QACbD,aAAaA;QACba,cAAcA;QACdC,cAAcA;QACdF,eAAeA;QACfU,gBAAgBA;QAChBN,mBAAmBA;QACnBC,qBAAqBA;QACrBf,yBAAyBA;QACzBE,yBAAyBA;QACzBD,yBAAyBA;QACzBE,yBAAyBA;kBAEzB,cAAA,KAACtB;YAAyB0C,OAAOF;sBAC/B,cAAA,KAACzC;gBACE,GAAGoC,SAAS;gBACZ,GAAGM,aAAa;gBACjB9B,IAAIyB;gBACJO,KAAK5B;gBACL6B,MAAK;gBACLC,UAAU;gBACV7B,WAAWV,KAAK;oBAAEU;gBAAU;0BAE5B,cAAA,KAACd;oBACCmC,OAAOA;oBACPS,YAAY,CAACC,OAASA,KAAKC,MAAM;oBACjCC,QAAQtB;;;;;AAMpB"}
+{"version":3,"sources":["../../src/tree/Tree.tsx"],"sourcesContent":["\"use client\";\n\nimport {\n  type ComponentType,\n  type HTMLAttributes,\n  type ReactElement,\n  type ReactNode,\n  type Ref,\n} from \"react\";\n\nimport { type CustomLinkComponent } from \"../link/Link.js\";\nimport { List } from \"../list/List.js\";\nimport { KeyboardMovementProvider } from \"../movement/useKeyboardMovementProvider.js\";\nimport { type LabelRequiredForA11y } from \"../types.js\";\nimport { useEnsuredId } from \"../useEnsuredId.js\";\nimport { RenderRecursively } from \"../utils/RenderRecursively.js\";\nimport { identity } from \"../utils/identity.js\";\nimport { DefaultTreeItemRenderer } from \"./DefaultTreeItemRenderer.js\";\nimport { type TreeExpansionMode, TreeProvider } from \"./TreeProvider.js\";\nimport { tree } from \"./styles.js\";\nimport {\n  type TreeData,\n  type TreeItemNode,\n  type TreeItemRendererProps,\n  type TreeItemSorter,\n} from \"./types.js\";\nimport { type TreeExpansion } from \"./useTreeExpansion.js\";\nimport { useTreeItems } from \"./useTreeItems.js\";\nimport { useTreeMovement } from \"./useTreeMovement.js\";\nimport { type TreeSelection } from \"./useTreeSelection.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-tree-depth\"?: number;\n    \"--rmd-tree-item-padding\"?: string | number;\n    \"--rmd-tree-item-padding-base\"?: string | number;\n    \"--rmd-tree-item-padding-incrementor\"?: string | number;\n  }\n}\n\n/**\n * @since 6.0.0\n */\nexport type TreeHTMLAttributes = Omit<\n  HTMLAttributes<HTMLUListElement>,\n  \"role\" | \"tabIndex\" | \"children\"\n>;\n\n/**\n * @since 6.0.0 There was a major API change and the `id` is now `optional`.\n * In addition, the following props were removed:\n * - `itemRenderer`\n * - `labelKey`\n * - `valueKey`\n * - `getItemLabel`\n * - `getItemValue`\n * - `getItemProps`\n */\nexport interface TreeProps<T extends TreeItemNode>\n  extends TreeHTMLAttributes,\n    TreeExpansion,\n    TreeSelection {\n  /** @see {@link TreeData} */\n  data: TreeData<T>;\n\n  /**\n   * An optional ref to pass to the tree element.\n   *\n   * @since 6.0.0\n   */\n  treeRef?: Ref<HTMLUListElement>;\n\n  /** @defaultValue `identity` */\n  sort?: TreeItemSorter<T>;\n\n  /**\n   * Any nodes in the {@link data} that have a `parentId` set to this value will\n   * appear at the root of the tree.\n   *\n   * @defaultValue `null`\n   */\n  rootId?: string | null;\n\n  /**\n   * @defaultValue `\"auto\"`\n   * @see {@link TreeExpansionMode}\n   */\n  expansionMode?: TreeExpansionMode;\n\n  /**\n   * Set this to `true` to display the expander icon to the left instead of the\n   * right. This will also update the styles slightly so you can still provide a\n   * `leftAddon`.\n   *\n   * @defaultValue `false`\n   */\n  expanderLeft?: boolean;\n\n  /**\n   * @defaultValue `getIcon(\"expander\")`\n   */\n  expanderIcon?: ReactNode;\n\n  /**\n   * Set this to `true` to disable the collapse transition for all tree items.\n   *\n   * @defaultValue `false`\n   */\n  disableTransition?: boolean;\n\n  /**\n   * Set this to `true` if the collapsed tree items should be removed from the\n   * DOM instead of hidden using `display: none`. This _might_ improve\n   * performance for large trees.\n   *\n   * @defaultValue `false`\n   */\n  temporaryChildItems?: boolean;\n\n  /**\n   * @example Custom Tree Item Renderer\n   * ```tsx\n   * import { useTreeContext } from \"@react-md/core/movement/TreeProvider\"\n   * import { useKeyboardMovementContext } from \"@react-md/core/movement/useKeyboardMovementProvider\"\n   * import { TreeItem } from \"@react-md/core/tree/TreeItem\";\n   * import { type TreeItemRendererProps } from \"@react-md/core/tree/types\";\n   * import FolderIcon from \"@react-md/material-icons/FolderIcon\";\n   * import FolderOpenIcon from \"@react-md/material-icons/FolderOpenIcon\";\n   * import { type ReactElement } from \"react\";\n   *\n   * export function CustomTreeItem(props: TreeItemRendererProps): ReactElement {\n   *   const { item, ...remaining  } = props;\n   *   const id = useId();\n   *   const { itemId } = item;\n   *   const {\n   *     data,\n   *     expandedIds,\n   *     selectedIds,\n   *     toggleTreeItemExpansion,\n   *     toggleTreeItemSelection,\n   *   } = useTreeContext()\n   *   const { activeDescendantId } = useKeyboardMovementContext();\n   *\n   *   const focused = id === activeDescendantId;\n   *   const expanded = expandedIds.has(itemId);\n   *   const selected = selectedIds.has(itemId);\n   *   const children = ...; // do whatever\n   *\n   *   return (\n   *     <TreeItem\n   *       {...remaining}\n   *       id={id}\n   *       itemId={itemId}\n   *       leftAddon={expanded ? <FolderOpenIcon /> : <FolderIcon />}\n   *     >\n   *       {children}\n   *     </TreeItem>\n   *   );\n   * }\n   * ```\n   *\n   * @see {@link DefaultTreeItemRenderer}\n   * @defaultValue `DefaultTreeItemRenderer`\n   */\n  renderer?: ComponentType<TreeItemRendererProps<T>>;\n\n  /**\n   * The link component to use for any tree item nodes that have a `to` or\n   * `href`.\n   *\n   * @see {@link CustomLinkComponent}\n   * @defaultValue `Link`\n   */\n  linkComponent?: CustomLinkComponent;\n}\n\n/**\n * **Client Component**\n *\n * @example Simple Tree\n * ```tsx\n * import { Tree } from \"@react-md/core/tree/Tree\";\n * import { type TreeData } from \"@react-md/core/tree/types\";\n * import { useTree } from \"@react-md/core/tree/useTree\";\n * import type { ReactElement } from \"react\";\n *\n * const data: TreeData = {\n *   \"item-1\": {\n *     itemId: \"item-1\",\n *     parentId: null,\n *     name: \"Root Level Item 1\",\n *   },\n *   \"item-2\": {\n *     itemId: \"item-2\",\n *     parentId: \"item-1\",\n *     name: \"A child for the first item\",\n *   },\n *   \"item-3\": {\n *     itemId: \"item-3\",\n *     parentId: \"item-1\",\n *     children: \"Another child for the first item\",\n *   },\n * };\n *\n * function Example(): ReactElement {\n *   const tree = useTree({\n *     // can enable multiple selected items\n *     // multiSelect: true,\n *\n *     // can set default expanded and selected items\n *     // defaultSelectedIds: [\"item-1\"],\n *     // defaultExpandedIds: [\"item-1\"],\n *   });\n *\n *   return (\n *     <Tree\n *       {...tree}\n *       aria-label=\"Tree\"\n *       data={data}\n *     />\n *   );\n * }\n * ```\n *\n * @see {@link https://next.react-md.dev/components/tree | Tree Demos}\n * @see {@link TreeProps.renderer} for a custom tree item example.\n * @since 6.0.0 There was a major API change and the `id` is now `optional`.\n * In addition, the following props were removed:\n * - `itemRenderer`\n * - `labelKey`\n * - `valueKey`\n * - `getItemLabel`\n * - `getItemValue`\n * - `getItemProps`\n */\nexport function Tree<T extends TreeItemNode>(\n  props: LabelRequiredForA11y<TreeProps<T>>\n): ReactElement {\n  const {\n    id,\n    data,\n    sort = identity,\n    rootId = null,\n    treeRef,\n    className,\n    expandedIds,\n    selectedIds,\n    toggleTreeItemSelection,\n    selectMultipleTreeItems,\n    toggleTreeItemExpansion,\n    expandMultipleTreeItems,\n    onClick,\n    onFocus,\n    onKeyDown,\n    renderer: TreeItemRenderer = DefaultTreeItemRenderer,\n    multiSelect = false,\n    expansionMode = \"auto\",\n    expanderIcon,\n    expanderLeft = false,\n    linkComponent = \"a\",\n    disableTransition = false,\n    temporaryChildItems = false,\n    ...remaining\n  } = props;\n  const treeId = useEnsuredId(id, \"tree\");\n  const { items, treeItemChildIds } = useTreeItems({\n    data,\n    sort,\n    rootId,\n  });\n\n  const { metadataLookup, movementContext, movementProps } = useTreeMovement({\n    onClick,\n    onFocus,\n    onKeyDown,\n    data,\n    expandedIds,\n    selectedIds,\n    treeItemChildIds,\n    toggleTreeItemExpansion,\n    expandMultipleTreeItems,\n  });\n\n  return (\n    <TreeProvider\n      data={data}\n      rootId={rootId}\n      multiSelect={multiSelect}\n      linkComponent={linkComponent}\n      selectedIds={selectedIds}\n      expandedIds={expandedIds}\n      expanderIcon={expanderIcon}\n      expanderLeft={expanderLeft}\n      expansionMode={expansionMode}\n      metadataLookup={metadataLookup}\n      disableTransition={disableTransition}\n      temporaryChildItems={temporaryChildItems}\n      toggleTreeItemSelection={toggleTreeItemSelection}\n      toggleTreeItemExpansion={toggleTreeItemExpansion}\n      selectMultipleTreeItems={selectMultipleTreeItems}\n      expandMultipleTreeItems={expandMultipleTreeItems}\n    >\n      <KeyboardMovementProvider value={movementContext}>\n        <List\n          {...remaining}\n          {...movementProps}\n          id={treeId}\n          ref={treeRef}\n          role=\"tree\"\n          tabIndex={0}\n          className={tree({ className })}\n        >\n          <RenderRecursively\n            items={items}\n            render={TreeItemRenderer}\n            getItemKey={(options) => options.item.itemId}\n          />\n        </List>\n      </KeyboardMovementProvider>\n    </TreeProvider>\n  );\n}\n"],"names":["List","KeyboardMovementProvider","useEnsuredId","RenderRecursively","identity","DefaultTreeItemRenderer","TreeProvider","tree","useTreeItems","useTreeMovement","Tree","props","id","data","sort","rootId","treeRef","className","expandedIds","selectedIds","toggleTreeItemSelection","selectMultipleTreeItems","toggleTreeItemExpansion","expandMultipleTreeItems","onClick","onFocus","onKeyDown","renderer","TreeItemRenderer","multiSelect","expansionMode","expanderIcon","expanderLeft","linkComponent","disableTransition","temporaryChildItems","remaining","treeId","items","treeItemChildIds","metadataLookup","movementContext","movementProps","value","ref","role","tabIndex","render","getItemKey","options","item","itemId"],"mappings":"AAAA;;AAWA,SAASA,IAAI,QAAQ,kBAAkB;AACvC,SAASC,wBAAwB,QAAQ,6CAA6C;AAEtF,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SAASC,iBAAiB,QAAQ,gCAAgC;AAClE,SAASC,QAAQ,QAAQ,uBAAuB;AAChD,SAASC,uBAAuB,QAAQ,+BAA+B;AACvE,SAAiCC,YAAY,QAAQ,oBAAoB;AACzE,SAASC,IAAI,QAAQ,cAAc;AAQnC,SAASC,YAAY,QAAQ,oBAAoB;AACjD,SAASC,eAAe,QAAQ,uBAAuB;AAoJvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0DC,GACD,OAAO,SAASC,KACdC,KAAyC;IAEzC,MAAM,EACJC,EAAE,EACFC,IAAI,EACJC,OAAOV,QAAQ,EACfW,SAAS,IAAI,EACbC,OAAO,EACPC,SAAS,EACTC,WAAW,EACXC,WAAW,EACXC,uBAAuB,EACvBC,uBAAuB,EACvBC,uBAAuB,EACvBC,uBAAuB,EACvBC,OAAO,EACPC,OAAO,EACPC,SAAS,EACTC,UAAUC,mBAAmBvB,uBAAuB,EACpDwB,cAAc,KAAK,EACnBC,gBAAgB,MAAM,EACtBC,YAAY,EACZC,eAAe,KAAK,EACpBC,gBAAgB,GAAG,EACnBC,oBAAoB,KAAK,EACzBC,sBAAsB,KAAK,EAC3B,GAAGC,WACJ,GAAGzB;IACJ,MAAM0B,SAASnC,aAAaU,IAAI;IAChC,MAAM,EAAE0B,KAAK,EAAEC,gBAAgB,EAAE,GAAG/B,aAAa;QAC/CK;QACAC;QACAC;IACF;IAEA,MAAM,EAAEyB,cAAc,EAAEC,eAAe,EAAEC,aAAa,EAAE,GAAGjC,gBAAgB;QACzEe;QACAC;QACAC;QACAb;QACAK;QACAC;QACAoB;QACAjB;QACAC;IACF;IAEA,qBACE,KAACjB;QACCO,MAAMA;QACNE,QAAQA;QACRc,aAAaA;QACbI,eAAeA;QACfd,aAAaA;QACbD,aAAaA;QACba,cAAcA;QACdC,cAAcA;QACdF,eAAeA;QACfU,gBAAgBA;QAChBN,mBAAmBA;QACnBC,qBAAqBA;QACrBf,yBAAyBA;QACzBE,yBAAyBA;QACzBD,yBAAyBA;QACzBE,yBAAyBA;kBAEzB,cAAA,KAACtB;YAAyB0C,OAAOF;sBAC/B,cAAA,KAACzC;gBACE,GAAGoC,SAAS;gBACZ,GAAGM,aAAa;gBACjB9B,IAAIyB;gBACJO,KAAK5B;gBACL6B,MAAK;gBACLC,UAAU;gBACV7B,WAAWV,KAAK;oBAAEU;gBAAU;0BAE5B,cAAA,KAACd;oBACCmC,OAAOA;oBACPS,QAAQnB;oBACRoB,YAAY,CAACC,UAAYA,QAAQC,IAAI,CAACC,MAAM;;;;;AAMxD"}

package/dist/tree/TreeGroup.d.ts

@@ -1,7 +1,7 @@
 import { type ReactNode } from "react";
 import { type ListProps } from "../list/List.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface OverridableTreeGroupProps extends ListProps {
     /** @defaultValue `false` */
@@ -11,7 +11,7 @@ export interface OverridableTreeGroupProps extends ListProps {
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface TreeGroupProps extends OverridableTreeGroupProps {
     children: ReactNode;
@@ -22,7 +22,7 @@ export interface TreeGroupProps extends OverridableTreeGroupProps {
  * **Client Component**
  *
  * @internal
- * @remarks \@since 6.0.0 Removed the collapse options and is no longer a
+ * @since 6.0.0 Removed the collapse options and is no longer a
  * "public" component.
  */
 export declare const TreeGroup: import("react").ForwardRefExoticComponent<TreeGroupProps & import("react").RefAttributes<HTMLUListElement>>;

package/dist/tree/TreeGroup.js

@@ -9,7 +9,7 @@ import { treeGroup } from "./styles.js";
  * **Client Component**
  *
  * @internal
- * @remarks \@since 6.0.0 Removed the collapse options and is no longer a
+ * @since 6.0.0 Removed the collapse options and is no longer a
  * "public" component.
  */ export const TreeGroup = /*#__PURE__*/ forwardRef(function TreeGroup(props, ref) {
     const { className, collapsed, depth, onClick, onMouseDown, children, temporary: propTemporary, disableTransition = false, ...remaining } = props;

package/dist/tree/TreeGroup.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tree/TreeGroup.tsx"],"sourcesContent":["\"use client\";\nimport { forwardRef, type CSSProperties, type ReactNode } from \"react\";\nimport { List, type ListProps } from \"../list/List.js\";\nimport { useCollapseTransition } from \"../transition/useCollapseTransition.js\";\nimport { useTreeContext } from \"./TreeProvider.js\";\nimport { treeGroup } from \"./styles.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface OverridableTreeGroupProps extends ListProps {\n  /** @defaultValue `false` */\n  temporary?: boolean;\n\n  /** @defaultValue `false` */\n  disableTransition?: boolean;\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface TreeGroupProps extends OverridableTreeGroupProps {\n  children: ReactNode;\n  depth: number;\n  collapsed: boolean;\n}\n\n/**\n * **Client Component**\n *\n * @internal\n * @remarks \\@since 6.0.0 Removed the collapse options and is no longer a\n * \"public\" component.\n */\nexport const TreeGroup = forwardRef<HTMLUListElement, TreeGroupProps>(\n  function TreeGroup(props, ref) {\n    const {\n      className,\n      collapsed,\n      depth,\n      onClick,\n      onMouseDown,\n      children,\n      temporary: propTemporary,\n      disableTransition = false,\n      ...remaining\n    } = props;\n\n    const style: CSSProperties = {\n      ...remaining.style,\n      \"--rmd-tree-depth\": depth,\n    };\n\n    const { temporaryChildItems } = useTreeContext();\n    const temporary = propTemporary ?? temporaryChildItems;\n\n    const { elementProps, rendered } = useCollapseTransition({\n      style,\n      nodeRef: ref,\n      enter: !disableTransition,\n      exit: !disableTransition,\n      transitionIn: !collapsed,\n      temporary,\n      className: treeGroup({ className }),\n    });\n\n    if (!rendered || !children) {\n      return null;\n    }\n\n    return (\n      <List\n        {...remaining}\n        onClick={(event) => {\n          onClick?.(event);\n          // always stop propagation for click events and mousedown for groups\n          // so that the parent child item's click and mousedown events aren't\n          // also fired while there are disabled child elementsS or\n          // non-interactable (like dividers or subheader)\n          event.stopPropagation();\n        }}\n        onMouseDown={(event) => {\n          onMouseDown?.(event);\n          event.stopPropagation();\n        }}\n        {...elementProps}\n        role=\"group\"\n      >\n        {children}\n      </List>\n    );\n  }\n);\n"],"names":["forwardRef","List","useCollapseTransition","useTreeContext","treeGroup","TreeGroup","props","ref","className","collapsed","depth","onClick","onMouseDown","children","temporary","propTemporary","disableTransition","remaining","style","temporaryChildItems","elementProps","rendered","nodeRef","enter","exit","transitionIn","event","stopPropagation","role"],"mappings":"AAAA;;AACA,SAASA,UAAU,QAA4C,QAAQ;AACvE,SAASC,IAAI,QAAwB,kBAAkB;AACvD,SAASC,qBAAqB,QAAQ,yCAAyC;AAC/E,SAASC,cAAc,QAAQ,oBAAoB;AACnD,SAASC,SAAS,QAAQ,cAAc;AAuBxC;;;;;;CAMC,GACD,OAAO,MAAMC,0BAAYL,WACvB,SAASK,UAAUC,KAAK,EAAEC,GAAG;IAC3B,MAAM,EACJC,SAAS,EACTC,SAAS,EACTC,KAAK,EACLC,OAAO,EACPC,WAAW,EACXC,QAAQ,EACRC,WAAWC,aAAa,EACxBC,oBAAoB,KAAK,EACzB,GAAGC,WACJ,GAAGX;IAEJ,MAAMY,QAAuB;QAC3B,GAAGD,UAAUC,KAAK;QAClB,oBAAoBR;IACtB;IAEA,MAAM,EAAES,mBAAmB,EAAE,GAAGhB;IAChC,MAAMW,YAAYC,iBAAiBI;IAEnC,MAAM,EAAEC,YAAY,EAAEC,QAAQ,EAAE,GAAGnB,sBAAsB;QACvDgB;QACAI,SAASf;QACTgB,OAAO,CAACP;QACRQ,MAAM,CAACR;QACPS,cAAc,CAAChB;QACfK;QACAN,WAAWJ,UAAU;YAAEI;QAAU;IACnC;IAEA,IAAI,CAACa,YAAY,CAACR,UAAU;QAC1B,OAAO;IACT;IAEA,qBACE,KAACZ;QACE,GAAGgB,SAAS;QACbN,SAAS,CAACe;YACRf,UAAUe;YACV,oEAAoE;YACpE,oEAAoE;YACpE,yDAAyD;YACzD,gDAAgD;YAChDA,MAAMC,eAAe;QACvB;QACAf,aAAa,CAACc;YACZd,cAAcc;YACdA,MAAMC,eAAe;QACvB;QACC,GAAGP,YAAY;QAChBQ,MAAK;kBAEJf;;AAGP,GACA"}
+{"version":3,"sources":["../../src/tree/TreeGroup.tsx"],"sourcesContent":["\"use client\";\n\nimport { type CSSProperties, type ReactNode, forwardRef } from \"react\";\n\nimport { List, type ListProps } from \"../list/List.js\";\nimport { useCollapseTransition } from \"../transition/useCollapseTransition.js\";\nimport { useTreeContext } from \"./TreeProvider.js\";\nimport { treeGroup } from \"./styles.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface OverridableTreeGroupProps extends ListProps {\n  /** @defaultValue `false` */\n  temporary?: boolean;\n\n  /** @defaultValue `false` */\n  disableTransition?: boolean;\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport interface TreeGroupProps extends OverridableTreeGroupProps {\n  children: ReactNode;\n  depth: number;\n  collapsed: boolean;\n}\n\n/**\n * **Client Component**\n *\n * @internal\n * @since 6.0.0 Removed the collapse options and is no longer a\n * \"public\" component.\n */\nexport const TreeGroup = forwardRef<HTMLUListElement, TreeGroupProps>(\n  function TreeGroup(props, ref) {\n    const {\n      className,\n      collapsed,\n      depth,\n      onClick,\n      onMouseDown,\n      children,\n      temporary: propTemporary,\n      disableTransition = false,\n      ...remaining\n    } = props;\n\n    const style: CSSProperties = {\n      ...remaining.style,\n      \"--rmd-tree-depth\": depth,\n    };\n\n    const { temporaryChildItems } = useTreeContext();\n    const temporary = propTemporary ?? temporaryChildItems;\n\n    const { elementProps, rendered } = useCollapseTransition({\n      style,\n      nodeRef: ref,\n      enter: !disableTransition,\n      exit: !disableTransition,\n      transitionIn: !collapsed,\n      temporary,\n      className: treeGroup({ className }),\n    });\n\n    if (!rendered || !children) {\n      return null;\n    }\n\n    return (\n      <List\n        {...remaining}\n        onClick={(event) => {\n          onClick?.(event);\n          // always stop propagation for click events and mousedown for groups\n          // so that the parent child item's click and mousedown events aren't\n          // also fired while there are disabled child elementsS or\n          // non-interactable (like dividers or subheader)\n          event.stopPropagation();\n        }}\n        onMouseDown={(event) => {\n          onMouseDown?.(event);\n          event.stopPropagation();\n        }}\n        {...elementProps}\n        role=\"group\"\n      >\n        {children}\n      </List>\n    );\n  }\n);\n"],"names":["forwardRef","List","useCollapseTransition","useTreeContext","treeGroup","TreeGroup","props","ref","className","collapsed","depth","onClick","onMouseDown","children","temporary","propTemporary","disableTransition","remaining","style","temporaryChildItems","elementProps","rendered","nodeRef","enter","exit","transitionIn","event","stopPropagation","role"],"mappings":"AAAA;;AAEA,SAA6CA,UAAU,QAAQ,QAAQ;AAEvE,SAASC,IAAI,QAAwB,kBAAkB;AACvD,SAASC,qBAAqB,QAAQ,yCAAyC;AAC/E,SAASC,cAAc,QAAQ,oBAAoB;AACnD,SAASC,SAAS,QAAQ,cAAc;AAuBxC;;;;;;CAMC,GACD,OAAO,MAAMC,0BAAYL,WACvB,SAASK,UAAUC,KAAK,EAAEC,GAAG;IAC3B,MAAM,EACJC,SAAS,EACTC,SAAS,EACTC,KAAK,EACLC,OAAO,EACPC,WAAW,EACXC,QAAQ,EACRC,WAAWC,aAAa,EACxBC,oBAAoB,KAAK,EACzB,GAAGC,WACJ,GAAGX;IAEJ,MAAMY,QAAuB;QAC3B,GAAGD,UAAUC,KAAK;QAClB,oBAAoBR;IACtB;IAEA,MAAM,EAAES,mBAAmB,EAAE,GAAGhB;IAChC,MAAMW,YAAYC,iBAAiBI;IAEnC,MAAM,EAAEC,YAAY,EAAEC,QAAQ,EAAE,GAAGnB,sBAAsB;QACvDgB;QACAI,SAASf;QACTgB,OAAO,CAACP;QACRQ,MAAM,CAACR;QACPS,cAAc,CAAChB;QACfK;QACAN,WAAWJ,UAAU;YAAEI;QAAU;IACnC;IAEA,IAAI,CAACa,YAAY,CAACR,UAAU;QAC1B,OAAO;IACT;IAEA,qBACE,KAACZ;QACE,GAAGgB,SAAS;QACbN,SAAS,CAACe;YACRf,UAAUe;YACV,oEAAoE;YACpE,oEAAoE;YACpE,yDAAyD;YACzD,gDAAgD;YAChDA,MAAMC,eAAe;QACvB;QACAf,aAAa,CAACc;YACZd,cAAcc;YACdA,MAAMC,eAAe;QACvB;QACC,GAAGP,YAAY;QAChBQ,MAAK;kBAEJf;;AAGP,GACA"}

package/dist/tree/TreeItem.d.ts

@@ -1,11 +1,16 @@
 import { type HTMLAttributes, type ReactElement, type ReactNode, type Ref } from "react";
+import { type ComponentWithRippleProps } from "../interaction/types.js";
 import { type PropsWithRef } from "../types.js";
 import { type OverridableTreeGroupProps } from "./TreeGroup.js";
 import { type DefaultTreeItemNode } from "./types.js";
 /**
- * @remarks \@since 6.0.0  Added the `groupProps` prop.
+ * @since 6.0.0 Added `liProps` and `groupProps`.
+ * @since 6.0.0 The `liRef`, `liStyle`, and `liClassName` props were removed in
+ * favor of `liProps={{ ref, style, className }}`.
+ * @since 6.0.0 The `itemIndex`, `listSize`, `renderChildItems`, `isLink`,
+ * `contentComponent`, and `readOnly` props were removed.
  */
-export interface TreeItemProps extends Omit<DefaultTreeItemNode, "parentId">, HTMLAttributes<HTMLLIElement> {
+export interface TreeItemProps extends Omit<DefaultTreeItemNode, "parentId">, HTMLAttributes<HTMLLIElement>, ComponentWithRippleProps {
     /**
      * @defaultValue `"tree-item-" + useId()`
      */
@@ -52,12 +57,15 @@ export interface TreeItemProps extends Omit<DefaultTreeItemNode, "parentId">, HT
 /**
  * **Client Component**
  *
+ * @see {@link https://next.react-md.dev/components/tree | Tree Demos}
  * @see {@link https://www.w3.org/WAI/ARIA/apg/patterns/treeview/}
- * @remarks
- * \@since 6.0.0 The wrapping `<li>` element will always be `role="none"` and
- * the `<span>` or `<a>` will gain the `role="treeitem"` instead. This makes it
+ * @since 6.0.0 No longer forwards refs. The ref must be provided using
+ * `contentRef` instead.
+ * @since 6.0.0 The `liRef` was removed in favor of `liProps={{ ref }}`.
+ * @since 6.0.0 The wrapping `<li>` element will always be `role="none"` and the
+ * `<span>` or `<a>` will gain the `role="treeitem"` instead. This makes it
  * easier to pass event handlers because of the nested behavior of tree items.
- * \@since 6.0.0 No longer provides the `aria-level`, `aria-setsize` and
+ * @since 6.0.0 No longer provides the `aria-level`, `aria-setsize` and
  * `aria-posinset` attributes and allows the browser to compute them instead.
  */
 export declare function TreeItem(props: TreeItemProps): ReactElement;