@lifesg/react-design-system 4.0.0-alpha.1 → 4.0.0-alpha.11

package/navbar/navbar.styles.js

@@ -1,80 +1,2 @@
-import{MenuIcon as e}from"@lifesg/react-icons/menu";import i,{css as r}from"styled-components";import{ClickableIcon as o}from"../shared/clickable-icon/clickable-icon.js";import{V3_Border as t,V3_Colour as a,V3_Shadow as l,V3_Motion as n,V3_MediaQuery as d}from"../v3_theme/index.js";import{V3_ThemeNavbar as h}from"../v3_theme/components/theme-helper.js";const m=i.div`
-    position: ${e=>e.$fixed?"sticky":"relative"};
-    background-color: ${h["navbar-colour-bg"]};
-    z-index: 30;
-    top: 0;
-    left: 0;
-    right: 0;
-    width: 100%;
-    ${e=>{var i;return"dark"===(null===(i=e.theme)||void 0===i?void 0:i.colourMode)?r`
-                  border-bottom: ${t["width-010"]} ${t.solid}
-                      ${a.border};
-              `:r`
-                  box-shadow: ${l["xs-subtle"]};
-              `}}
-`,s=i.nav`
-    height: ${e=>{var i;const r=e.$compress?h["navbar-compressed-height"](e):h["navbar-full-height"](e);return"dark"===(null===(i=e.theme)||void 0===i?void 0:i.colourMode)?`calc(${r} - 1px)`:`${r}`}};
-    width: 100%;
-    display: flex;
-    flex-direction: row;
-    justify-content: space-between;
-    align-items: center;
-    position: relative;
-    transition: ${n["duration-350"]} ${n["ease-standard"]};
-
-    ${d.MaxWidth.lg} {
-        height: ${e=>{var i;return"dark"===(null===(i=e.theme)||void 0===i?void 0:i.colourMode)?`calc(${h["navbar-mobile-height"](e)} - 1px)`:`${h["navbar-mobile-height"](e)}`}};
-    }
-`,c=i.div`
-    display: flex;
-    height: 100%;
-    margin-left: ${e=>e.$hideNavBranding?"0":"5rem"};
-    flex: 1;
-    justify-content: flex-end;
-
-    ${d.MaxWidth.lg} {
-        margin-left: 0rem;
-    }
-`,g=i(o)`
-    display: none;
-
-    ${d.MaxWidth.lg} {
-        display: flex;
-        padding: 0 1.5rem;
-        margin-right: -1.5rem;
-    }
-`,$=i(e)`
-    height: 1.5rem;
-    width: 1.5rem;
-    color: ${h["navbar-colour-icon"]};
-`,p=i.div`
-    display: flex;
-    flex-direction: row;
-    align-items: center;
-    flex-shrink: 0;
-
-    height: ${e=>e.$compress?h["navbar-compressed-logo-height"]:h["navbar-full-logo-height"]};
-
-    ${d.MaxWidth.lg} {
-        height: ${h["navbar-mobile-logo-height"]};
-    }
-
-    ${d.MaxWidth.xxs} {
-        height: 1.25rem;
-    }
-`,v=i.div`
-    display: flex;
-    background-color: ${a.border};
-    height: 100%;
-    width: 2px;
-    margin: 0 ${e=>e.$compress?1:1.5}rem;
-
-    ${d.MaxWidth.lg} {
-        margin: 0 1rem;
-    }
-
-    ${d.MaxWidth.sm} {
-        margin: 0 0.75rem;
-    }
-`;export{g as MobileMenuButton,$ as MobileMenuIcon,s as Nav,p as NavBrandContainer,c as NavElementsContainer,v as NavSeparator,m as Wrapper};
+import"./navbar.styles_koy0c7.css";const n="wkxx447",v="w1818o7d",s="wjuvx4d",x="w1f5qsn6",e="wetstry",o="n1etv3uj",t="nhqxvja",a="nobvuz4",d="n10vmkvx",r="n1lixcfd",b="m12dog8x",c="m11vsg37",g="n11lmr0i",l="n1ge86ul",m="n18nedbe",w="n6r6bt7",f="n1lsvhqc",u="n1yd75go",y="ndxbaef",_="n3azfgc";export{b as mobileMenuButton,c as mobileMenuIcon,o as nav,g as navBrandContainer,l as navBrandContainerCompressed,m as navBrandContainerFull,w as navBrandContainerResponsive,t as navCompressed,a as navDark,d as navElementsContainer,r as navElementsContainerWithBranding,f as navSeparator,u as navSeparatorCompressed,y as navSeparatorFull,_ as navSeparatorResponsive,n as wrapper,x as wrapperDark,v as wrapperFixed,e as wrapperLight,s as wrapperRelative};
 //# sourceMappingURL=navbar.styles.js.map

package/navbar/navbar.styles.js.map

