@cypress-design/react-docmenu 0.6.0 → 0.7.1

package/.turbo/turbo-build.log

@@ -2,5 +2,5 @@ $ yarn build:module && yarn build:types
 $ rollup -c ./rollup.config.mjs
 
 ./index.ts → ./dist/index.umd.js, ./dist/index.es.mjs...
-created ./dist/index.umd.js, ./dist/index.es.mjs in 16.1s
+created ./dist/index.umd.js, ./dist/index.es.mjs in 16.5s
 $ tsc --project ./tsconfig.build.json

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @cypress-design/react-docmenu
 
+## 0.7.1
+
+### Patch Changes
+
+- [`ad32042`](https://github.com/cypress-io/cypress-design/commit/ad3204289730de696c9728b1343e06ce68382561) Thanks [@elevatebart](https://github.com/elevatebart)! - only skip scrolling if both dimension are in view
+
+## 0.7.0
+
+### Minor Changes
+
+- [#388](https://github.com/cypress-io/cypress-design/pull/388) [`7839c67`](https://github.com/cypress-io/cypress-design/commit/7839c670d8a83f8339db1a5d4395bd0dd5eaf987) Thanks [@elevatebart](https://github.com/elevatebart)! - make docmenu scroll to active path if necessary
+
 ## 0.6.0
 
 ### Minor Changes

package/DocMenuReact.cy.tsx

@@ -3,7 +3,7 @@
 import * as React from 'react'
 import { mount } from 'cypress/react18'
 import DocMenu from './index'
-import assertions from '../assertions'
+import assertions, { BIG_ITEMS_SET } from '../assertions'
 import { NavGroup, NavItemLink } from '../constants'
 
 describe('<DocMenu/>', () => {
@@ -57,75 +57,7 @@ describe('<DocMenu/>', () => {
                   {children}
                 </div>
               )}
-              items={[
-                {
-                  href: '/fooTop',
-                  label: 'Foo Top',
-                },
-                {
-                  href: '/test',
-                  label: 'Getting started',
-                },
-                {
-                  href: '/faaz',
-                  label:
-                    'lorem ipsum dolor sit amet consectetur adipisicing elit. Quisquam,',
-                },
-                {
-                  label: 'Baaaaaaz',
-                  items: [
-                    {
-                      label: 'Bar',
-                      items: [
-                        {
-                          href: '/foo',
-                          label: 'Foo',
-                        },
-                        {
-                          href: '/test',
-                          label: 'Getting started',
-                        },
-                      ],
-                    },
-                    {
-                      label: 'Code',
-                      collapsed: true,
-                      items: [
-                        {
-                          href: '/faa',
-                          label: 'sasassa',
-                        },
-                        {
-                          href: '/faa1',
-                          label: 'sasassa2',
-                        },
-                        {
-                          href: '/faa2',
-                          label: 'sasassa3',
-                        },
-                        {
-                          href: '/faa3',
-                          label: 'sasassa4',
-                        },
-                        {
-                          href: '/faa4',
-                          label:
-                            'lorem ipsum dolor sit amet consectetur adipisicing elit',
-                        },
-                        {
-                          href: '/faa5',
-                          label: 'sasassa5',
-                        },
-                        {
-                          href: '/faa6',
-                          label:
-                            'lorem ipsum dolor sit amet consectetur adipisicing elit. Quisquam, quos',
-                        },
-                      ],
-                    },
-                  ],
-                },
-              ]}
+              items={BIG_ITEMS_SET}
             />
           </div>
         )
@@ -213,7 +145,46 @@ describe('<DocMenu/>', () => {
     }
     mount(<SUT />)
   })
-})
 
-// pseudo text
-// lorem ipsum dolor sit amet consectetur adipisicing elit. Quisquam, quos
+  it('scrolls the active item into view', { viewportHeight: 200 }, () => {
+    const SUT = () => {
+      const [pathState, setPathState] = React.useState<string>('/foo')
+      return (
+        <div className="p-4">
+          <button
+            onClick={() => setPathState('/faa6')}
+            className="p-2 m-2 rounded bg-gray-100 border border-gray-300"
+          >
+            Set path to <code>/faa6</code>
+          </button>
+          <DocMenu
+            items={BIG_ITEMS_SET}
+            LinkComponent={({ href, children, style, ...props }) => (
+              <button
+                onClick={() => setPathState(href)}
+                {...props}
+                style={{ ...style, textAlign: 'left' }}
+              >
+                {children}
+              </button>
+            )}
+            activePath={pathState}
+            collapsible
+          />
+        </div>
+      )
+    }
+    mount(<SUT />)
+
+    cy.findByText('Code').click()
+    cy.contains('Set path to').click()
+    cy.wait(200)
+    cy.contains('Quisquam, quos').then(($el) => {
+      const windowInnerHeight = Cypress.config(`viewportHeight`)
+
+      const rect = ($el?.[0] as any).getBoundingClientRect()
+
+      expect(windowInnerHeight).to.be.greaterThan(rect.top)
+    })
+  })
+})

package/_DocLink.tsx

