@zendeskgarden/react-chrome 8.46.0 → 8.47.0

package/dist/typings/elements/sheet/Sheet.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { HTMLAttributes, PropsWithoutRef, RefAttributes, ForwardRefExoticComponent } from 'react';
+import { SheetTitle } from './components/Title';
+import { SheetDescription } from './components/Description';
+import { SheetHeader } from './components/Header';
+import { SheetBody } from './components/Body';
+import { SheetFooter } from './components/Footer';
+import { SheetFooterItem } from './components/FooterItem';
+import { SheetClose } from './components/Close';
+interface IStaticSheetExport<T, P> extends ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>> {
+    Title: typeof SheetTitle;
+    Description: typeof SheetDescription;
+    Header: typeof SheetHeader;
+    Body: typeof SheetBody;
+    Footer: typeof SheetFooter;
+    FooterItem: typeof SheetFooterItem;
+    Close: typeof SheetClose;
+}
+export interface ISheetProps extends HTMLAttributes<HTMLElement> {
+    /** Opens the Sheet **/
+    isOpen?: boolean;
+    /** Determines whether animation for opening and closing the Sheet is used **/
+    isAnimated?: boolean;
+    /** Focuses on the Sheet when `isOpen` is true and mounted **/
+    focusOnMount?: boolean;
+    /** Directs keyboard focus to the Sheet on mount **/
+    restoreFocus?: boolean;
+    /** Returns keyboard focus to the element that triggered the Sheet **/
+    placement?: 'start' | 'end';
+    /** Sets the width in pixels, based on the placement of the Sheet */
+    size?: string;
+}
+/**
+ * @extends HTMLAttributes<HTMLElement>
+ */
+export declare const Sheet: IStaticSheetExport<HTMLElement, ISheetProps>;
+export {};

package/dist/typings/elements/sheet/components/Body.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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';
+export declare const SheetBody: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;

package/dist/typings/elements/sheet/components/Close.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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';
+export declare const SheetClose: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLButtonElement> & React.RefAttributes<HTMLButtonElement>>;

package/dist/typings/elements/sheet/components/Description.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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';
+export declare const SheetDescription: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;

package/dist/typings/elements/sheet/components/Footer.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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';
+import { IStyledSheetFooterProps } from '../../../styled';
+export declare const SheetFooter: React.ForwardRefExoticComponent<IStyledSheetFooterProps & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLElement>>;

package/dist/typings/elements/sheet/components/FooterItem.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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';
+export declare const SheetFooterItem: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;

package/dist/typings/elements/sheet/components/Header.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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';
+export declare const SheetHeader: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLElement>>;

package/dist/typings/elements/sheet/components/Title.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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';
+export declare const SheetTitle: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;

package/dist/typings/index.d.ts

@@ -25,3 +25,4 @@ export { SubNav } from './elements/subnav/SubNav';
 export { SubNavItem } from './elements/subnav/SubNavItem';
 export { SubNavItemText } from './elements/subnav/SubNavItemText';
 export { CollapsibleSubNavItem } from './elements/subnav/CollapsibleSubNavItem';
+export { Sheet } from './elements/sheet/Sheet';

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

@@ -42,3 +42,13 @@ 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';
+export { StyledSheetWrapper } from './sheet/StyledSheetWrapper';
+export { StyledSheetTitle } from './sheet/StyledSheetTitle';
+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/sheet/StyledSheet.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { DefaultTheme } from 'styled-components';
+interface IStyledSheetProps {
+    placement?: 'start' | 'end';
+    isOpen?: boolean;
+    isAnimated?: boolean;
+    size?: string;
+}
+export declare const StyledSheet: import("styled-components").StyledComponent<"aside", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & IStyledSheetProps, "data-garden-id" | "data-garden-version">;
+export {};

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

@@ -0,0 +1,10 @@
+/**
+ * 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 const StyledSheetBody: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+}, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +1,11 @@
+/**
+ * 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 { ThemeProps, DefaultTheme } from 'styled-components';
+export declare const StyledSheetClose: import("styled-components").StyledComponent<"button", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +1,11 @@
+/**
+ * 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 { ThemeProps, DefaultTheme } from 'styled-components';
+export declare const StyledSheetDescription: import("styled-components").StyledComponent<"div", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +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 { ThemeProps, DefaultTheme } from 'styled-components';
+export interface IStyledSheetFooterProps {
+    /** Sets the SheetFooter padding to half the standard and centers the elements  */
+    isCompact?: boolean;
+}
+export declare const StyledSheetFooter: import("styled-components").StyledComponent<"footer", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & IStyledSheetFooterProps & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +1,11 @@
+/**
+ * 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 { ThemeProps, DefaultTheme } from 'styled-components';
+export declare const StyledSheetFooterItem: import("styled-components").StyledComponent<"div", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +1,11 @@
+/**
+ * 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 { ThemeProps, DefaultTheme } from 'styled-components';
+export declare const StyledSheetHeader: import("styled-components").StyledComponent<"header", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +1,11 @@
+/**
+ * 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 { ThemeProps, DefaultTheme } from 'styled-components';
+export declare const StyledSheetTitle: import("styled-components").StyledComponent<"div", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;

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

@@ -0,0 +1,18 @@
+/**
+ * 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 { ThemeProps, DefaultTheme } from 'styled-components';
+interface IStyledSheetWrapperProps {
+    isOpen?: boolean;
+    isAnimated?: boolean;
+    placement?: 'start' | 'end';
+    size?: string;
+}
+export declare const StyledSheetWrapper: import("styled-components").StyledComponent<"div", DefaultTheme, {
+    'data-garden-id': string;
+    'data-garden-version': string;
+} & IStyledSheetWrapperProps & ThemeProps<DefaultTheme>, "data-garden-id" | "data-garden-version">;
+export {};

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

@@ -0,0 +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;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/react-chrome",
-  "version": "8.46.0",
+  "version": "8.47.0",
   "description": "Components relating to Chrome within the Garden Design System.",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -22,10 +22,11 @@
   "types": "dist/typings/index.d.ts",
   "dependencies": {
     "@zendeskgarden/container-accordion": "^1.0.3",
-    "@zendeskgarden/container-keyboardfocus": "^0.4.7",
     "@zendeskgarden/container-utilities": "^0.6.0",
+    "dom-helpers": "^5.2.1",
     "polished": "^4.0.0",
-    "prop-types": "^15.5.7"
+    "prop-types": "^15.5.7",
+    "react-merge-refs": "^1.1.0"
   },
   "peerDependencies": {
     "@zendeskgarden/react-theming": "^8.1.0",
@@ -34,7 +35,7 @@
     "styled-components": "^4.2.0 || ^5.0.0"
   },
   "devDependencies": {
-    "@zendeskgarden/react-theming": "^8.46.0",
+    "@zendeskgarden/react-theming": "^8.47.0",
     "@zendeskgarden/svg-icons": "6.30.2"
   },
   "keywords": [
@@ -47,5 +48,5 @@
     "access": "public"
   },
   "zendeskgarden:src": "src/index.ts",
-  "gitHead": "9e577b188009344c7ad0a035749930a4e19e400a"
+  "gitHead": "aba4138c9eb030ab3f204ba783b340ca55be6988"
 }