@@ -1 +1 @@
-{"version":3,"file":"navbar.styles.js","sources":["../../src/navbar/navbar.styles.tsx"],"sourcesContent":["import { MenuIcon } from \"@lifesg/react-icons/menu\";\nimport styled, { css } from \"styled-components\";\n\nimport { ClickableIcon } from \"../shared/clickable-icon\";\nimport {\n    V3_Border,\n    V3_Colour,\n    V3_MediaQuery,\n    V3_Motion,\n    V3_Shadow,\n} from \"../v3_theme\";\nimport { V3_ThemeNavbar } from \"../v3_theme/components/theme-helper\";\n\n// =============================================================================\n// STYLE INTERFACE\n// =============================================================================\ninterface StyleProps {\n    $compress?: boolean;\n    $fixed?: boolean;\n    $hideNavBranding?: boolean;\n}\n\n// =============================================================================\n// STYLING\n// =============================================================================\nexport const Wrapper = styled.div<StyleProps>`\n    position: ${(props) => (props.$fixed ? \"sticky\" : \"relative\")};\n    background-color: ${V3_ThemeNavbar[\"navbar-colour-bg\"]};\n    z-index: 30;\n    top: 0;\n    left: 0;\n    right: 0;\n    width: 100%;\n    ${(props) => {\n        return props.theme?.colourMode === \"dark\"\n            ? css`\n                  border-bottom: ${V3_Border[\"width-010\"]} ${V3_Border[\"solid\"]}\n                      ${V3_Colour[\"border\"]};\n              `\n            : css`\n                  box-shadow: ${V3_Shadow[\"xs-subtle\"]};\n              `;\n    }}\n`;\n\nexport const Nav = styled.nav<StyleProps>`\n    height: ${(props) => {\n        const baseHeight = props.$compress\n            ? V3_ThemeNavbar[\"navbar-compressed-height\"](props)\n            : V3_ThemeNavbar[\"navbar-full-height\"](props);\n        return props.theme?.colourMode === \"dark\"\n            ? `calc(${baseHeight} - 1px)`\n            : `${baseHeight}`;\n    }};\n    width: 100%;\n    display: flex;\n    flex-direction: row;\n    justify-content: space-between;\n    align-items: center;\n    position: relative;\n    transition: ${V3_Motion[\"duration-350\"]} ${V3_Motion[\"ease-standard\"]};\n\n    ${V3_MediaQuery.MaxWidth.lg} {\n        height: ${(props) =>\n            props.theme?.colourMode === \"dark\"\n                ? `calc(${V3_ThemeNavbar[\"navbar-mobile-height\"](props)} - 1px)`\n                : `${V3_ThemeNavbar[\"navbar-mobile-height\"](props)}`};\n    }\n`;\n\nexport const NavElementsContainer = styled.div<StyleProps>`\n    display: flex;\n    height: 100%;\n    margin-left: ${(props) => (props.$hideNavBranding ? \"0\" : \"5rem\")};\n    flex: 1;\n    justify-content: flex-end;\n\n    ${V3_MediaQuery.MaxWidth.lg} {\n        margin-left: 0rem;\n    }\n`;\n\nexport const MobileMenuButton = styled(ClickableIcon)`\n    display: none;\n\n    ${V3_MediaQuery.MaxWidth.lg} {\n        display: flex;\n        padding: 0 1.5rem;\n        margin-right: -1.5rem;\n    }\n`;\n\nexport const MobileMenuIcon = styled(MenuIcon)`\n    height: 1.5rem;\n    width: 1.5rem;\n    color: ${V3_ThemeNavbar[\"navbar-colour-icon\"]};\n`;\n\nexport const NavBrandContainer = styled.div<StyleProps>`\n    display: flex;\n    flex-direction: row;\n    align-items: center;\n    flex-shrink: 0;\n\n    height: ${(props) =>\n        props.$compress\n            ? V3_ThemeNavbar[\"navbar-compressed-logo-height\"]\n            : V3_ThemeNavbar[\"navbar-full-logo-height\"]};\n\n    ${V3_MediaQuery.MaxWidth.lg} {\n        height: ${V3_ThemeNavbar[\"navbar-mobile-logo-height\"]};\n    }\n\n    ${V3_MediaQuery.MaxWidth.xxs} {\n        height: 1.25rem;\n    }\n`;\n\nexport const NavSeparator = styled.div<StyleProps>`\n    display: flex;\n    background-color: ${V3_Colour.border};\n    height: 100%;\n    width: 2px;\n    margin: 0 ${(props) => (props.$compress ? 1 : 1.5)}rem;\n\n    ${V3_MediaQuery.MaxWidth.lg} {\n        margin: 0 1rem;\n    }\n\n    ${V3_MediaQuery.MaxWidth.sm} {\n        margin: 0 0.75rem;\n    }\n`;\n"],"names":["Wrapper","styled","div","props","$fixed","V3_ThemeNavbar","theme","_a","colourMode","css","V3_Border","V3_Colour","V3_Shadow","Nav","nav","baseHeight","$compress","V3_Motion","V3_MediaQuery","MaxWidth","lg","NavElementsContainer","$hideNavBranding","MobileMenuButton","ClickableIcon","MobileMenuIcon","MenuIcon","NavBrandContainer","xxs","NavSeparator","border","sm"],"mappings":"mWAyBO,MAAMA,EAAUC,EAAOC,GAAe;gBAC5BC,GAAWA,EAAMC,OAAS,SAAW;wBAC9BC,EAAe;;;;;;MAMhCF,UACC,MAAmC,UAAjB,UAAXA,EAAMG,aAAK,IAAAC,OAAA,EAAAA,EAAEC,YACdC,CAAG;mCACkBC,EAAU,gBAAgBA,EAAiB;wBACtDC,EAAkB;gBAE5BF,CAAG;gCACeG,EAAU;eAC3B;EAIFC,EAAMZ,EAAOa,GAAe;cAC1BX,UACP,MAAMY,EAAaZ,EAAMa,UACnBX,EAAe,4BAA4BF,GAC3CE,EAAe,sBAAsBF,GAC3C,MAAmC,UAAjB,UAAXA,EAAMG,aAAK,IAAAC,OAAA,EAAAA,EAAEC,YACd,QAAQO,WACR,GAAGA,GAAY;;;;;;;kBAQXE,EAAU,mBAAmBA,EAAU;;MAEnDC,EAAcC,SAASC;kBACVjB,UACP,MAA4B,UAAjB,UAAXA,EAAMG,aAAK,IAAAC,OAAA,EAAAA,EAAEC,YACP,QAAQH,EAAe,wBAAwBF,YAC/C,GAAGE,EAAe,wBAAwBF,IAAQ;;EAIvDkB,EAAuBpB,EAAOC,GAAe;;;mBAGtCC,GAAWA,EAAMmB,iBAAmB,IAAM;;;;MAIxDJ,EAAcC,SAASC;;;EAKhBG,EAAmBtB,EAAOuB,EAAc;;;MAG/CN,EAAcC,SAASC;;;;;EAOhBK,EAAiBxB,EAAOyB,EAAS;;;aAGjCrB,EAAe;EAGfsB,EAAoB1B,EAAOC,GAAe;;;;;;cAMxCC,GACPA,EAAMa,UACAX,EAAe,iCACfA,EAAe;;MAEvBa,EAAcC,SAASC;kBACXf,EAAe;;;MAG3Ba,EAAcC,SAASS;;;EAKhBC,EAAe5B,EAAOC,GAAe;;wBAE1BS,EAAUmB;;;gBAGjB3B,GAAWA,EAAMa,UAAY,EAAI;;MAE5CE,EAAcC,SAASC;;;;MAIvBF,EAAcC,SAASY;;;"}
+{"version":3,"file":"navbar.styles.js","sources":["../../src/navbar/navbar.styles.ts"],"sourcesContent":["import { css } from \"@linaria/core\";\n\nimport {\n    Border,\n    Colour,\n    ComponentToken,\n    MediaQuery,\n    Motion,\n    Shadow,\n} from \"../theme\";\n\nexport const tokens = {\n    nav: {\n        height: \"--fds-internal-navbar-nav-height\",\n    },\n};\n\nexport const wrapper = css`\n    background-color: ${ComponentToken.Navbar[\"colour-bg\"]};\n    z-index: 30;\n    top: 0;\n    left: 0;\n    right: 0;\n    width: 100%;\n`;\n\nexport const wrapperFixed = css`\n    position: sticky;\n`;\n\nexport const wrapperRelative = css`\n    position: relative;\n`;\n\nexport const wrapperDark = css`\n    border-bottom: ${Border[\"width-010\"]} ${Border[\"solid\"]} ${Colour[\"border\"]};\n`;\n\nexport const wrapperLight = css`\n    box-shadow: ${Shadow[\"xs-subtle\"]};\n`;\n\nexport const nav = css`\n    width: 100%;\n    display: flex;\n    flex-direction: row;\n    justify-content: space-between;\n    align-items: center;\n    position: relative;\n    transition: ${Motion[\"duration-350\"]} ${Motion[\"ease-standard\"]};\n\n    ${tokens.nav.height}: ${ComponentToken.Navbar[\"full-height\"]};\n    height: var(${tokens.nav.height});\n\n    ${MediaQuery.MaxWidth.lg} {\n        height: ${ComponentToken.Navbar[\"mobile-height\"]};\n    }\n`;\n\nexport const navCompressed = css`\n    ${tokens.nav.height}: ${ComponentToken.Navbar[\"compressed-height\"]};\n`;\n\nexport const navDark = css`\n    height: calc(var(${tokens.nav.height}) - 1px);\n\n    ${MediaQuery.MaxWidth.lg} {\n        height: calc(${ComponentToken.Navbar[\"mobile-height\"]} - 1px);\n    }\n`;\n\nexport const navElementsContainer = css`\n    display: flex;\n    height: 100%;\n    flex: 1;\n    justify-content: flex-end;\n`;\n\nexport const navElementsContainerWithBranding = css`\n    margin-left: 5rem;\n    ${MediaQuery.MaxWidth.lg} {\n        margin-left: 0;\n    }\n`;\n\nexport const mobileMenuButton = css`\n    display: none;\n\n    ${MediaQuery.MaxWidth.lg} {\n        display: flex;\n        padding: 0 1.5rem;\n        margin-right: -1.5rem;\n    }\n`;\n\nexport const mobileMenuIcon = css`\n    height: 1.5rem;\n    width: 1.5rem;\n    color: ${ComponentToken.Navbar[\"colour-icon\"]};\n`;\n\nexport const navBrandContainer = css`\n    display: flex;\n    flex-direction: row;\n    align-items: center;\n    flex-shrink: 0;\n`;\n\nexport const navBrandContainerCompressed = css`\n    height: ${ComponentToken.Navbar[\"compressed-logo-height\"]};\n`;\n\nexport const navBrandContainerFull = css`\n    height: ${ComponentToken.Navbar[\"full-logo-height\"]};\n`;\n\nexport const navBrandContainerResponsive = css`\n    ${MediaQuery.MaxWidth.lg} {\n        height: ${ComponentToken.Navbar[\"mobile-logo-height\"]};\n    }\n\n    ${MediaQuery.MaxWidth.xxs} {\n        height: 1.25rem;\n    }\n`;\n\nexport const navSeparator = css`\n    display: flex;\n    background-color: ${Colour.border};\n    height: 100%;\n    width: 2px;\n`;\n\nexport const navSeparatorCompressed = css`\n    margin: 0 1rem;\n`;\n\nexport const navSeparatorFull = css`\n    margin: 0 1.5rem;\n`;\n\nexport const navSeparatorResponsive = css`\n    ${MediaQuery.MaxWidth.lg} {\n        margin: 0 1rem;\n    }\n\n    ${MediaQuery.MaxWidth.sm} {\n        margin: 0 0.75rem;\n    }\n`;\n"],"names":["wrapper","wrapperFixed","wrapperRelative","wrapperDark","wrapperLight","nav","navCompressed","navDark","navElementsContainer","navElementsContainerWithBranding","mobileMenuButton","mobileMenuIcon","navBrandContainer","navBrandContainerCompressed","navBrandContainerFull","navBrandContainerResponsive","navSeparator","navSeparatorCompressed","navSeparatorFull","navSeparatorResponsive"],"mappings":"yDAiBO,MAAMA,EAAO,UASPC,EAAY,WAIZC,EAAe,UAIfC,EAAW,WAIXC,EAAY,UAIZC,EAAG,WAiBHC,EAAa,UAIbC,EAAO,UAQPC,EAAoB,WAOpBC,EAAgC,WAOhCC,EAAgB,WAUhBC,EAAc,WAMdC,EAAiB,WAOjBC,EAA2B,WAI3BC,EAAqB,WAIrBC,EAA2B,UAU3BC,EAAY,WAOZC,EAAsB,WAItBC,EAAgB,UAIhBC,EAAsB"}

package/navbar/navbar.styles_koy0c7.css

