@primer/react-brand 0.75.2-rc.26bd444b → 0.76.0-rc.73295f51

package/docs/components/SubdomainNavBar/index.md

@@ -32,6 +32,32 @@ import {SubdomainNavBar} from '@primer/react-brand'
 </div>
 ```
 
+### Featured variant
+
+The `featured` variant displays the GitHub name alongside the site title and an expanded search field on desktop.
+
+> This variant is for internal use only.
+>
+> Please check with the Primer Brand team before using this variant.
+
+```jsx
+<div style={{width: '100%'}}>
+  <SubdomainNavBar title="Site title" variant="featured" fixed={false} fullWidth>
+    <SubdomainNavBar.Link href="#">Overview</SubdomainNavBar.Link>
+    <SubdomainNavBar.Link href="#">Documentation</SubdomainNavBar.Link>
+    <SubdomainNavBar.Link href="#">Resources</SubdomainNavBar.Link>
+    <SubdomainNavBar.Search
+      placeholder="Search Site title"
+      searchTerm=""
+      searchResults={[]}
+      onChange={() => undefined}
+      onSubmit={event => event.preventDefault()}
+    />
+    <SubdomainNavBar.PrimaryAction href="#">Primary CTA</SubdomainNavBar.PrimaryAction>
+  </SubdomainNavBar>
+</div>
+```
+
 ### Search
 
 `SubdomainNavBar` offers an optional search form control that supports both `onSubmit` and `onChange`; use `onChange` to display inline results. The `placeholder` labels the input in the opened dialog and defaults to `Search {title}`, or `Search` when no navigation title is available.
@@ -179,6 +205,7 @@ render(<LocalizedMenu />)
 | `style`                 | `React.CSSProperties`                                                                                                                                |                      | Forwards custom inline styles to the root element                       |
 | `fixed`                 | `boolean`                                                                                                                                            | `true`               | Fixes the navigation bar to the top of the viewport                     |
 | `fullWidth`             | `boolean`                                                                                                                                            | `false`              | Allows the inner content to fill the available width                    |
+| `variant`               | `'default' \| 'featured'`                                                                                                                            | `'default'`          | Sets the navigation layout                                              |
 | `logoHref`              | `string`                                                                                                                                             | `https://github.com` | Changes the URL of the GitHub logo                                      |
 | `title`                 | `string`                                                                                                                                             |                      | Required subdomain name used visibly and by assistive technologies      |
 | `titleHref`             | `string`                                                                                                                                             | `/`                  | Links the title to the subdomain root                                   |
@@ -187,7 +214,7 @@ render(<LocalizedMenu />)
 | `ref`                   | `React.Ref<SubdomainNavBarHandle>`                                                                                                                   |                      | Ref to the root element with `openSearch()` and `closeSearch()` methods |
 | `onNarrowMenuToggle`    | `(isOpen: boolean) => void`                                                                                                                          |                      | Called with the new state when the narrow menu opens or closes          |
 
-`SubdomainNavBarProps`, `SubdomainNavBarHandle`, and `SubdomainNavBarMenuLabels` are exported from `@primer/react-brand`.
+`SubdomainNavBarProps`, `SubdomainNavBarHandle`, `SubdomainNavBarMenuLabels`, and `SubdomainNavBarVariant` are exported from `@primer/react-brand`.
 
 ### Menu labels
 

package/docs/index.md

@@ -1,6 +1,6 @@
-# Primer Brand docs (v0.75.2-rc.26bd444b)
+# Primer Brand docs (v0.76.0-rc.73295f51)
 
