@primer/react-brand 0.75.0-rc.a3f7dbd6 → 0.75.0-rc.c3abcc84

package/esm/SubdomainNavBar/SubdomainNavBar.d.ts

@@ -3,16 +3,26 @@ import React, { PropsWithChildren } from 'react';
  * Design tokens
  */
 import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/components/subdomain-nav-bar/colors-with-modes.css';
-export type SubdomainNavBarProps = {
+export type SubdomainNavBarMenuLabels = {
     /**
-     * Valid child elements are `SubdomainNavBar.Link`, `SubdomainNavBar.PrimaryAction`,
-     * `SubdomainNavBar.SecondaryAction` and `SubdomainNavBar.Search`
+     * Visible and accessible label for the closed narrow menu control.
      */
-    children?: React.ReactNode | React.ReactElement<SubdomainNavBarLinkProps> | React.ReactElement<SearchProps> | React.ReactElement<CTAActionProps>;
+    menuLabel: string;
     /**
-     * Forward a custom HTML class attribute
+     * Visible and accessible label for the open narrow menu control.
      */
-    className?: string;
+    closeLabel: string;
+    /**
+     * Visible and accessible label for the desktop overflow menu control.
+     */
+    overflowMenuLabel: string;
+};
+export type SubdomainNavBarProps = Omit<React.HTMLAttributes<HTMLElement>, 'children' | 'title'> & {
+    /**
+     * Valid child elements are `SubdomainNavBar.Link`, `SubdomainNavBar.PrimaryAction`,
+     * `SubdomainNavBar.SecondaryAction` and `SubdomainNavBar.Search`
+     */
+    children?: React.ReactNode | React.ReactElement<SubdomainNavBarLinkProps> | React.ReactElement<SubdomainNavBarSearchProps> | React.ReactElement<CTAActionProps>;
     /**
      * Fixes the navigation bar to the top of the viewport. Defaults to `true`.
      */
@@ -22,7 +32,15 @@ export type SubdomainNavBarProps = {
      */
     fullWidth?: boolean;
     /**
-     * The title or name of the subdomain. Appears adjacent to the logo and is required for communicating content to assisitive technologies.
+     * Optional React element rendered after the navigation links.
+     */
+    leadingComponent?: React.ReactElement;
+    /**
+     * Optional React element rendered after the actions.
+     */
+    trailingComponent?: React.ReactElement;
+    /**
+     * The title or name of the subdomain. Appears adjacent to the logo and is required for communicating content to assistive technologies.
      */
     title: string;
     /**
@@ -37,41 +55,160 @@ export type SubdomainNavBarProps = {
      * When the menu is opened or closed on narrow viewports, this callback is called with the new open state.
      */
     onNarrowMenuToggle?: (isOpen: boolean) => void;
+    /**
+     * Customizable visible and accessible menu labels.
+     */
+    menuLabels?: Partial<SubdomainNavBarMenuLabels>;
+    /**
+     * ID of the element that receives focus when the skip-to-content link is activated.
+     * Defaults to the first rendered `main` element that is not hidden from assistive technologies.
+     */
+    skipToContentTargetId?: string;
+};
+export type SubdomainNavBarHandle = HTMLElement & {
+    openSearch: () => void;
+    closeSearch: () => void;
 };
-declare function Root({ children, className, fixed, fullWidth, logoHref, title, titleHref, onNarrowMenuToggle, ...rest }: SubdomainNavBarProps): import("react/jsx-runtime").JSX.Element;
 export type SubdomainNavBarLinkProps = {
     href: string;
     isExternal?: boolean;
-    'data-navitemid'?: string;
 } & React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>;
-declare function Link({ href, className, children, isExternal, ...rest }: PropsWithChildren<SubdomainNavBarLinkProps>): import("react/jsx-runtime").JSX.Element;
+declare function Link({ href, className, children, isExternal, 'aria-current': ariaCurrent, 'aria-hidden': ariaHidden, tabIndex, ...rest }: PropsWithChildren<SubdomainNavBarLinkProps>): import("react/jsx-runtime").JSX.Element;
 export type SubdomainNavBarSearchResultProps = {
     title: string;
     description: string;
     url: string;
     date: string;
     category?: string;
+    group?: string;
+    isExternal?: boolean;
+};
+export type SubdomainNavBarSearchResultGroupProps = {
+    title: string;
+    results: SubdomainNavBarSearchResultProps[];
 };
-type HandlerEvent = MouseEvent | TouchEvent | FocusEvent;
-type SearchProps = {
+export type SubdomainNavBarSearchResults = SubdomainNavBarSearchResultProps[] | SubdomainNavBarSearchResultGroupProps[];
+export type SubdomainNavBarSearchLabels = {
+    /**
+     * Accessible label for the search input. Defaults to "Search".
+     */
+    searchLabel: string;
+    /**
+     * Visible and accessible label for the close action. Defaults to "Close".
+     */
+    closeLabel: string;
+    /**
+     * Accessible label for an untitled search result group. Defaults to "Results".
+     */
+    resultsLabel: string;
+    /**
+     * Accessible label for grouped search results without a search term. Defaults to "Search results".
+     */
+    searchResultsLabel: string;
+    /**
+     * Formats the default search placeholder and dialog label using the navigation title.
+     */
+    formatSearchWithTitle: (title: string) => string;
+    /**
+     * Formats the accessible label for the responsive search trigger.
+     */
+    formatSearchTrigger: (placeholder: string) => string;
+    /**
+     * Formats the visible heading for ungrouped search results.
+     */
+    formatResultsHeading: (searchTerm: string) => string;
+    /**
+     * Formats the accessible label for grouped search results.
+     */
+    formatResultsLabel: (searchTerm: string) => string;
+    /**
+     * Formats the search result count announcement.
+     */
+    formatSuggestions: (count: number) => string;
+};
+export type SubdomainNavBarSearchProps = {
     onSubmit: (e: React.FormEvent<HTMLFormElement>) => void;
     onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
-    ref: React.RefObject<HTMLInputElement>;
     active?: boolean;
+    className?: string;
     title?: string;
-    handlerFn?: (event: HandlerEvent) => void;
-    autoComplete?: boolean;
-    searchResults?: SubdomainNavBarSearchResultProps[];
+    onSearchOpen?: () => void;
+    onSearchClose?: () => void;
+    /**
+     * Placeholder text shown in the search trigger and the opened search input.
+     */
+    placeholder?: string;
+    /**
+     * Optional keyboard shortcut hint shown in the search trigger. Pass an empty string to hide it.
+     */
+    shortcutLabel?: string;
+    /**
+     * Optional global keyboard shortcut that opens the search dialog. Omit or pass `false` to disable it.
+     * Supports single keys and modifier combinations, such as `/` or `Command+Option+k`.
+     */
+    keyboardShortcut?: string | false;
+    searchResults?: SubdomainNavBarSearchResults;
     searchTerm?: string;
+    /**
+     * Customizable visible and accessible search text. Unspecified labels use the English defaults.
+     */
+    labels?: Partial<SubdomainNavBarSearchLabels>;
 };
 type CTAActionProps = {
     href: string;
 } & React.HTMLAttributes<HTMLAnchorElement>;
 declare function PrimaryAction({ children, href, ...rest }: PropsWithChildren<CTAActionProps>): import("react/jsx-runtime").JSX.Element;
 declare function SecondaryAction({ children, href, ...rest }: PropsWithChildren<CTAActionProps>): import("react/jsx-runtime").JSX.Element;
-export declare const SubdomainNavBar: typeof Root & {
+export declare const SubdomainNavBar: React.ForwardRefExoticComponent<Omit<React.HTMLAttributes<HTMLElement>, "title" | "children"> & {
+    /**
+     * Valid child elements are `SubdomainNavBar.Link`, `SubdomainNavBar.PrimaryAction`,
+     * `SubdomainNavBar.SecondaryAction` and `SubdomainNavBar.Search`
+     */
+    children?: React.ReactNode | React.ReactElement<SubdomainNavBarLinkProps> | React.ReactElement<SubdomainNavBarSearchProps> | React.ReactElement<CTAActionProps>;
+    /**
+     * Fixes the navigation bar to the top of the viewport. Defaults to `true`.
+     */
+    fixed?: boolean;
+    /**
+     * Fill the maximum width of the parent container. Defaults to `false`.
+     */
+    fullWidth?: boolean;
+    /**
+     * Optional React element rendered after the navigation links.
+     */
+    leadingComponent?: React.ReactElement;
+    /**
+     * Optional React element rendered after the actions.
+     */
+    trailingComponent?: React.ReactElement;
+    /**
+     * The title or name of the subdomain. Appears adjacent to the logo and is required for communicating content to assistive technologies.
+     */
+    title: string;
+    /**
+     * The URL for the site. Typically used to link the titleText prop value to the site root.
+     */
+    titleHref?: string;
+    /**
+     * Optionally change the URL of the logo
+     */
+    logoHref?: string;
+    /**
+     * When the menu is opened or closed on narrow viewports, this callback is called with the new open state.
+     */
+    onNarrowMenuToggle?: (isOpen: boolean) => void;
+    /**
+     * Customizable visible and accessible menu labels.
+     */
+    menuLabels?: Partial<SubdomainNavBarMenuLabels>;
+    /**
+     * ID of the element that receives focus when the skip-to-content link is activated.
+     * Defaults to the first rendered `main` element that is not hidden from assistive technologies.
+     */
+    skipToContentTargetId?: string;
+} & React.RefAttributes<SubdomainNavBarHandle>> & {
     Link: typeof Link;
-    Search: React.ForwardRefExoticComponent<Omit<SearchProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
+    Search: React.ForwardRefExoticComponent<SubdomainNavBarSearchProps & React.RefAttributes<HTMLInputElement>>;
     PrimaryAction: typeof PrimaryAction;
     SecondaryAction: typeof SecondaryAction;
     testIds: {

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,EAAgC,iBAAiB,EAAiC,MAAM,OAAO,CAAA;AAW7G;;GAEG;AACH,OAAO,qHAAqH,CAAA;AAM5H,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,QAAQ,CAAC,EACL,KAAK,CAAC,SAAS,GACf,KAAK,CAAC,YAAY,CAAC,wBAAwB,CAAC,GAC5C,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,GAC/B,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;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;CAC/C,CAAA;AAiBD,iBAAS,IAAI,CAAC,EACZ,QAAQ,EACR,SAAS,EACT,KAAY,EACZ,SAAiB,EACjB,QAA+B,EAC/B,KAAK,EACL,SAAe,EACf,kBAAkB,EAClB,GAAG,IAAI,EACR,EAAE,oBAAoB,2CAgRtB;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,GAAG,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC,CAAA;AAEjF,iBAAS,IAAI,CAAC,EAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,wBAAwB,CAAC,2CAS1G;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;CAClB,CAAA;AAED,KAAK,YAAY,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAA;AAExD,KAAK,WAAW,GAAG;IACjB,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,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAA;IACtC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAA;IACzC,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,aAAa,CAAC,EAAE,gCAAgC,EAAE,CAAA;IAClD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAsND,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,2CAalF;AAED,iBAAS,eAAe,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,2CAYpF;AAED,eAAO,MAAM,eAAe;;;;;;;;;;;;CAM1B,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;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,2CAyB7C;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,2CAelF;AAED,iBAAS,eAAe,CAAC,EAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,EAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,2CAcpF;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"}