@zendeskgarden/react-chrome 8.49.0 → 8.49.3

package/dist/typings/elements/subnav/SubNavItem.d.ts

@@ -4,11 +4,8 @@
  * Use of this source code is governed under the Apache License, Version 2.0
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
-import React, { ButtonHTMLAttributes } from 'react';
-export interface ISubNavItemProps extends ButtonHTMLAttributes<HTMLButtonElement> {
-    /** Indicates that the item is current in the subnav */
-    isCurrent?: boolean;
-}
+import React from 'react';
+import { ISubNavItemProps } from '../../types';
 /**
  * @extends ButtonHTMLAttributes<HTMLButtonElement>
  */

package/dist/typings/elements/subnav/SubNavItemText.d.ts

@@ -4,14 +4,8 @@
  * Use of this source code is governed under the Apache License, Version 2.0
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
-import React, { HTMLAttributes } from 'react';
-export interface ISubNavItemTextProps extends HTMLAttributes<HTMLSpanElement> {
-    /**
-     * Wraps overflow item text instead of truncating long strings with an ellipsis.
-     * Use when `max-width` styling is applied to the subnav container.
-     **/
-    isWrapped?: boolean;
-}
+import React from 'react';
+import { ISubNavItemTextProps } from '../../types';
 /**
  * @extends HTMLAttributes<HTMLSpanElement>
  */

package/dist/typings/index.d.ts

@@ -5,40 +5,28 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 export { Chrome } from './elements/Chrome';
-export type { IChromeProps } from './elements/Chrome';
 export { SkipNav } from './elements/SkipNav';
-export type { ISkipNavProps } from './elements/SkipNav';
 export { Body } from './elements/body/Body';
-export type { IBodyProps } from './elements/body/Body';
 export { Content } from './elements/body/Content';
 export { Main } from './elements/body/Main';
 export { Sidebar } from './elements/body/Sidebar';
 export { Header } from './elements/header/Header';
-export type { IHeaderProps } from './elements/header/Header';
 export { HeaderItem } from './elements/header/HeaderItem';
-export type { IHeaderItemProps } from './elements/header/HeaderItem';
 export { HeaderItemIcon } from './elements/header/HeaderItemIcon';
 export { HeaderItemText } from './elements/header/HeaderItemText';
-export type { IHeaderItemTextProps } from './elements/header/HeaderItemText';
 export { HeaderItemWrapper } from './elements/header/HeaderItemWrapper';
-export type { IHeaderItemWrapperProps } from './elements/header/HeaderItemWrapper';
 export { Footer } from './elements/footer/Footer';
 export { FooterItem } from './elements/footer/FooterItem';
 export { Nav } from './elements/nav/Nav';
-export type { INavProps } from './elements/nav/Nav';
 export { NavItem } from './elements/nav/NavItem';
-export type { INavItemProps } from './elements/nav/NavItem';
 export { NavItemIcon } from './elements/nav/NavItemIcon';
 export { NavItemText } from './elements/nav/NavItemText';
-export type { INavItemTextProps } from './elements/nav/NavItemText';
 export { SubNav } from './elements/subnav/SubNav';
 export { SubNavItem } from './elements/subnav/SubNavItem';
-export type { ISubNavItemProps } from './elements/subnav/SubNavItem';
 export { SubNavItemText } from './elements/subnav/SubNavItemText';
-export type { ISubNavItemTextProps } from './elements/subnav/SubNavItemText';
 export { CollapsibleSubNavItem } from './elements/subnav/CollapsibleSubNavItem';
-export type { ICollapsibleSubNavItemProps } from './elements/subnav/CollapsibleSubNavItem';
 export { Sheet } from './elements/sheet/Sheet';
-export type { ISheetProps } from './elements/sheet/Sheet';
-export type { ISheetFooterProps } from './elements/sheet/components/Footer';
-export { PRODUCT, PRODUCTS } from './utils/types';
+export { PRODUCT as PRODUCTS } from './types';
+export type { IChromeProps, ISkipNavProps, IBodyProps, IHeaderProps, IHeaderItemProps, IHeaderItemTextProps, IHeaderItemWrapperProps, INavProps, INavItemProps, INavItemTextProps, ISubNavItemProps, ICollapsibleSubNavItemProps, ISheetProps, ISheetFooterProps, 
+/** @deprecated can be accessed via IHeaderItemProps['product'] */
+Product as PRODUCT } from './types';

