npm - @zendeskgarden/react-chrome - Versions diffs - 8.69.2 → 8.69.3 - Mend

@zendeskgarden/react-chrome 8.69.2 → 8.69.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

package/dist/index.cjs.js +42 -57
package/dist/index.esm.js +40 -56
package/dist/typings/elements/Chrome.d.ts +12 -12
package/dist/typings/elements/SkipNav.d.ts +12 -12
package/dist/typings/elements/body/Body.d.ts +12 -12
package/dist/typings/elements/body/Content.d.ts +11 -11
package/dist/typings/elements/body/Main.d.ts +11 -11
package/dist/typings/elements/body/Sidebar.d.ts +11 -11
package/dist/typings/elements/footer/Footer.d.ts +11 -11
package/dist/typings/elements/footer/FooterItem.d.ts +11 -11
package/dist/typings/elements/header/Header.d.ts +12 -12
package/dist/typings/elements/header/HeaderItem.d.ts +12 -12
package/dist/typings/elements/header/HeaderItemIcon.d.ts +11 -11
package/dist/typings/elements/header/HeaderItemText.d.ts +12 -12
package/dist/typings/elements/header/HeaderItemWrapper.d.ts +12 -12
package/dist/typings/elements/nav/Nav.d.ts +12 -12
package/dist/typings/elements/nav/NavItem.d.ts +12 -12
package/dist/typings/elements/nav/NavItemIcon.d.ts +11 -11
package/dist/typings/elements/nav/NavItemText.d.ts +12 -12
package/dist/typings/elements/sheet/Sheet.d.ts +27 -27
package/dist/typings/elements/sheet/components/Body.d.ts +11 -11
package/dist/typings/elements/sheet/components/Close.d.ts +11 -11
package/dist/typings/elements/sheet/components/Description.d.ts +11 -11
package/dist/typings/elements/sheet/components/Footer.d.ts +12 -12
package/dist/typings/elements/sheet/components/FooterItem.d.ts +11 -11
package/dist/typings/elements/sheet/components/Header.d.ts +11 -11
package/dist/typings/elements/sheet/components/Title.d.ts +11 -11
package/dist/typings/elements/subnav/CollapsibleSubNavItem.d.ts +12 -12
package/dist/typings/elements/subnav/SubNav.d.ts +11 -11
package/dist/typings/elements/subnav/SubNavItem.d.ts +12 -12
package/dist/typings/elements/subnav/SubNavItemText.d.ts +12 -12
package/dist/typings/index.d.ts +32 -32
package/dist/typings/styled/StyledChrome.d.ts +13 -13
package/dist/typings/styled/StyledSkipNav.d.ts +18 -18
package/dist/typings/styled/StyledSkipNavIcon.d.ts +11 -11
package/dist/typings/styled/body/StyledBody.d.ts +10 -10
package/dist/typings/styled/body/StyledContent.d.ts +14 -14
package/dist/typings/styled/body/StyledMain.d.ts +10 -10
package/dist/typings/styled/body/StyledSidebar.d.ts +10 -10
package/dist/typings/styled/footer/StyledFooter.d.ts +12 -12
package/dist/typings/styled/footer/StyledFooterItem.d.ts +13 -13
package/dist/typings/styled/header/StyledBaseHeaderItem.d.ts +21 -21
package/dist/typings/styled/header/StyledHeader.d.ts +12 -12
package/dist/typings/styled/header/StyledHeaderItem.d.ts +15 -15
package/dist/typings/styled/header/StyledHeaderItemIcon.d.ts +13 -13
package/dist/typings/styled/header/StyledHeaderItemText.d.ts +11 -11
package/dist/typings/styled/header/StyledHeaderItemWrapper.d.ts +11 -11
package/dist/typings/styled/header/StyledLogoHeaderItem.d.ts +21 -21
package/dist/typings/styled/index.d.ts +44 -44
package/dist/typings/styled/nav/StyledBaseNavItem.d.ts +16 -16
package/dist/typings/styled/nav/StyledBrandmarkNavItem.d.ts +14 -14
package/dist/typings/styled/nav/StyledLogoNavItem.d.ts +21 -21
package/dist/typings/styled/nav/StyledNav.d.ts +17 -17
package/dist/typings/styled/nav/StyledNavItem.d.ts +26 -26
package/dist/typings/styled/nav/StyledNavItemIcon.d.ts +13 -13
package/dist/typings/styled/nav/StyledNavItemText.d.ts +11 -11
package/dist/typings/styled/sheet/StyledSheet.d.ts +19 -19
package/dist/typings/styled/sheet/StyledSheetBody.d.ts +10 -10
package/dist/typings/styled/sheet/StyledSheetClose.d.ts +16 -16
package/dist/typings/styled/sheet/StyledSheetDescription.d.ts +11 -11
package/dist/typings/styled/sheet/StyledSheetFooter.d.ts +15 -15
package/dist/typings/styled/sheet/StyledSheetFooterItem.d.ts +11 -11
package/dist/typings/styled/sheet/StyledSheetHeader.d.ts +18 -18
package/dist/typings/styled/sheet/StyledSheetTitle.d.ts +11 -11
package/dist/typings/styled/sheet/StyledSheetWrapper.d.ts +19 -19
package/dist/typings/styled/subnav/StyledSubNav.d.ts +17 -17
package/dist/typings/styled/subnav/StyledSubNavItem.d.ts +21 -21
package/dist/typings/styled/subnav/StyledSubNavItemHeader.d.ts +14 -14
package/dist/typings/styled/subnav/StyledSubNavItemIcon.d.ts +14 -14
package/dist/typings/styled/subnav/StyledSubNavItemText.d.ts +11 -11
package/dist/typings/styled/subnav/StyledSubNavPanel.d.ts +12 -12
package/dist/typings/types/index.d.ts +117 -117
package/dist/typings/utils/useBodyContext.d.ts +13 -13
package/dist/typings/utils/useChromeContext.d.ts +15 -15
package/dist/typings/utils/useFocusableMount.d.ts +14 -14
package/dist/typings/utils/useNavContext.d.ts +13 -13
package/dist/typings/utils/useSheetContext.d.ts +15 -15
package/package.json +3 -3

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