@@ -56,12 +56,37 @@ export const DocLink = React.forwardRef<DocLinkForward, DocLinkProps>(
     // send the top position to the parent
     React.useEffect(setActiveMarkerPosition, [onActive, active])
 
+    React.useEffect(() => {
+      // if active check if the item is visible in the
+      // viewport and scrollIntoView if not
+      setTimeout(() => {
+        // give it time tp render and expand
+        if (active && activeLIRef.current) {
+          const rect = activeLIRef.current.getBoundingClientRect()
+
+          if (
+            rect.top > 0 &&
+            rect.bottom < window.innerHeight &&
+            rect.left > 0 &&
+            rect.right < window.innerWidth
+          ) {
+            return
+          }
+
+          activeLIRef.current.scrollIntoView({
+            block: 'nearest',
+            inline: 'nearest',
+          })
+        }
+      }, 200)
+    }, [active])
+
     React.useImperativeHandle(ref, () => ({
       setActiveMarkerPosition,
     }))
 
     return (
-      <li ref={activeLIRef} className="list-none p-0">
+      <li ref={activeLIRef} className="list-none p-0 scroll-my-10">
         <LinkComponent
           {...itemRest}
           className={clsx('group relative block w-full pl-[24px]', {

package/dist/_DocLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"_DocLink.d.ts","sourceRoot":"./","sources":["_DocLink.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAA;AAE/D,MAAM,WAAW,OAAO;IACtB,iBAAiB,EAAE,CAAC,cAAc,EAAE,OAAO,KAAK,IAAI,CAAA;IACpD,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,KAAK,CAAC,aAAa,CAAA;IAC1B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,OAAO,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IACzD,aAAa,EAAE,iBAAiB,CAAA;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,uBAAuB,EAAE,MAAM,IAAI,CAAA;CACpC;AAED,eAAO,MAAM,OAAO,qFA+DnB,CAAA"}
+{"version":3,"file":"_DocLink.d.ts","sourceRoot":"./","sources":["_DocLink.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAA;AAE/D,MAAM,WAAW,OAAO;IACtB,iBAAiB,EAAE,CAAC,cAAc,EAAE,OAAO,KAAK,IAAI,CAAA;IACpD,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,KAAK,CAAC,aAAa,CAAA;IAC1B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,OAAO,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IACzD,aAAa,EAAE,iBAAiB,CAAA;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,uBAAuB,EAAE,MAAM,IAAI,CAAA;CACpC;AAED,eAAO,MAAM,OAAO,qFAwFnB,CAAA"}

package/dist/index.es.mjs

@@ -180,10 +180,30 @@ var DocLink = React.forwardRef(function (_a, ref) {
     // on mount, if the item is active,
     // send the top position to the parent
     React.useEffect(setActiveMarkerPosition, [onActive, active]);
+    React.useEffect(function () {
+        // if active check if the item is visible in the
+        // viewport and scrollIntoView if not
+        setTimeout(function () {
+            // give it time tp render and expand
+            if (active && activeLIRef.current) {
+                var rect = activeLIRef.current.getBoundingClientRect();
+                if (rect.top > 0 &&
+                    rect.bottom < window.innerHeight &&
+                    rect.left > 0 &&
+                    rect.right < window.innerWidth) {
+                    return;
+                }
+                activeLIRef.current.scrollIntoView({
+                    block: 'nearest',
+                    inline: 'nearest',
+                });
+            }
+        }, 200);
+    }, [active]);
     React.useImperativeHandle(ref, function () { return ({
         setActiveMarkerPosition: setActiveMarkerPosition,
     }); });
-    return (React.createElement("li", { ref: activeLIRef, className: "list-none p-0" },
+    return (React.createElement("li", { ref: activeLIRef, className: "list-none p-0 scroll-my-10" },
         React.createElement(LinkComponent, __assign$1({}, itemRest, { className: clsx('group relative block w-full pl-[24px]', {
                 'text-indigo-500 dark:text-indigo-400': active,
                 'text-gray-700 dark:text-gray-500': !active,
@@ -406,4 +426,4 @@ var DocMenu = function (_a) {
 export { DocMenu as default };
 //# sourceMappingURL=index.es.mjs.map
 
-/* <wind-keep class="container relative absolute h-[36px] w-[4px] z-50 rounded-full bg-indigo-500 dark:bg-indigo-400 ml-[6.5px] mt-[4px] transition ease-in-out text-indigo-500 dark:text-indigo-400 text-gray-900 dark:text-gray-100 text-gray-800 dark:text-gray-200 rotate-0 -rotate-90 transition-all grid grid-rows-[0fr] grid-rows-[1fr] overflow-hidden filter list-none p-0 block w-full pl-[24px] text-gray-700 dark:text-gray-500 py-[8px] text-[16px] leading-[24px] leading-[20px] text-[14px] py-[12px] left-[6.5px] top-[4px] bottom-[4px] z-10 hidden group-hover:block bg-gray-300 text-indigo-400 text-gray-500 bg-indigo-400 left-0 transform transition-transform text-gray-400 dark:text-gray-700 flex py-[10px] items-center text-start font-medium pl-[48px] left-[8px] top-0 w-[1px] h-full bg-gray-100 dark:bg-gray-900"> */
+/* <wind-keep class="container relative absolute h-[36px] w-[4px] z-50 rounded-full bg-indigo-500 dark:bg-indigo-400 ml-[6.5px] mt-[4px] transition ease-in-out text-indigo-500 dark:text-indigo-400 text-gray-900 dark:text-gray-100 text-gray-800 dark:text-gray-200 rotate-0 -rotate-90 transition-all grid grid-rows-[0fr] grid-rows-[1fr] overflow-hidden filter list-none p-0 visible block inline scroll-my-10 w-full pl-[24px] text-gray-700 dark:text-gray-500 py-[8px] text-[16px] leading-[24px] leading-[20px] text-[14px] py-[12px] left-[6.5px] top-[4px] bottom-[4px] z-10 hidden group-hover:block bg-gray-300 text-indigo-400 text-gray-500 bg-indigo-400 left-0 transform transition-transform text-gray-400 dark:text-gray-700 flex py-[10px] items-center text-start font-medium pl-[48px] left-[8px] top-0 w-[1px] h-full bg-gray-100 dark:bg-gray-900"> */