package/dist/typings/styled/header/StyledLogoHeaderItem.d.ts

@@ -4,9 +4,9 @@
  * Use of this source code is governed under the Apache License, Version 2.0
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
-import { PRODUCT } from '../../utils/types';
+import { Product } from '../../types';
 export interface IStyledLogoHeaderItemProps {
-    product?: PRODUCT;
+    product?: Product;
 }
 /**
  * 1. Anchor reset

package/dist/typings/styled/index.d.ts

@@ -14,32 +14,23 @@ export { StyledSidebar } from './body/StyledSidebar';
 export { StyledFooter } from './footer/StyledFooter';
 export { StyledFooterItem } from './footer/StyledFooterItem';
 export { StyledHeader } from './header/StyledHeader';
-export type { IStyledHeaderProps } from './header/StyledHeader';
 export { StyledBaseHeaderItem } from './header/StyledBaseHeaderItem';
-export type { IStyledBaseHeaderItemProps } from './header/StyledBaseHeaderItem';
 export { StyledHeaderItem } from './header/StyledHeaderItem';
 export { StyledHeaderItemIcon } from './header/StyledHeaderItemIcon';
 export { StyledLogoHeaderItem } from './header/StyledLogoHeaderItem';
-export type { IStyledLogoHeaderItemProps } from './header/StyledLogoHeaderItem';
 export { StyledHeaderItemText } from './header/StyledHeaderItemText';
-export type { IStyledHeaderItemTextProps } from './header/StyledHeaderItemText';
 export { StyledHeaderItemWrapper } from './header/StyledHeaderItemWrapper';
 export { StyledNav } from './nav/StyledNav';
 export { StyledBaseNavItem } from './nav/StyledBaseNavItem';
 export { StyledLogoNavItem } from './nav/StyledLogoNavItem';
-export type { IStyledLogoNavItemProps } from './nav/StyledLogoNavItem';
 export { StyledBrandmarkNavItem } from './nav/StyledBrandmarkNavItem';
 export { StyledNavItem } from './nav/StyledNavItem';
 export { StyledNavItemIcon } from './nav/StyledNavItemIcon';
 export { StyledNavItemText } from './nav/StyledNavItemText';
-export type { IStyledNavItemTextProps } from './nav/StyledNavItemText';
 export { StyledSubNav } from './subnav/StyledSubNav';
 export { StyledSubNavItem } from './subnav/StyledSubNavItem';
-export type { IStyledSubNavItemProps } from './subnav/StyledSubNavItem';
 export { StyledSubNavItemText } from './subnav/StyledSubNavItemText';
-export type { IStyledSubNavItemTextProps } from './subnav/StyledSubNavItemText';
 export { StyledSubNavItemHeader } from './subnav/StyledSubNavItemHeader';
-export type { IStyledSubNavItemHeaderProps } from './subnav/StyledSubNavItemHeader';
 export { StyledSubNavItemIconWrapper, StyledSubNavItemIcon } from './subnav/StyledSubNavItemIcon';
 export { StyledSubNavPanel } from './subnav/StyledSubNavPanel';
 export { StyledSheet } from './sheet/StyledSheet';
@@ -49,6 +40,5 @@ export { StyledSheetDescription } from './sheet/StyledSheetDescription';
 export { StyledSheetBody } from './sheet/StyledSheetBody';
 export { StyledSheetClose } from './sheet/StyledSheetClose';
 export { StyledSheetFooter } from './sheet/StyledSheetFooter';
-export type { IStyledSheetFooterProps } from './sheet/StyledSheetFooter';
 export { StyledSheetFooterItem } from './sheet/StyledSheetFooterItem';
 export { StyledSheetHeader } from './sheet/StyledSheetHeader';

package/dist/typings/styled/nav/StyledLogoNavItem.d.ts

@@ -5,9 +5,9 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 import { ThemeProps, DefaultTheme } from 'styled-components';
-import { PRODUCT } from '../../utils/types';
+import { Product } from '../../types';
 export interface IStyledLogoNavItemProps extends ThemeProps<DefaultTheme> {
-    product?: PRODUCT;
+    product?: Product;
     isDark?: boolean;
     isLight?: boolean;
 }

package/dist/typings/styled/sheet/StyledSheet.d.ts

@@ -5,8 +5,9 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 import { DefaultTheme } from 'styled-components';
+import { ISheetProps } from '../../types';
 interface IStyledSheetProps {
-    placement?: 'start' | 'end';
+    placement?: ISheetProps['placement'];
     isOpen?: boolean;
     isAnimated?: boolean;
     size?: string;

package/dist/typings/styled/sheet/StyledSheetClose.d.ts

@@ -5,7 +5,7 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 import { ThemeProps, DefaultTheme } from 'styled-components';
-export declare const baseMultipliers: {
+export declare const BASE_MULTIPLIERS: {
     top: number;
     side: number;
     size: number;

package/dist/typings/styled/sheet/StyledSheetHeader.d.ts

@@ -8,6 +8,10 @@ import { ThemeProps, DefaultTheme } from 'styled-components';
 export interface IStyledSheetHeaderProps {
     isCloseButtonPresent?: boolean;
 }
+/**
+ * 1. the padding size accounts for 40px (10 base units) size of the button,
+ *    8px additional padding and 8px padding for the button position from a given side.
+ */
 export declare const StyledSheetHeader: import("styled-components").StyledComponent<"header", DefaultTheme, {
     'data-garden-id': string;
     'data-garden-version': string;

package/dist/typings/styled/sheet/StyledSheetWrapper.d.ts

@@ -5,10 +5,11 @@
  * found at http://www.apache.org/licenses/LICENSE-2.0.
  */
 import { ThemeProps, DefaultTheme } from 'styled-components';
+import { ISheetProps } from '../../types';
 interface IStyledSheetWrapperProps {
     isOpen?: boolean;
     isAnimated?: boolean;
-    placement?: 'start' | 'end';
+    placement?: ISheetProps['placement'];
     size?: string;
 }
 export declare const StyledSheetWrapper: import("styled-components").StyledComponent<"div", DefaultTheme, {

package/dist/typings/types/index.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Copyright Zendesk, Inc.
+ *
+ * Use of this source code is governed under the Apache License, Version 2.0
+ * found at http://www.apache.org/licenses/LICENSE-2.0.
+ */
+import { AnchorHTMLAttributes, ButtonHTMLAttributes, HTMLAttributes, ReactNode } from 'react';
+export declare const PLACEMENT: readonly ["end", "start"];
+export declare const PRODUCT: readonly ["chat", "connect", "explore", "guide", "message", "support", "talk"];
+export declare type Product = typeof PRODUCT[number];
+export interface IChromeProps extends HTMLAttributes<HTMLDivElement> {
+    /** Applies a custom hue to the chrome navigation */
+    hue?: string;
+    /** Prevents fixed positioning from being applied to the `<html>` element */
+    isFluid?: boolean;
+}
+export interface ISkipNavProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
+    /** Sets the ID of the element to navigate to */
+    targetId: string;
+    /** Sets the `z-index` of the element */
+    zIndex?: number;
+}
+export interface IBodyProps extends HTMLAttributes<HTMLDivElement> {
+    /** Adjusts the body content height to allow space for a footer component */
+    hasFooter?: boolean;
+}
+export interface IHeaderProps extends HTMLAttributes<HTMLElement> {
+    /** Displays logo for standlone usage  */
+    isStandalone?: boolean;
+}
+export interface IHeaderItemProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    /** Maximizes the width of a flex item in the header */
+    maxX?: boolean;
+    /** Maximizes the height of the item (i.e. contains a search input) */
+    maxY?: boolean;
+    /** Rounds the border radius of the item */
+    isRound?: boolean;
+    /**
+     * Applies a
+     * [brand color](/design/color#brand-colors)
+     * to the product logo
+     */
+    product?: Product;
+    /** Applies header logo styles to the item */
+    hasLogo?: boolean;
+}
+export interface IHeaderItemTextProps extends HTMLAttributes<HTMLElement> {
+    /** Hides item text. Text remains accessible to screen readers. */
+    isClipped?: boolean;
+}
+export interface IHeaderItemWrapperProps extends HTMLAttributes<HTMLDivElement> {
+    /** Maximizes the width of a flex item in the header */
+    maxX?: boolean;
+    /** Maximizes the height of the item (i.e. contains a search input) */
+    maxY?: boolean;
+    /** Rounds the border radius of the item */
+    isRound?: boolean;
+}
+export interface INavProps extends HTMLAttributes<HTMLElement> {
+    /** Expands the nav area to display the item text */
+    isExpanded?: boolean;
+}
+export interface INavItemProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    /** Applies a product-specific color palette */
+    product?: Product;
+    /** Indicates that the item is current in the nav */
+    isCurrent?: boolean;
+    /** Indicates that the item contains a product logo */
+    hasLogo?: boolean;
+    /** Indicates that the item contains the company brandmark */
+    hasBrandmark?: boolean;
+}
+export interface INavItemTextProps extends HTMLAttributes<HTMLSpanElement> {
+    /** Wraps overflow item text instead of truncating long strings with an ellipsis */
+    isWrapped?: boolean;
+}
+export interface ISubNavItemProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    /** Indicates that the item is current in the subnav */
+    isCurrent?: boolean;
+}
+export interface ISubNavItemTextProps extends HTMLAttributes<HTMLSpanElement> {
+    /**
+     * Wraps overflow item text instead of truncating long strings with an ellipsis.
+     * Use when `max-width` styling is applied to the subnav container.
+     */
+    isWrapped?: boolean;
+}
+export interface ICollapsibleSubNavItemProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'onChange'> {
+    /** Sets the item's section header */
+    header?: ReactNode;
+    /** Reveals the item's section */
+    isExpanded?: boolean;
+    /**
+     * Handles changes in the item's expansion state
+     *
+     * @param {boolean} isExpanded An item's expansion state
+     */
+    onChange?: (isExpanded: boolean) => void;
+}
+export interface ISheetProps extends HTMLAttributes<HTMLElement> {
+    /** Opens the sheet */
+    isOpen?: boolean;
+    /** Determines whether animation for opening and closing the sheet is used */
+    isAnimated?: boolean;
+    /** Directs keyboard focus to the sheet on mount */
+    focusOnMount?: boolean;
+    /** Returns keyboard focus to the element that triggered the sheet */
+    restoreFocus?: boolean;
+    /** Adjusts the placement of the sheet */
+    placement?: typeof PLACEMENT[number];
+    /** Sets the size of the open sheet */
+    size?: string;
+}
+export interface ISheetFooterProps extends HTMLAttributes<HTMLElement> {
+    /** Applies compact styling and centers the elements */
+    isCompact?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/react-chrome",
-  "version": "8.49.0",
+  "version": "8.49.3",
   "description": "Components relating to Chrome within the Garden Design System.",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -35,8 +35,8 @@
     "styled-components": "^4.2.0 || ^5.0.0"
   },
   "devDependencies": {
-    "@zendeskgarden/react-theming": "^8.49.0",
-    "@zendeskgarden/svg-icons": "6.30.2"
+    "@zendeskgarden/react-theming": "^8.49.3",
+    "@zendeskgarden/svg-icons": "6.31.1"
   },
   "keywords": [
     "components",
@@ -48,5 +48,5 @@
     "access": "public"
   },
   "zendeskgarden:src": "src/index.ts",
-  "gitHead": "9c2b7501c2b0100f23fa3715a4d3b0d413645d99"
+  "gitHead": "983322364971c051ca6ce478770edfc3310e4c4b"
 }

package/dist/typings/utils/types.d.ts

@@ -1,8 +0,0 @@
-/**
- * Copyright Zendesk, Inc.
- *
- * Use of this source code is governed under the Apache License, Version 2.0
- * found at http://www.apache.org/licenses/LICENSE-2.0.
- */
-export declare type PRODUCT = 'chat' | 'connect' | 'explore' | 'guide' | 'message' | 'support' | 'talk';
-export declare const PRODUCTS: PRODUCT[];