@@ -1,117 +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 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;
-}
+/**
+ * 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 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/dist/typings/utils/useBodyContext.d.ts CHANGED Viewed

@@ -1,13 +1,13 @@
-/**
- * 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 React from 'react';
-interface IBodyContext {
-    hasFooter: boolean;
-}
-export declare const BodyContext: React.Context<IBodyContext>;
-export declare const useBodyContext: () => IBodyContext;
-export {};
+/**
+ * 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 React from 'react';
+interface IBodyContext {
+    hasFooter: boolean;
+}
+export declare const BodyContext: React.Context<IBodyContext>;
+export declare const useBodyContext: () => IBodyContext;
+export {};

package/dist/typings/utils/useChromeContext.d.ts CHANGED Viewed

@@ -1,15 +1,15 @@
-/**
- * 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 React from 'react';
-interface IChromeContext {
-    hue: string;
-    isLight?: boolean;
-    isDark?: boolean;
-}
-export declare const ChromeContext: React.Context<IChromeContext>;
-export declare const useChromeContext: () => IChromeContext;
-export {};
+/**
+ * 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 React from 'react';
+interface IChromeContext {
+    hue: string;
+    isLight?: boolean;
+    isDark?: boolean;
+}
+export declare const ChromeContext: React.Context<IChromeContext>;
+export declare const useChromeContext: () => IChromeContext;
+export {};

package/dist/typings/utils/useFocusableMount.d.ts CHANGED Viewed

@@ -1,14 +1,14 @@
-/**
- * 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 { MutableRefObject } from 'react';
-export interface IUseFocusableMountProp {
-    isMounted?: boolean;
-    focusOnMount?: boolean;
-    restoreFocus?: boolean;
-    targetRef: MutableRefObject<HTMLElement | null>;
-}
-export declare function useFocusableMount({ isMounted, focusOnMount, restoreFocus, targetRef }: IUseFocusableMountProp): void;
+/**
+ * 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 { MutableRefObject } from 'react';
+export interface IUseFocusableMountProp {
+    isMounted?: boolean;
+    focusOnMount?: boolean;
+    restoreFocus?: boolean;
+    targetRef: MutableRefObject<HTMLElement | null>;
+}
+export declare function useFocusableMount({ isMounted, focusOnMount, restoreFocus, targetRef }: IUseFocusableMountProp): void;

package/dist/typings/utils/useNavContext.d.ts CHANGED Viewed

@@ -1,13 +1,13 @@
-/**
- * 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 React from 'react';
-interface INavContext {
-    isExpanded: boolean;
-}
-export declare const NavContext: React.Context<INavContext>;
-export declare const useNavContext: () => INavContext;
-export {};
+/**
+ * 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 React from 'react';
+interface INavContext {
+    isExpanded: boolean;
+}
+export declare const NavContext: React.Context<INavContext>;
+export declare const useNavContext: () => INavContext;
+export {};

package/dist/typings/utils/useSheetContext.d.ts CHANGED Viewed

@@ -1,15 +1,15 @@
-/**
- * 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.
- */
-/// <reference types="react" />
-export interface ISheetContext {
-    titleId?: string;
-    descriptionId?: string;
-    isCloseButtonPresent?: boolean;
-    setIsCloseButtonPresent: (isPresent: boolean) => void;
-}
-export declare const SheetContext: import("react").Context<ISheetContext>;
-export declare const useSheetContext: () => ISheetContext;
+/**
+ * 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.
+ */
+/// <reference types="react" />
+export interface ISheetContext {
+    titleId?: string;
+    descriptionId?: string;
+    isCloseButtonPresent?: boolean;
+    setIsCloseButtonPresent: (isPresent: boolean) => void;
+}
+export declare const SheetContext: import("react").Context<ISheetContext>;
+export declare const useSheetContext: () => ISheetContext;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/react-chrome",
-  "version": "8.69.2",
+  "version": "8.69.3",
   "description": "Components relating to Chrome within the Garden Design System.",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -35,7 +35,7 @@
     "styled-components": "^4.2.0 || ^5.0.0"
   },
   "devDependencies": {
-    "@zendeskgarden/react-theming": "^8.69.2",
+    "@zendeskgarden/react-theming": "^8.69.3",
     "@zendeskgarden/svg-icons": "6.33.0"
   },
   "keywords": [
@@ -48,5 +48,5 @@
     "access": "public"
   },
   "zendeskgarden:src": "src/index.ts",
-  "gitHead": "a39f2b421375013a50990d206610e3813abc0bd7"
+  "gitHead": "c861fbeb70120b66b05d2ce3a26ccf3047659aa0"
 }