-These docs are bundled with `@primer/react-brand@0.75.2-rc.26bd444b` and match your installed version.
+These docs are bundled with `@primer/react-brand@0.76.0-rc.73295f51` and match your installed version.
 
 New here? Start with [Getting started](getting-started/index.md) for installation, global
 stylesheet and font setup. Component directories are named after their import (e.g.

package/esm/SubdomainNavBar/SubdomainNavBar.d.ts

@@ -17,6 +17,7 @@ export type SubdomainNavBarMenuLabels = {
      */
     overflowMenuLabel: string;
 };
+export type SubdomainNavBarVariant = 'default' | 'featured';
 export type SubdomainNavBarProps = Omit<React.HTMLAttributes<HTMLElement>, 'children' | 'title'> & {
     /**
      * Valid child elements are `SubdomainNavBar.Link`, `SubdomainNavBar.PrimaryAction`,
@@ -31,6 +32,10 @@ export type SubdomainNavBarProps = Omit<React.HTMLAttributes<HTMLElement>, 'chil
      * Fill the maximum width of the parent container. Defaults to `false`.
      */
     fullWidth?: boolean;
+    /**
+     * Sets the navigation layout. Defaults to `default`.
+     */
+    variant?: SubdomainNavBarVariant;
     /**
      * Optional React element rendered after the navigation links.
      */
@@ -173,6 +178,10 @@ export declare const SubdomainNavBar: React.ForwardRefExoticComponent<Omit<React
      * Fill the maximum width of the parent container. Defaults to `false`.
      */
     fullWidth?: boolean;
+    /**
+     * Sets the navigation layout. Defaults to `default`.
+     */
+    variant?: SubdomainNavBarVariant;
     /**
      * Optional React element rendered after the navigation links.
      */

package/esm/SubdomainNavBar/SubdomainNavBar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SubdomainNavBar.d.ts","sourceRoot":"","sources":["../../src/SubdomainNavBar/SubdomainNavBar.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAIZ,iBAAiB,EAKlB,MAAM,OAAO,CAAA;AAUd;;GAEG;AACH,OAAO,qHAAqH,CAAA;AAS5H,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;CAC1B,CAAA;AAUD,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG;IACjG;;;OAGG;IACH,QAAQ,CAAC,EACL,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAC5C,KAAK,CAAC,YAAY,CAAC,0BAA0B,CAAC,GAC9C,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAA;IACrC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAA;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAC/C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG;IAChD,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,WAAW,EAAE,MAAM,IAAI,CAAA;CACxB,CAAA;AAihBD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,GAAG,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,CAAA;AAIjF,iBAAS,IAAI,CAAC,EACZ,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,EAAE,WAAW,EAC3B,aAAa,EAAE,UAAU,EACzB,QAAQ,EACR,GAAG,IAAI,EACR,EAAE,iBAAiB,CAAC,wBAAwB,CAAC,qBAyB7C;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,gCAAgC,EAAE,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG,gCAAgC,EAAE,GAAG,qCAAqC,EAAE,CAAA;AAEvH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAChD;;OAEG;IACH,mBAAmB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAA;IACpD;;OAEG;IACH,oBAAoB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;IACpD;;OAEG;IACH,kBAAkB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;IAClD;;OAEG;IACH,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;CAC7C,CAAA;AAcD,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,IAAI,CAAA;IACvD,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAA;IAC1D,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,IAAI,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,IAAI,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IACjC,aAAa,CAAC,EAAE,4BAA4B,CAAA;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAA;CAC9C,CAAA;AAqTD,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;AAE3C,iBAAS,aAAa,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,qBAelF;AAED,iBAAS,eAAe,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,qBAcpF;AAED,eAAO,MAAM,eAAe;IA5iC1B;;;OAGG;eAEC,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAC5C,KAAK,CAAC,YAAY,CAAC,0BAA0B,CAAC,GAC9C,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC;IACtC;;OAEG;YACK,OAAO;IACf;;OAEG;gBACS,OAAO;IACnB;;OAEG;uBACgB,KAAK,CAAC,YAAY;IACrC;;OAEG;wBACiB,KAAK,CAAC,YAAY;IACtC;;OAEG;WACI,MAAM;IACb;;OAEG;gBACS,MAAM;IAClB;;OAEG;eACQ,MAAM;IACjB;;OAEG;yBACkB,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;IAC9C;;OAEG;iBACU,OAAO,CAAC,yBAAyB,CAAC;IAC/C;;;OAGG;4BACqB,MAAM;;;;;;;;;;;;;CAigC9B,CAAA"}
+{"version":3,"file":"SubdomainNavBar.d.ts","sourceRoot":"","sources":["../../src/SubdomainNavBar/SubdomainNavBar.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAIZ,iBAAiB,EAKlB,MAAM,OAAO,CAAA;AAUd;;GAEG;AACH,OAAO,qHAAqH,CAAA;AAS5H,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,UAAU,CAAA;AAU3D,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG;IACjG;;;OAGG;IACH,QAAQ,CAAC,EACL,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAC5C,KAAK,CAAC,YAAY,CAAC,0BAA0B,CAAC,GAC9C,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;IAChC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAA;IACrC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAA;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;IAC9C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAC/C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG;IAChD,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,WAAW,EAAE,MAAM,IAAI,CAAA;CACxB,CAAA;AAuhBD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,GAAG,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,CAAA;AAIjF,iBAAS,IAAI,CAAC,EACZ,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,EAAE,WAAW,EAC3B,aAAa,EAAE,UAAU,EACzB,QAAQ,EACR,GAAG,IAAI,EACR,EAAE,iBAAiB,CAAC,wBAAwB,CAAC,qBAyB7C;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,gCAAgC,EAAE,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG,gCAAgC,EAAE,GAAG,qCAAqC,EAAE,CAAA;AAEvH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,qBAAqB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAChD;;OAEG;IACH,mBAAmB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAA;IACpD;;OAEG;IACH,oBAAoB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;IACpD;;OAEG;IACH,kBAAkB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;IAClD;;OAEG;IACH,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;CAC7C,CAAA;AAcD,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,IAAI,CAAA;IACvD,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAA;IAC1D,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,IAAI,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,IAAI,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IACjC,aAAa,CAAC,EAAE,4BAA4B,CAAA;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAA;CAC9C,CAAA;AAuTD,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;AAE3C,iBAAS,aAAa,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,qBAelF;AAED,iBAAS,eAAe,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,qBAcpF;AAED,eAAO,MAAM,eAAe;IAxjC1B;;;OAGG;eAEC,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAC5C,KAAK,CAAC,YAAY,CAAC,0BAA0B,CAAC,GAC9C,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC;IACtC;;OAEG;YACK,OAAO;IACf;;OAEG;gBACS,OAAO;IACnB;;OAEG;cACO,sBAAsB;IAChC;;OAEG;uBACgB,KAAK,CAAC,YAAY;IACrC;;OAEG;wBACiB,KAAK,CAAC,YAAY;IACtC;;OAEG;WACI,MAAM;IACb;;OAEG;gBACS,MAAM;IAClB;;OAEG;eACQ,MAAM;IACjB;;OAEG;yBACkB,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;IAC9C;;OAEG;iBACU,OAAO,CAAC,yBAAyB,CAAC;IAC/C;;;OAGG;4BACqB,MAAM;;;;;;;;;;;;;CAygC9B,CAAA"}