feat(ScoobieLink): Propagate v-panel param (#503)

Author: 72636c

README.md

@@ -345,7 +345,7 @@ export const MyFirstInlineCode = () => (
 
 Render an internal link with the same opinions as our [MdxProvider](#mdxprovider):
 
-- Internal links pass through the `v` URL parameter for UI version switching
+- Internal links pass through the `v` and `v-panel` URL parameters for UI version switching
 
 Unlike [SmartTextLink](#smarttextlink), this is not bound to a parent [Text] as it has no underlying [TextLink].
 It can be used to make complex components navigable rather than just sections of text.
@@ -398,7 +398,7 @@ export const Component = () => (
 
 Render all underlying links as follows:
 
-- Internal links pass through the `v` URL parameter for UI version switching
+- Internal links pass through the `v` and `v-panel` URL parameters for UI version switching
 - External links open in a new tab
 - Links with a [`download` attribute] prompt the user with a file download
 

src/private/url.test.ts

@@ -36,6 +36,19 @@ describe('parseInternalHref', () => {
     });
   });
 
+  it('preferences the v-panel URL parameter from location', () => {
+    const to = parseInternalHref('/hello?v-panel=v1&b=b1', {
+      pathname: '/',
+      search: '?a=1&v-panel=2&b=3',
+    });
+
+    expect(to).toEqual({
+      hash: '',
+      pathname: '/hello',
+      search: 'v-panel=2&b=b1',
+    });
+  });
+
   describe.each(['/page-1', '/page-1/'])(
     'given pathname %s',
     (inputPathname) => {

src/private/url.ts

@@ -5,10 +5,13 @@ const URLSearchParams = url.URLSearchParams ?? window.URLSearchParams;
 
 const EXAMPLE_BASE_URL = 'https://example.com';
 
-const parseVersionParam = (search: string) => {
+const parseVersionParams = (search: string) => {
   const urlSearchParams = new URLSearchParams(search);
 
-  return urlSearchParams.get('v');
+  return {
+    v: urlSearchParams.get('v'),
+    vPanel: urlSearchParams.get('v-panel'),
+  };
 };
 
 const hrefToUrl = (href: string, pathname: string) => {
@@ -32,11 +35,14 @@ export const parseInternalHref = (
 ) => {
   const { hash, pathname, searchParams } = hrefToUrl(href, location.pathname);
 
-  const v = parseVersionParam(location.search);
+  const { v, vPanel } = parseVersionParams(location.search);
 
   if (v !== null) {
     searchParams.set('v', v);
   }
+  if (vPanel !== null) {
+    searchParams.set('v-panel', vPanel);
+  }
 
   const search = searchParams.toString();