@@ -0,0 +1,20 @@
+@layer fds{.wkxx447{background-color:var(--fds-navbar-colour-bg);z-index:30;top:0;left:0;right:0;width:100%;}
+.w1818o7d{position:-webkit-sticky;position:sticky;}
+.wjuvx4d{position:relative;}
+.w1f5qsn6{border-bottom:var(--fds-border-width-010) var(--fds-border-style-solid) var(--fds-colour-border);}
+.wetstry{box-shadow:var(--fds-shadow-xs-subtle);}
+.n1etv3uj{width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-box-pack:justify;-ms-flex-pack:space-between;-webkit-justify-content:space-between;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;position:relative;-webkit-transition:var(--fds-motion-duration-350) var(--fds-motion-timing-ease-standard);transition:var(--fds-motion-duration-350) var(--fds-motion-timing-ease-standard);--fds-internal-navbar-nav-height:var(--fds-navbar-full-height);height:var(--fds-internal-navbar-nav-height);}:where(body.fds-breakpoint-lg-max) .n1etv3uj{height:var(--fds-navbar-mobile-height);}
+.nhqxvja{--fds-internal-navbar-nav-height:var(--fds-navbar-compressed-height);}
+.nobvuz4{height:calc(var(--fds-internal-navbar-nav-height) - 1px);}:where(body.fds-breakpoint-lg-max) .nobvuz4{height:calc(var(--fds-navbar-mobile-height) - 1px);}
+.n10vmkvx{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;height:100%;-webkit-flex:1;-ms-flex:1;flex:1;-webkit-box-pack:end;-ms-flex-pack:end;-webkit-justify-content:flex-end;justify-content:flex-end;}
+.n1lixcfd{margin-left:5rem;}:where(body.fds-breakpoint-lg-max) .n1lixcfd{margin-left:0;}
+.m12dog8x{display:none;}:where(body.fds-breakpoint-lg-max) .m12dog8x{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;padding:0 1.5rem;margin-right:-1.5rem;}
+.m11vsg37{height:1.5rem;width:1.5rem;color:var(--fds-navbar-colour-icon);}
+.n11lmr0i{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}
+.n1ge86ul{height:var(--fds-navbar-compressed-logo-height);}
+.n18nedbe{height:var(--fds-navbar-full-logo-height);}
+:where(body.fds-breakpoint-lg-max) .n6r6bt7{height:var(--fds-navbar-mobile-logo-height);}:where(body.fds-breakpoint-xxs-max) .n6r6bt7{height:1.25rem;}
+.n1lsvhqc{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;background-color:var(--fds-colour-border);height:100%;width:2px;}
+.n1yd75go{margin:0 1rem;}
+.ndxbaef{margin:0 1.5rem;}
+:where(body.fds-breakpoint-lg-max) .n3azfgc{margin:0 1rem;}:where(body.fds-breakpoint-sm-max) .n3azfgc{margin:0 0.75rem;}}

package/navbar/types.d.ts

@@ -1,101 +1,289 @@
 import type { ButtonProps } from "../button";
 import type { TypographyLinkProps } from "../typography";
+/**
+ * Props for a standard navigation link item.
+ */
 export interface NavItemLinkProps<T> extends NavItemCommonProps<T> {
     itemType?: "link";
     subMenu?: NavItemCommonProps<T>[] | undefined;
 }
+/**
+ * Props for a custom component slot navigation item.
+ */
 export interface NavItemComponentProps {
     itemType: "component";
     children: JSX.Element;
 }
+/**
+ * A single navigation item rendered by the navbar.
+ */
 export type NavItemProps<T> = NavItemLinkProps<T> | NavItemComponentProps;
+/**
+ * Shared props for link-type navigation items.
+ *
+ * `T` is the type of the arbitrary `options` payload.
+ */
 export interface NavItemCommonProps<T> extends TypographyLinkProps {
     id: string;
     "data-testid"?: string | undefined;
+    /**
+     * Arbitrary data passed through to callback arguments such as `onItemClick`.
+     */
     options?: T | undefined;
 }
+/**
+ * Desktop and mobile navigation item lists for the navbar.
+ *
+ * `T` is the type of the arbitrary `options` payload on each item.
+ */
 export interface NavItemsProps<T> {
+    /**
+     * Items rendered in the desktop navbar.
+     */
     desktop: NavItemProps<T>[];
+    /**
+     * Items rendered in the mobile drawer. Falls back to `desktop` when omitted.
+     */
     mobile?: NavItemProps<T>[] | undefined;
 }
+/** Props for a `"download"` type action button in the navbar. */
 export interface NavbarActionButtonDownloadProps {
     type: "download";
     args?: ButtonProps | undefined;
+    /**
+     * When `true`, the button remains visible outside the mobile drawer rather
+     * than being collapsed into it.
+     *
+     * @default false
+     */
     uncollapsible?: boolean | undefined;
 }
+/** Props for a `"button"` type action button in the navbar. */
 export interface NavbarActionButtonCtaProps {
     type: "button";
     args: ButtonProps;
+    /**
+     * When `true`, the button remains visible outside the mobile drawer rather
+     * than being collapsed into it.
+     *
+     * @default false
+     */
     uncollapsible?: boolean | undefined;
 }
-export interface NavbarButtonComponentProps {
+/** Props for the internal `"component"` type action button wrapper. */
+interface NavbarButtonComponentProps {
+    /** The custom component to be rendered */
     render: JSX.Element;
 }
+/** Props for a `"component"` type action button in the navbar. */
 export interface NavbarActionButtonComponentProps {
     type: "component";
     args?: NavbarButtonComponentProps | undefined;
+    /**
+     * When `true`, the button remains visible outside the mobile drawer rather
+     * than being collapsed into it.
+     *
+     * @default false
+     */
     uncollapsible?: boolean | undefined;
 }
+/**
+ * Props for a single action button in the navbar.
+ *
+ * `type` discriminates between `"button"`, `"download"`, and `"component"`.
+ */
 export type NavbarButtonProps = NavbarActionButtonDownloadProps | NavbarActionButtonCtaProps | NavbarActionButtonComponentProps;
+/** Props for the desktop and mobile action button lists in the navbar. */
 export interface NavbarActionButtonsProps {
+    /**
+     * Action buttons rendered in the desktop navbar.
+     */
     desktop: NavbarButtonProps[];
-    /** Navbar action buttons for mobile drawer. Takes desktop if not specified */
+    /**
+     * Action buttons rendered in the mobile drawer. Falls back to `desktop`
+     * when omitted.
+     */
     mobile?: NavbarButtonProps[] | undefined;
 }
+/**
+ * Branding identity for a primary or secondary brand slot in the navbar.
+ */
 export interface NavbarBrandingProps {
+    /** The name of the brand, used for accessibility and alt text. */
     brandName: string;
+    /** The source URL for the brand logo image. */
     logoSrc: string;
 }
+/**
+ * Logo resources for the primary and secondary brand slots in the navbar.
+ *
+ */
 export interface NavbarResourcesProps {
+    /**
+     * When omitted, a default logo derived from the active theme is used.
+     */
     primary?: NavbarBrandingProps | undefined;
+    /**
+     * When omitted, the secondary brand slot is hidden.
+     */
     secondary?: NavbarBrandingProps | undefined;
 }
+/**
+ * Props shared between `NavbarProps` and `NavbarDrawerProps`.
+ */
 export interface NavbarSharedProps {
+    /**
+     * Branding and logo resources for the navbar.
+     */
     resources?: NavbarResourcesProps | undefined;
+    /** Action buttons rendered in the navbar and mobile drawer. */
     actionButtons?: NavbarActionButtonsProps | undefined;
-    /** Specifies if brand logos are visible */
+    /**
+     * Hides all brand logos from the navbar and drawer.
+     *
+     * @default false
+     */
     hideNavBranding?: boolean | undefined;
-    /** Hide the selected link indicator across the navbar */
+    /**
+     * Hides the active-item underline indicator across desktop and drawer views.
+     *
+     * @default false
+     */
     hideLinkIndicator?: boolean | undefined;
 }
+/**
+ * Identifies the user action that can dismiss the mobile navigation drawer.
+ *
+ * Pass one or more values to `drawerDismissalExclusions` on `NavbarProps` to
+ * prevent those actions from closing the drawer.
+ *
+ * - `"close-button-click"` — the drawer's close button or overlay click
+ * - `"item-click"` — clicking a nav item or action button
+ * - `"brand-click"` — clicking a brand logo
+ */
 export type DrawerDismissalMethod = "close-button-click" | "item-click" | "brand-click";
+/**
+ * Props for the internal mobile navigation drawer panel.
+ */
 export interface NavbarDrawerProps extends NavbarSharedProps {
+    /**
+     * Controls whether the drawer is visible.
+     */
     show: boolean;
     children: JSX.Element | JSX.Element[];
+    /**
+     * Called when the drawer requests to be closed via the close button or
+     * overlay click.
+     */
     onClose?: (() => void) | undefined;
-    /** Triggered when the brand icon is being clicked */
+    /**
+     * Called when a brand logo inside the drawer is clicked.
+     */
     onBrandClick?: ((event: React.MouseEvent<HTMLAnchorElement>, type: BrandType) => void) | undefined;
-    /** Custom aria-label for the mobile navigation drawer */
+    /**
+     * Accessible label announced for the mobile navigation drawer.
+     */
     drawerLabel?: string | undefined;
-    /** Ref to the mobile menu button for focus management */
+    /**
+     * Ref to the mobile menu button used to return focus when the drawer closes.
+     */
     mobileMenuRef?: React.RefObject<HTMLButtonElement> | undefined;
 }
+/**
+ * Identifies which brand slot was interacted with in brand-related callbacks.
+ */
 export type BrandType = "primary" | "secondary";
+/**
+ * Imperative methods exposed by the `Navbar` component via `ref`.
+ */
 export type NavbarDrawerApi = {
+    /**
+     * Programmatically closes the mobile navigation drawer with its exit
+     * animation.
+     */
     dismissDrawer: () => void;
 };
+/**
+ * Imperative handle returned by `Navbar` via `ref`.
+ *
+ * Extends `HTMLDivElement` with `NavbarDrawerApi`. Use the ref to dismiss the
+ * mobile drawer programmatically without needing to manage drawer state
+ * externally.
+ */
 export type NavbarDrawerHandle = HTMLDivElement & NavbarDrawerApi;
+/**
+ * Props for the `Navbar` component.
+ */
 export interface NavbarProps<T = void> extends NavbarSharedProps {
     items: NavItemsProps<T>;
     className?: string | undefined;
     id?: string | undefined;
     "data-testid"?: string | undefined;
+    /**
+     * The currently selected navigation item identifier.
+     * Must match the `id` of one of the rendered items.
+     */
     selectedId?: string | undefined;
-    /** Specifies if the Navbar should be compressed */
+    /**
+     * Reduces the height and logo size of the navbar.
+     *
+     * @default false
+     */
     compress?: boolean | undefined;
-    /** Specifies if Navbar should be fixed to top */
+    /**
+     * Pins the navbar to the top of the viewport while the page scrolls.
+     *
+     * @default true
+     */
     fixed?: boolean | undefined;
-    /** Specifies which methods will not dismiss the drawer */
+    /**
+     * Drawer dismissal methods that should be suppressed. The drawer will not
+     * close when the user performs any of the listed actions.
+     */
     drawerDismissalExclusions?: DrawerDismissalMethod[] | undefined;
+    /**
+     * Hides nav items and action buttons, leaving only the brand area visible.
+     *
+     * @default false
+     */
     hideNavElements?: boolean | undefined;
+    /**
+     * Called when a brand logo is clicked. `type` identifies which brand slot
+     * was activated.
+     */
     onBrandClick?: ((type: BrandType) => void) | undefined;
+    /**
+     * Called when a navigation item is activated from the desktop bar or the
+     * mobile drawer. The item's full props object is passed as the argument.
+     */
     onItemClick?: ((item: NavItemProps<T> | NavItemCommonProps<T>) => void) | undefined;
+    /**
+     * Called when an action button without its own `onClick` handler is
+     * activated. The button's full props object is passed as the argument.
+     */
     onActionButtonClick?: ((actionButton: NavbarButtonProps) => void) | undefined;
-    /** Specifies if masthead should be rendered */
+    /**
+     * Renders the `Masthead` (SGDS official government banner) above the navbar.
+     *
+     * @default true
+     */
     masthead?: boolean | undefined;
+    /**
+     * Controls how the navbar content fills its container. `"stretch"` expands
+     * to the full container width; `"default"` uses the standard content width.
+     *
+     * @default "default"
+     */
     layout?: "default" | "stretch" | undefined;
-    /** Custom aria-label for the main navigation header */
+    /**
+     * Accessible label announced for the main navigation header.
+     *
+     * @default "Main navigation menu"
+     */
     headerLabel?: string | undefined;
-    /** Custom aria-label for the mobile navigation drawer */
+    /**
+     * Accessible label announced for the mobile navigation drawer.
+     */
     drawerLabel?: string | undefined;
 }
+export {};

package/notification-banner/notification-banner-hoc.d.ts

@@ -1,3 +1,9 @@
 import React from "react";
 import type { NotificationBannerWithForwardedRefProps, NotificationContentAttributes } from "./types";
+/**
+ * Higher-order component that wraps `NotificationBanner` and renders its
+ * content from a structured data array.
+ * *
+ * @param data Content items to render inside the banner.
+ */
 export declare const withNotificationBanner: (data: NotificationContentAttributes[]) => (props: NotificationBannerWithForwardedRefProps & React.RefAttributes<HTMLDivElement>) => React.ReactElement | null;

package/notification-banner/notification-banner-hoc.js.map

@@ -1 +1 @@
-{"version":3,"file":"notification-banner-hoc.js","sources":["../../src/notification-banner/notification-banner-hoc.tsx"],"sourcesContent":["import DOMPurify from \"dompurify\";\nimport React from \"react\";\n\nimport { NBComponent, NotificationBanner } from \"./notification-banner\";\nimport type {\n    ContentLinkAttributes,\n    ContentTextAttributes,\n    NotificationBannerWithForwardedRefProps,\n    NotificationContentAttributes,\n} from \"./types\";\n\nexport const withNotificationBanner = (\n    data: NotificationContentAttributes[]\n) => {\n    const ComponentToReturn = (\n        props: NotificationBannerWithForwardedRefProps,\n        ref: React.Ref<HTMLDivElement>\n    ) => {\n        const renderContent = () => {\n            if (data.length > 0) {\n                return data.map((attribute, index) => {\n                    if (attribute.type === \"text\") {\n                        const otherAttributes =\n                            attribute.otherAttributes as ContentTextAttributes;\n\n                        const sanitizedContent = DOMPurify.sanitize(\n                            attribute.content\n                        );\n                        return (\n                            <p\n                                key={index}\n                                {...otherAttributes}\n                                dangerouslySetInnerHTML={{\n                                    __html: sanitizedContent,\n                                }}\n                            />\n                        );\n                    } else {\n                        const otherAttributes =\n                            attribute.otherAttributes as ContentLinkAttributes;\n                        return (\n                            <NotificationBanner.Link\n                                key={index}\n                                {...otherAttributes}\n                            >\n                                {attribute.content}\n                            </NotificationBanner.Link>\n                        );\n                    }\n                });\n            }\n\n            console.error(\"[NotificationBannerHOC] Empty data passed\");\n            return null;\n        };\n\n        return (\n            <NBComponent forwardedRef={ref} {...props}>\n                {renderContent()}\n            </NBComponent>\n        );\n    };\n\n    return React.forwardRef(ComponentToReturn);\n};\n"],"names":["withNotificationBanner","data","React","forwardRef","props","ref","_jsx","NBComponent","Object","assign","forwardedRef","children","length","map","attribute","index","type","otherAttributes","sanitizedContent","DOMPurify","sanitize","content","dangerouslySetInnerHTML","__html","NotificationBanner","Link","console","error"],"mappings":"mMAWO,MAAMA,EACTC,GAmDOC,EAAMC,YAjDa,CACtBC,EACAC,IAyCIC,EAACC,EAAWC,OAAAC,OAAA,CAACC,aAAcL,GAASD,EAAK,CAAAO,SAtCrCV,EAAKW,OAAS,EACPX,EAAKY,KAAI,CAACC,EAAWC,KACxB,GAAuB,SAAnBD,EAAUE,KAAiB,CAC3B,MAAMC,EACFH,EAAUG,gBAERC,EAAmBC,EAAUC,SAC/BN,EAAUO,SAEd,OACIf,EAAA,IAAAE,OAAAC,OAAA,GAEQQ,EAAe,CACnBK,wBAAyB,CACrBC,OAAQL,KAHPH,EAOjB,CAAO,CACH,MAAME,EACFH,EAAUG,gBACd,OACIX,EAACkB,EAAmBC,KAAIjB,OAAAC,OAAA,CAAA,EAEhBQ,EAAe,CAAAN,SAElBG,EAAUO,UAHNN,EAMjB,MAIRW,QAAQC,MAAM,6CACP"}
+{"version":3,"file":"notification-banner-hoc.js","sources":["../../src/notification-banner/notification-banner-hoc.tsx"],"sourcesContent":["import DOMPurify from \"dompurify\";\nimport React from \"react\";\n\nimport { NBComponent, NotificationBanner } from \"./notification-banner\";\nimport type {\n    ContentLinkAttributes,\n    ContentTextAttributes,\n    NotificationBannerWithForwardedRefProps,\n    NotificationContentAttributes,\n} from \"./types\";\n\n/**\n * Higher-order component that wraps `NotificationBanner` and renders its\n * content from a structured data array.\n * *\n * @param data Content items to render inside the banner.\n */\nexport const withNotificationBanner = (\n    data: NotificationContentAttributes[]\n) => {\n    const ComponentToReturn = (\n        props: NotificationBannerWithForwardedRefProps,\n        ref: React.Ref<HTMLDivElement>\n    ) => {\n        const renderContent = () => {\n            if (data.length > 0) {\n                return data.map((attribute, index) => {\n                    if (attribute.type === \"text\") {\n                        const otherAttributes =\n                            attribute.otherAttributes as ContentTextAttributes;\n\n                        const sanitizedContent = DOMPurify.sanitize(\n                            attribute.content\n                        );\n                        return (\n                            <p\n                                key={index}\n                                {...otherAttributes}\n                                dangerouslySetInnerHTML={{\n                                    __html: sanitizedContent,\n                                }}\n                            />\n                        );\n                    } else {\n                        const otherAttributes =\n                            attribute.otherAttributes as ContentLinkAttributes;\n                        return (\n                            <NotificationBanner.Link\n                                key={index}\n                                {...otherAttributes}\n                            >\n                                {attribute.content}\n                            </NotificationBanner.Link>\n                        );\n                    }\n                });\n            }\n\n            console.error(\"[NotificationBannerHOC] Empty data passed\");\n            return null;\n        };\n\n        return (\n            <NBComponent forwardedRef={ref} {...props}>\n                {renderContent()}\n            </NBComponent>\n        );\n    };\n\n    return React.forwardRef(ComponentToReturn);\n};\n"],"names":["withNotificationBanner","data","React","forwardRef","props","ref","_jsx","NBComponent","Object","assign","forwardedRef","children","length","map","attribute","index","type","otherAttributes","sanitizedContent","DOMPurify","sanitize","content","dangerouslySetInnerHTML","__html","NotificationBanner","Link","console","error"],"mappings":"mMAiBO,MAAMA,EACTC,GAmDOC,EAAMC,YAjDa,CACtBC,EACAC,IAyCIC,EAACC,EAAWC,OAAAC,OAAA,CAACC,aAAcL,GAASD,EAAK,CAAAO,SAtCrCV,EAAKW,OAAS,EACPX,EAAKY,KAAI,CAACC,EAAWC,KACxB,GAAuB,SAAnBD,EAAUE,KAAiB,CAC3B,MAAMC,EACFH,EAAUG,gBAERC,EAAmBC,EAAUC,SAC/BN,EAAUO,SAEd,OACIf,EAAA,IAAAE,OAAAC,OAAA,GAEQQ,EAAe,CACnBK,wBAAyB,CACrBC,OAAQL,KAHPH,EAOjB,CAAO,CACH,MAAME,EACFH,EAAUG,gBACd,OACIX,EAACkB,EAAmBC,KAAIjB,OAAAC,OAAA,CAAA,EAEhBQ,EAAe,CAAAN,SAElBG,EAAUO,UAHNN,EAMjB,MAIRW,QAAQC,MAAM,6CACP"}

package/notification-banner/notification-banner.d.ts

@@ -1,8 +1,14 @@
 import React from "react";
 import type { NotificationBannerProps, NotificationBannerWithForwardedRefProps } from "./types";
-export declare const NBComponent: ({ children, visible, dismissible, sticky, onDismiss, id, forwardedRef, maxCollapsedHeight, onClick, actionButton, icon, ...otherProps }: NotificationBannerWithForwardedRefProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const NBComponent: ({ children, visible, dismissible, sticky, onDismiss, id, forwardedRef, maxCollapsedHeight, onClick, actionButton, icon, className, ...otherProps }: NotificationBannerWithForwardedRefProps) => import("react/jsx-runtime").JSX.Element | null;
+/**
+ * A full-width informational banner that sits at the top of the page.
+ *
+ * Use `NotificationBanner` to surface important or persistent messages that
+ * should remain visible until the user dismisses them.
+ * @keywords alert, announcement, banner, message
+ */
 export declare const NotificationBanner: ((props: NotificationBannerProps & React.RefAttributes<HTMLDivElement>) => React.ReactElement | null) & {
-    Link: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("..").TypographyLinkProps & {
-        ref?: React.RefObject<HTMLAnchorElement> | undefined;
-    }, never>> & string;
+    /** Renders an inline link styled for use inside a `NotificationBanner`. */
+    Link: (props: import("..").TypographyLinkProps & React.RefAttributes<HTMLAnchorElement>) => React.ReactElement | null;
 };

package/notification-banner/notification-banner.js

@@ -1,2 +1,2 @@
-import{__rest as i}from"../_virtual/_tslib.js";import{jsx as t,jsxs as e}from"react/jsx-runtime";import{CrossIcon as n}from"@lifesg/react-icons";import o,{useState as r,useEffect as s}from"react";import{useResizeDetector as a}from"../external/react-resize-detector/build/index.esm.js";import{ContentLink as l,Wrapper as c,Container as d,IconContainer as b,ContentContainer as m,Content as f,ContentWrapper as h,ContentText as p,StyledIconButton as u,AccessibleBannerButton as g,ActionButton as k}from"./notification-banner.styles.js";const C=o=>{var{children:l,visible:C=!0,dismissible:j=!0,sticky:y=!0,onDismiss:v,id:w,forwardedRef:O,maxCollapsedHeight:$,onClick:H,actionButton:R,icon:B}=o,D=i(o,["children","visible","dismissible","sticky","onDismiss","id","forwardedRef","maxCollapsedHeight","onClick","actionButton","icon"]);const N=D["data-testid"],[P,_]=r(C),{height:z=0,ref:I}=a();s((()=>{_(C)}),[C]);const L=i=>{i.stopPropagation(),_(!1),j&&v&&v()},q=i=>{(null==R?void 0:R.onClick)&&(i.stopPropagation(),R.onClick(i))};if(!P)return null;return e(c,Object.assign({ref:O,$sticky:y,$clickable:!!H,onClick:H,role:"region"},D,{children:[e(d,{id:x("container",w),children:[B&&t(b,{"aria-hidden":!0,children:B}),t(m,{children:t(f,{"data-testid":x("text-content",N),children:e(h,{children:[t(p,{$maxCollapsedHeight:$&&z>$?$:void 0,children:t("div",{ref:I,children:l})}),R?t(k,Object.assign({id:x("action-button",w),"data-testid":x("action-button",N),type:"button"},R,{onClick:q,children:R.children})):null]})})}),j&&t(u,{tabIndex:0,onClick:L,id:x("dismiss-button",w),"data-testid":x("dismiss-button",N),focusOutline:"browser",focusHighlight:!1,type:"button","aria-label":"close",children:t(n,{"aria-hidden":!0})})]}),H&&t(g,{"aria-label":"Clickable banner",type:"button"})]}))},x=(i,t="wrapper")=>`${t}-${i}`,j=o.forwardRef(((i,e)=>t(C,Object.assign({},i,{forwardedRef:e}))));j.displayName="NotificationBanner";const y=Object.assign(j,{Link:l});export{C as NBComponent,y as NotificationBanner};
+import{__rest as e}from"../_virtual/_tslib.js";import{jsx as i,jsxs as t}from"react/jsx-runtime";import{CrossIcon as s}from"@lifesg/react-icons";import o from"clsx";import r,{useState as n,useRef as a,useEffect as l}from"react";import{useResizeDetector as c}from"../external/react-resize-detector/build/index.esm.js";import{Layout as d}from"../layout/index.js";import{VisuallyHidden as m}from"../shared/accessibility/index.js";import{ClickableIcon as p}from"../shared/clickable-icon/clickable-icon.js";import"../theme/theme-provider/index.js";import{formatUnitValue as f}from"../theme/utils/css-variable.js";import"../theme/theme-provider/context.js";import"../theme/tokens/border.js";import"../theme/tokens/colour.js";import"../theme/tokens/font.js";import"../theme/tokens/media-query.js";import{useApplyStyle as h}from"../theme/utils/use-apply-styles.js";import"../theme/utils/use-media-query.js";import{Typography as u}from"../typography/index.js";import{contentLink as b,tokens as j,wrapper as k,wrapperSticky as x,wrapperClickable as g,iconContainer as v,contentContainer as y,content as N,contentWrapper as C,contentText as w,contentTextCollapsed as O,dismissButton as B,actionButton as R}from"./notification-banner.styles.js";const H=r=>{var{children:u,visible:b=!0,dismissible:H=!0,sticky:L=!0,onDismiss:D,id:P,forwardedRef:$,maxCollapsedHeight:_,onClick:z,actionButton:I,icon:T,className:A}=r,E=e(r,["children","visible","dismissible","sticky","onDismiss","id","forwardedRef","maxCollapsedHeight","onClick","actionButton","icon","className"]);const F=E["data-testid"],[G,J]=n(b),{height:K=0,ref:M}=c(),Q=a(null),S=_&&K>_;h(Q,{[j.contentText.maxCollapsedHeight]:S?f(_,"px"):void 0}),l((()=>{J(b)}),[b]);const U=e=>{e.stopPropagation(),J(!1),H&&D&&D()},V=e=>{(null==I?void 0:I.onClick)&&(e.stopPropagation(),I.onClick(e))};if(!G)return null;return t("div",Object.assign({ref:$,className:o(k,L&&x,!!z&&g,A),onClick:z,role:"region"},E,{children:[t(d.Content,{id:q("container",P),children:[T&&i("div",{className:v,"aria-hidden":!0,children:T}),i("div",{className:y,children:i("div",{className:N,"data-testid":q("text-content",F),children:t("div",{className:C,children:[i("div",{ref:Q,className:o(w,S&&O),children:i("div",{ref:M,children:u})}),I?i("button",Object.assign({className:R,id:q("action-button",P),"data-testid":q("action-button",F),type:"button"},I,{onClick:V,children:I.children})):null]})})}),H&&i(p,{className:B,tabIndex:0,onClick:U,id:q("dismiss-button",P),"data-testid":q("dismiss-button",F),focusOutline:"browser",focusHighlight:!1,type:"button","aria-label":"close",children:i(s,{"aria-hidden":!0})})]}),z&&i(m,{children:i("button",{"aria-label":"Clickable banner",type:"button"})})]}))},L=r.forwardRef((function(e,t){return i(u.LinkBL,Object.assign({ref:t,className:o(b,e.className)},e))}));L.displayName="NotificationBanner.Link";const q=(e,i="wrapper")=>`${i}-${e}`,D=r.forwardRef(((e,t)=>i(H,Object.assign({},e,{forwardedRef:t}))));D.displayName="NotificationBanner";const P=Object.assign(D,{Link:L});export{H as NBComponent,P as NotificationBanner};
 //# sourceMappingURL=notification-banner.js.map

package/notification-banner/notification-banner.js.map

@@ -1 +1 @@
-{"version":3,"file":"notification-banner.js","sources":["../../src/notification-banner/notification-banner.tsx"],"sourcesContent":["import { CrossIcon } from \"@lifesg/react-icons\";\nimport type { NamedExoticComponent } from \"react\";\nimport React, { useEffect, useState } from \"react\";\nimport { useResizeDetector } from \"react-resize-detector\";\n\nimport {\n    AccessibleBannerButton,\n    ActionButton,\n    Container,\n    Content,\n    ContentContainer,\n    ContentLink as NBLink,\n    ContentText,\n    ContentWrapper,\n    IconContainer,\n    StyledIconButton,\n    Wrapper,\n} from \"./notification-banner.styles\";\nimport type {\n    NotificationBannerProps,\n    NotificationBannerWithForwardedRefProps,\n} from \"./types\";\n\nexport const NBComponent = ({\n    children,\n    visible = true,\n    dismissible = true,\n    sticky = true,\n    onDismiss,\n    id,\n    forwardedRef,\n    maxCollapsedHeight,\n    onClick,\n    actionButton,\n    icon,\n    ...otherProps\n}: NotificationBannerWithForwardedRefProps) => {\n    // =============================================================================\n    // CONST, STATE, REF\n    // =============================================================================\n    const testId = otherProps[\"data-testid\"];\n\n    const [isVisible, setVisible] = useState<boolean>(visible);\n    const { height: contentHeight = 0, ref: contentRef } = useResizeDetector();\n\n    // =============================================================================\n    // EFFECTS\n    // =============================================================================\n    useEffect(() => {\n        setVisible(visible);\n    }, [visible]);\n\n    // =============================================================================\n    // EVENT HANDLERS\n    // =============================================================================\n    const handleDismiss = (event: React.MouseEvent<HTMLButtonElement>) => {\n        event.stopPropagation();\n        setVisible(false);\n\n        if (dismissible && onDismiss) onDismiss();\n    };\n\n    const handleActionButtonOnClick = (\n        event: React.MouseEvent<HTMLButtonElement>\n    ) => {\n        if (!actionButton?.onClick) {\n            // let it bubble\n            return;\n        }\n        event.stopPropagation();\n        actionButton.onClick(event);\n    };\n\n    // =============================================================================\n    // RENDER FUNCTIONS\n    // =============================================================================\n    if (!isVisible) return null;\n\n    const renderDismissButton = () => (\n        <StyledIconButton\n            tabIndex={0}\n            onClick={handleDismiss}\n            id={formatId(\"dismiss-button\", id)}\n            data-testid={formatId(\"dismiss-button\", testId)}\n            focusOutline=\"browser\"\n            focusHighlight={false}\n            type=\"button\"\n            aria-label=\"close\"\n        >\n            <CrossIcon aria-hidden />\n        </StyledIconButton>\n    );\n\n    const renderActionButton = () => {\n        if (!actionButton) return null;\n\n        return (\n            <ActionButton\n                id={formatId(\"action-button\", id)}\n                data-testid={formatId(\"action-button\", testId)}\n                type=\"button\"\n                {...actionButton}\n                onClick={handleActionButtonOnClick}\n            >\n                {actionButton.children}\n            </ActionButton>\n        );\n    };\n\n    const renderContent = () => (\n        <Content data-testid={formatId(\"text-content\", testId)}>\n            <ContentWrapper>\n                <ContentText\n                    $maxCollapsedHeight={\n                        maxCollapsedHeight && contentHeight > maxCollapsedHeight\n                            ? maxCollapsedHeight\n                            : undefined\n                    }\n                >\n                    <div ref={contentRef}>{children}</div>\n                </ContentText>\n                {renderActionButton()}\n            </ContentWrapper>\n        </Content>\n    );\n\n    const renderAccessibleBannerButton = () => (\n        <AccessibleBannerButton aria-label={\"Clickable banner\"} type=\"button\" />\n    );\n\n    return (\n        <Wrapper\n            ref={forwardedRef}\n            $sticky={sticky}\n            $clickable={!!onClick}\n            onClick={onClick}\n            role=\"region\"\n            {...otherProps}\n        >\n            <Container id={formatId(\"container\", id)}>\n                {icon && <IconContainer aria-hidden>{icon}</IconContainer>}\n                <ContentContainer>{renderContent()}</ContentContainer>\n                {dismissible && renderDismissButton()}\n            </Container>\n            {onClick && renderAccessibleBannerButton()}\n        </Wrapper>\n    );\n};\n\n/**\n * Intermediate component to handle passing the ref as a prop\n */\nconst NBWithRef = (\n    props: NotificationBannerProps,\n    ref: React.Ref<HTMLDivElement>\n) => {\n    return <NBComponent {...props} forwardedRef={ref} />;\n};\n\n// =============================================================================\n// HELPER FUNCTIONS\n// =============================================================================\nconst formatId = (componentName: string, id = \"wrapper\"): string => {\n    return `${id}-${componentName}`;\n};\n\n// =============================================================================\n// EXPORTABLE\n// =============================================================================\nconst Base = React.forwardRef(NBWithRef);\n(Base as NamedExoticComponent).displayName = \"NotificationBanner\";\nexport const NotificationBanner = Object.assign(Base, {\n    Link: NBLink,\n});\n"],"names":["NBComponent","_a","children","visible","dismissible","sticky","onDismiss","id","forwardedRef","maxCollapsedHeight","onClick","actionButton","icon","otherProps","__rest","testId","isVisible","setVisible","useState","height","contentHeight","ref","contentRef","useResizeDetector","useEffect","handleDismiss","event","stopPropagation","handleActionButtonOnClick","_jsxs","Wrapper","Object","assign","$sticky","$clickable","role","Container","formatId","_jsx","IconContainer","ContentContainer","Content","ContentWrapper","ContentText","$maxCollapsedHeight","undefined","ActionButton","type","StyledIconButton","tabIndex","focusOutline","focusHighlight","CrossIcon","AccessibleBannerButton","componentName","Base","React","forwardRef","props","displayName","NotificationBanner","Link","NBLink"],"mappings":"shBAuBO,MAAMA,EAAeC,IAAA,IAAAC,SACxBA,EAAQC,QACRA,GAAU,EAAIC,YACdA,GAAc,EAAIC,OAClBA,GAAS,EAAIC,UACbA,EAASC,GACTA,EAAEC,aACFA,EAAYC,mBACZA,EAAkBC,QAClBA,EAAOC,aACPA,EAAYC,KACZA,GAAIX,EACDY,EAAUC,EAAAb,EAZW,oIAiBxB,MAAMc,EAASF,EAAW,gBAEnBG,EAAWC,GAAcC,EAAkBf,IAC1CgB,OAAQC,EAAgB,EAAGC,IAAKC,GAAeC,IAKvDC,GAAU,KACNP,EAAWd,EAAQ,GACpB,CAACA,IAKJ,MAAMsB,EAAiBC,IACnBA,EAAMC,kBACNV,GAAW,GAEPb,GAAeE,GAAWA,GAAW,EAGvCsB,EACFF,KAEKf,aAAY,EAAZA,EAAcD,WAInBgB,EAAMC,kBACNhB,EAAaD,QAAQgB,GAAM,EAM/B,IAAKV,EAAW,OAAO,KAsDvB,OACIa,EAACC,EAAOC,OAAAC,OAAA,CACJX,IAAKb,EAAYyB,QACR5B,EAAM6B,aACDxB,EACdA,QAASA,EACTyB,KAAK,UACDtB,EAAU,CAAAX,SAAA,CAEd2B,EAACO,EAAS,CAAC7B,GAAI8B,EAAS,YAAa9B,GAAGL,SAAA,CACnCU,GAAQ0B,EAACC,EAAa,CAAA,eAAA,EAAArC,SAAcU,IACrC0B,EAACE,EAAgB,CAAAtC,SA/BzBoC,EAACG,EAAO,CAAA,cAAcJ,EAAS,eAAgBtB,GAAOb,SAClD2B,EAACa,EAAc,CAAAxC,SAAA,CACXoC,EAACK,EAAW,CAAAC,oBAEJnC,GAAsBW,EAAgBX,EAChCA,OACAoC,EAAS3C,SAGnBoC,EAAA,MAAA,CAAKjB,IAAKC,EAAUpB,SAAGA,MAzB9BS,EAGD2B,EAACQ,EAAYf,OAAAC,OAAA,CACTzB,GAAI8B,EAAS,gBAAiB9B,GAAG,cACpB8B,EAAS,gBAAiBtB,GACvCgC,KAAK,UACDpC,EAAY,CAChBD,QAASkB,WAERjB,EAAaT,YAVI,YAgDjBE,GA/DTkC,EAACU,EAAgB,CACbC,SAAU,EACVvC,QAASe,EACTlB,GAAI8B,EAAS,iBAAkB9B,GAAG,cACrB8B,EAAS,iBAAkBtB,GACxCmC,aAAa,UACbC,gBAAgB,EAChBJ,KAAK,SAAQ,aACF,QAAO7C,SAElBoC,EAACc,EAAS,CAAA,eAAA,SAuDT1C,GAjBL4B,EAACe,EAAsB,CAAA,aAAa,mBAAoBN,KAAK,cAkBnD,EAiBZV,EAAW,CAACiB,EAAuB/C,EAAK,YACnC,GAAGA,KAAM+C,IAMdC,EAAOC,EAAMC,YAjBD,CACdC,EACArC,IAEOiB,EAACtC,EAAW+B,OAAAC,OAAA,GAAK0B,GAAOlD,aAAca,OAchDkC,EAA8BI,YAAc,2BAChCC,EAAqB7B,OAAOC,OAAOuB,EAAM,CAClDM,KAAMC"}
+{"version":3,"file":"notification-banner.js","sources":["../../src/notification-banner/notification-banner.tsx"],"sourcesContent":["import { CrossIcon } from \"@lifesg/react-icons\";\nimport clsx from \"clsx\";\nimport type { NamedExoticComponent } from \"react\";\nimport React, { useEffect, useRef, useState } from \"react\";\nimport { useResizeDetector } from \"react-resize-detector\";\n\nimport { Layout } from \"../layout\";\nimport { VisuallyHidden } from \"../shared/accessibility\";\nimport { ClickableIcon } from \"../shared/clickable-icon\";\nimport { formatUnitValue, useApplyStyle } from \"../theme\";\nimport { Typography } from \"../typography\";\nimport * as styles from \"./notification-banner.styles\";\nimport type {\n    NotificationBannerProps,\n    NotificationBannerWithForwardedRefProps,\n} from \"./types\";\n\nexport const NBComponent = ({\n    children,\n    visible = true,\n    dismissible = true,\n    sticky = true,\n    onDismiss,\n    id,\n    forwardedRef,\n    maxCollapsedHeight,\n    onClick,\n    actionButton,\n    icon,\n    className,\n    ...otherProps\n}: NotificationBannerWithForwardedRefProps) => {\n    // =============================================================================\n    // CONST, STATE, REF\n    // =============================================================================\n    const testId = otherProps[\"data-testid\"];\n\n    const [isVisible, setVisible] = useState<boolean>(visible);\n    const { height: contentHeight = 0, ref: contentRef } = useResizeDetector();\n    const contentTextRef = useRef<HTMLDivElement>(null);\n\n    const isCollapsed =\n        maxCollapsedHeight && contentHeight > maxCollapsedHeight;\n\n    useApplyStyle(contentTextRef, {\n        [styles.tokens.contentText.maxCollapsedHeight]: isCollapsed\n            ? formatUnitValue(maxCollapsedHeight, \"px\")\n            : undefined,\n    });\n\n    // =============================================================================\n    // EFFECTS\n    // =============================================================================\n    useEffect(() => {\n        setVisible(visible);\n    }, [visible]);\n\n    // =============================================================================\n    // EVENT HANDLERS\n    // =============================================================================\n    const handleDismiss = (event: React.MouseEvent<HTMLButtonElement>) => {\n        event.stopPropagation();\n        setVisible(false);\n\n        if (dismissible && onDismiss) onDismiss();\n    };\n\n    const handleActionButtonOnClick = (\n        event: React.MouseEvent<HTMLButtonElement>\n    ) => {\n        if (!actionButton?.onClick) {\n            // let it bubble\n            return;\n        }\n        event.stopPropagation();\n        actionButton.onClick(event);\n    };\n\n    // =============================================================================\n    // RENDER FUNCTIONS\n    // =============================================================================\n    if (!isVisible) return null;\n\n    const renderDismissButton = () => (\n        <ClickableIcon\n            className={styles.dismissButton}\n            tabIndex={0}\n            onClick={handleDismiss}\n            id={formatId(\"dismiss-button\", id)}\n            data-testid={formatId(\"dismiss-button\", testId)}\n            focusOutline=\"browser\"\n            focusHighlight={false}\n            type=\"button\"\n            aria-label=\"close\"\n        >\n            <CrossIcon aria-hidden />\n        </ClickableIcon>\n    );\n\n    const renderActionButton = () => {\n        if (!actionButton) return null;\n\n        return (\n            <button\n                className={styles.actionButton}\n                id={formatId(\"action-button\", id)}\n                data-testid={formatId(\"action-button\", testId)}\n                type=\"button\"\n                {...actionButton}\n                onClick={handleActionButtonOnClick}\n            >\n                {actionButton.children}\n            </button>\n        );\n    };\n\n    const renderContent = () => (\n        <div\n            className={styles.content}\n            data-testid={formatId(\"text-content\", testId)}\n        >\n            <div className={styles.contentWrapper}>\n                <div\n                    ref={contentTextRef}\n                    className={clsx(\n                        styles.contentText,\n                        isCollapsed && styles.contentTextCollapsed\n                    )}\n                >\n                    <div ref={contentRef}>{children}</div>\n                </div>\n                {renderActionButton()}\n            </div>\n        </div>\n    );\n\n    const renderAccessibleBannerButton = () => (\n        <VisuallyHidden>\n            <button aria-label={\"Clickable banner\"} type=\"button\" />\n        </VisuallyHidden>\n    );\n\n    return (\n        <div\n            ref={forwardedRef}\n            className={clsx(\n                styles.wrapper,\n                sticky && styles.wrapperSticky,\n                !!onClick && styles.wrapperClickable,\n                className\n            )}\n            onClick={onClick}\n            role=\"region\"\n            {...otherProps}\n        >\n            <Layout.Content id={formatId(\"container\", id)}>\n                {icon && (\n                    <div className={styles.iconContainer} aria-hidden>\n                        {icon}\n                    </div>\n                )}\n                <div className={styles.contentContainer}>{renderContent()}</div>\n                {dismissible && renderDismissButton()}\n            </Layout.Content>\n            {onClick && renderAccessibleBannerButton()}\n        </div>\n    );\n};\n\n/**\n * Intermediate component to handle passing the ref as a prop\n */\nconst NBWithRef = (\n    props: NotificationBannerProps,\n    ref: React.Ref<HTMLDivElement>\n) => {\n    return <NBComponent {...props} forwardedRef={ref} />;\n};\n\nconst NBLink = React.forwardRef<\n    HTMLAnchorElement,\n    React.ComponentProps<typeof Typography.LinkBL>\n>(function NotificationBannerLink(props, ref) {\n    return (\n        <Typography.LinkBL\n            ref={ref}\n            className={clsx(styles.contentLink, props.className)}\n            {...props}\n        />\n    );\n});\n(NBLink as NamedExoticComponent).displayName = \"NotificationBanner.Link\";\n\n// =============================================================================\n// HELPER FUNCTIONS\n// =============================================================================\nconst formatId = (componentName: string, id = \"wrapper\"): string => {\n    return `${id}-${componentName}`;\n};\n\n// =============================================================================\n// EXPORTABLE\n// =============================================================================\nconst Base = React.forwardRef(NBWithRef);\n(Base as NamedExoticComponent).displayName = \"NotificationBanner\";\n\n// @catalog\n/**\n * A full-width informational banner that sits at the top of the page.\n *\n * Use `NotificationBanner` to surface important or persistent messages that\n * should remain visible until the user dismisses them.\n * @keywords alert, announcement, banner, message\n */\nexport const NotificationBanner = Object.assign(Base, {\n    /** Renders an inline link styled for use inside a `NotificationBanner`. */\n    Link: NBLink,\n});\n"],"names":["NBComponent","_a","children","visible","dismissible","sticky","onDismiss","id","forwardedRef","maxCollapsedHeight","onClick","actionButton","icon","className","otherProps","__rest","testId","isVisible","setVisible","useState","height","contentHeight","ref","contentRef","useResizeDetector","contentTextRef","useRef","isCollapsed","useApplyStyle","styles.tokens","contentText","formatUnitValue","undefined","useEffect","handleDismiss","event","stopPropagation","handleActionButtonOnClick","_jsxs","clsx","styles.wrapper","styles.wrapperSticky","styles.wrapperClickable","role","Layout","Content","formatId","_jsx","styles.iconContainer","styles.contentContainer","styles.content","styles.contentWrapper","styles.contentText","styles.contentTextCollapsed","Object","assign","styles.actionButton","type","ClickableIcon","styles.dismissButton","tabIndex","focusOutline","focusHighlight","CrossIcon","VisuallyHidden","NBLink","React","forwardRef","props","Typography","LinkBL","styles.contentLink","displayName","componentName","Base","NotificationBanner","Link"],"mappings":"itCAiBO,MAAMA,EAAeC,IAAA,IAAAC,SACxBA,EAAQC,QACRA,GAAU,EAAIC,YACdA,GAAc,EAAIC,OAClBA,GAAS,EAAIC,UACbA,EAASC,GACTA,EAAEC,aACFA,EAAYC,mBACZA,EAAkBC,QAClBA,EAAOC,aACPA,EAAYC,KACZA,EAAIC,UACJA,GAASZ,EACNa,EAAUC,EAAAd,EAbW,gJAkBxB,MAAMe,EAASF,EAAW,gBAEnBG,EAAWC,GAAcC,EAAkBhB,IAC1CiB,OAAQC,EAAgB,EAAGC,IAAKC,GAAeC,IACjDC,EAAiBC,EAAuB,MAExCC,EACFlB,GAAsBY,EAAgBZ,EAE1CmB,EAAcH,EAAgB,CAC1B,CAACI,EAAcC,YAAYrB,oBAAqBkB,EAC1CI,EAAgBtB,EAAoB,WACpCuB,IAMVC,GAAU,KACNf,EAAWf,EAAQ,GACpB,CAACA,IAKJ,MAAM+B,EAAiBC,IACnBA,EAAMC,kBACNlB,GAAW,GAEPd,GAAeE,GAAWA,GAAW,EAGvC+B,EACFF,KAEKxB,aAAY,EAAZA,EAAcD,WAInByB,EAAMC,kBACNzB,EAAaD,QAAQyB,GAAM,EAM/B,IAAKlB,EAAW,OAAO,KA6DvB,OACIqB,uBACIhB,IAAKd,EACLK,UAAW0B,EACPC,EACAnC,GAAUoC,IACR/B,GAAWgC,EACb7B,GAEJH,QAASA,EACTiC,KAAK,UACD7B,aAEJwB,EAACM,EAAOC,QAAO,CAACtC,GAAIuC,EAAS,YAAavC,GAAGL,SAAA,CACxCU,GACGmC,SAAKlC,UAAWmC,4BACXpC,IAGTmC,EAAA,MAAA,CAAKlC,UAAWoC,EAAuB/C,SA5C/C6C,EAAA,MAAA,CACIlC,UAAWqC,EAAc,cACZJ,EAAS,eAAgB9B,GAAOd,SAE7CoC,EAAA,MAAA,CAAKzB,UAAWsC,EAAqBjD,SAAA,CACjC6C,EAAA,MAAA,CACIzB,IAAKG,EACLZ,UAAW0B,EACPa,EACAzB,GAAe0B,GAClBnD,SAED6C,EAAA,MAAA,CAAKzB,IAAKC,EAAUrB,SAAGA,MA7B9BS,EAGDoC,EAAA,SAAAO,OAAAC,OAAA,CACI1C,UAAW2C,EACXjD,GAAIuC,EAAS,gBAAiBvC,iBACjBuC,EAAS,gBAAiB9B,GACvCyC,KAAK,UACD9C,EAAY,CAChBD,QAAS2B,EAAyBnC,SAEjCS,EAAaT,YAXI,YA8DjBE,GA9ET2C,EAACW,EAAa,CACV7C,UAAW8C,EACXC,SAAU,EACVlD,QAASwB,EACT3B,GAAIuC,EAAS,iBAAkBvC,GAAG,cACrBuC,EAAS,iBAAkB9B,GACxC6C,aAAa,UACbC,gBAAgB,EAChBL,KAAK,SAAQ,aACF,QAAOvD,SAElB6C,EAACgB,EAAS,CAAA,eAAA,SAqETrD,GA3BLqC,EAACiB,EAAc,CAAA9D,SACX6C,EAAA,SAAA,CAAA,aAAoB,mBAAoBU,KAAK,gBA2B3C,EAcRQ,EAASC,EAAMC,YAGnB,SAAgCC,EAAO9C,GACrC,OACIyB,EAACsB,EAAWC,OAAMhB,OAAAC,OAAA,CACdjC,IAAKA,EACLT,UAAW0B,EAAKgC,EAAoBH,EAAMvD,YACtCuD,GAGhB,IACCH,EAAgCO,YAAc,0BAK/C,MAAM1B,EAAW,CAAC2B,EAAuBlE,EAAK,YACnC,GAAGA,KAAMkE,IAMdC,EAAOR,EAAMC,YA/BD,CACdC,EACA9C,IAEOyB,EAAC/C,EAAWsD,OAAAC,OAAA,GAAKa,GAAO5D,aAAcc,OA4BhDoD,EAA8BF,YAAc,2BAUhCG,EAAqBrB,OAAOC,OAAOmB,EAAM,CAElDE,KAAMX"}

package/notification-banner/notification-banner.styles.d.ts

@@ -1,23 +1,17 @@
-interface WrapperStyleProps {
-    $sticky: boolean;
-    $clickable: boolean;
-}
-interface ContentStyleProps {
-    $maxCollapsedHeight?: number;
-}
-export declare const Wrapper: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, WrapperStyleProps>> & string;
-export declare const Container: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("..").ContentProps & import("react").RefAttributes<HTMLDivElement>, never>> & string & Omit<(props: import("..").ContentProps & import("react").RefAttributes<HTMLDivElement>) => React.ReactElement | null, keyof import("react").Component<any, {}, any>>;
-export declare const ContentContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
-export declare const Content: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, ContentStyleProps>> & string;
-export declare const ContentWrapper: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
-export declare const ContentText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
-    $maxCollapsedHeight?: number;
-}>> & string;
-export declare const ContentLink: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("..").TypographyLinkProps & {
-    ref?: import("react").RefObject<HTMLAnchorElement> | undefined;
-}, never>> & string;
-export declare const StyledIconButton: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("../shared/clickable-icon").ClickableIconProps & import("react").RefAttributes<HTMLButtonElement>, never>> & string & Omit<(props: import("../shared/clickable-icon").ClickableIconProps & import("react").RefAttributes<HTMLButtonElement>) => React.ReactElement | null, keyof import("react").Component<any, {}, any>>;
-export declare const ActionButton: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, never>> & string;
-export declare const AccessibleBannerButton: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, never>> & string;
-export declare const IconContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
-export {};
+export declare const tokens: {
+    contentText: {
+        maxCollapsedHeight: string;
+    };
+};
+export declare const wrapper: import("@linaria/core").LinariaClassName;
+export declare const wrapperSticky: import("@linaria/core").LinariaClassName;
+export declare const wrapperClickable: import("@linaria/core").LinariaClassName;
+export declare const contentContainer: import("@linaria/core").LinariaClassName;
+export declare const content: import("@linaria/core").LinariaClassName;
+export declare const contentWrapper: import("@linaria/core").LinariaClassName;
+export declare const contentText: import("@linaria/core").LinariaClassName;
+export declare const contentTextCollapsed: import("@linaria/core").LinariaClassName;
+export declare const contentLink: import("@linaria/core").LinariaClassName;
+export declare const dismissButton: import("@linaria/core").LinariaClassName;
+export declare const actionButton: import("@linaria/core").LinariaClassName;
+export declare const iconContainer: import("@linaria/core").LinariaClassName;