@zendeskgarden/react-modals 8.69.2 → 8.69.3

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

@@ -1,96 +1,96 @@
-/**
- * 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, KeyboardEvent, MouseEvent } from 'react';
-import { Modifier } from 'react-popper';
-export declare const PLACEMENT: readonly ["auto", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end", "end", "end-top", "end-bottom", "start", "start-top", "start-bottom"];
-export type Placement = (typeof PLACEMENT)[number];
-export interface IModalProps extends HTMLAttributes<HTMLDivElement> {
-    /**
-     * Passes HTML attributes to the backdrop element
-     */
-    backdropProps?: HTMLAttributes<HTMLDivElement>;
-    /**
-     * Handles close actions. Can be triggered from the backdrop and from the close icon.
-     *
-     * @param {Object} event The DOM event that triggered the close action
-     */
-    onClose?: (event: KeyboardEvent | MouseEvent) => void;
-    /**
-     * Centers the modal on the backdrop
-     */
-    isCentered?: boolean;
-    /**
-     * Animates the modal
-     */
-    isAnimated?: boolean;
-    /**
-     * Defines the DOM element that the modal will attatch to
-     */
-    appendToNode?: Element;
-    /**
-     * Applies large styling
-     */
-    isLarge?: boolean;
-    /**
-     * Directs keyboard focus to the modal on mount
-     */
-    focusOnMount?: boolean;
-    /**
-     * Returns keyboard focus to the element that triggered the modal
-     */
-    restoreFocus?: boolean;
-}
-export interface IHeaderProps extends HTMLAttributes<HTMLDivElement> {
-    /**
-     * Applies danger styling
-     */
-    isDanger?: boolean;
-    /**
-     * Updates the element's HTML tag
-     */
-    tag?: any;
-}
-export interface IDrawerModalProps extends Omit<IModalProps, 'isAnimated' | 'isCentered' | 'isLarge'> {
-    /**
-     * Opens the modal
-     */
-    isOpen?: boolean;
-}
-export interface IDrawerModalHeaderProps extends HTMLAttributes<HTMLDivElement> {
-    /**
-     * Updates the element's HTML tag
-     */
-    tag?: any;
-}
-export interface ITooltipModalProps extends Omit<IModalProps, 'appendToNode' | 'isCentered' | 'isLarge'> {
-    /**
-     * Positions the modal relative to the provided `HTMLElement`
-     */
-    referenceElement?: HTMLElement | null;
-    /**
-     * Modifies [Popper instance](https://popper.js.org/docs/v2/modifiers/) to customize positioning logic
-     */
-    popperModifiers?: Partial<Modifier<any, any>>[];
-    /**
-     * Adjusts the placement of the tooltip
-     **/
-    placement?: Placement;
-    /**
-     * Adds an arrow to the tooltop
-     */
-    hasArrow?: boolean;
-    /**
-     * Sets the `z-index` of the tooltip
-     */
-    zIndex?: number;
-}
-export interface ITooltipModalTitleProps extends HTMLAttributes<HTMLDivElement> {
-    /**
-     * Updates the element's HTML tag
-     */
-    tag?: any;
-}
+/**
+ * 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, KeyboardEvent, MouseEvent } from 'react';
+import { Modifier } from 'react-popper';
+export declare const PLACEMENT: readonly ["auto", "top", "top-start", "top-end", "bottom", "bottom-start", "bottom-end", "end", "end-top", "end-bottom", "start", "start-top", "start-bottom"];
+export type Placement = (typeof PLACEMENT)[number];
+export interface IModalProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Passes HTML attributes to the backdrop element
+     */
+    backdropProps?: HTMLAttributes<HTMLDivElement>;
+    /**
+     * Handles close actions. Can be triggered from the backdrop and from the close icon.
+     *
+     * @param {Object} event The DOM event that triggered the close action
+     */
+    onClose?: (event: KeyboardEvent | MouseEvent) => void;
+    /**
+     * Centers the modal on the backdrop
+     */
+    isCentered?: boolean;
+    /**
+     * Animates the modal
+     */
+    isAnimated?: boolean;
+    /**
+     * Defines the DOM element that the modal will attatch to
+     */
+    appendToNode?: Element;
+    /**
+     * Applies large styling
+     */
+    isLarge?: boolean;
+    /**
+     * Directs keyboard focus to the modal on mount
+     */
+    focusOnMount?: boolean;
+    /**
+     * Returns keyboard focus to the element that triggered the modal
+     */
+    restoreFocus?: boolean;
+}
+export interface IHeaderProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Applies danger styling
+     */
+    isDanger?: boolean;
+    /**
+     * Updates the element's HTML tag
+     */
+    tag?: any;
+}
+export interface IDrawerModalProps extends Omit<IModalProps, 'isAnimated' | 'isCentered' | 'isLarge'> {
+    /**
+     * Opens the modal
+     */
+    isOpen?: boolean;
+}
+export interface IDrawerModalHeaderProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Updates the element's HTML tag
+     */
+    tag?: any;
+}
+export interface ITooltipModalProps extends Omit<IModalProps, 'appendToNode' | 'isCentered' | 'isLarge'> {
+    /**
+     * Positions the modal relative to the provided `HTMLElement`
+     */
+    referenceElement?: HTMLElement | null;
+    /**
+     * Modifies [Popper instance](https://popper.js.org/docs/v2/modifiers/) to customize positioning logic
+     */
+    popperModifiers?: Partial<Modifier<any, any>>[];
+    /**
+     * Adjusts the placement of the tooltip
+     **/
+    placement?: Placement;
+    /**
+     * Adds an arrow to the tooltop
+     */
+    hasArrow?: boolean;
+    /**
+     * Sets the `z-index` of the tooltip
+     */
+    zIndex?: number;
+}
+export interface ITooltipModalTitleProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * Updates the element's HTML tag
+     */
+    tag?: any;
+}

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

@@ -1,28 +1,28 @@
-/**
- * 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 { Placement } from '@popperjs/core';
-import { Placement as GardenPlacement } from '../types';
-/**
- * Convert Garden RTL aware placement to Popper.JS valid placement
- * @param {String} gardenPlacement
- */
-export declare function getPopperPlacement(gardenPlacement: GardenPlacement): Placement;
-/**
- * Convert Garden RTL aware placement to RTL equivalent Popper.JS placement
- * @param {String} gardenPlacement
- */
-export declare function getRtlPopperPlacement(gardenPlacement: GardenPlacement): Placement;
-/**
- * Convert Popper.JS placement to corresponding arrow position
- * @param {String} popperPlacement
- */
-export declare function getArrowPosition(popperPlacement: Placement): "top" | "top-left" | "top-right" | "right" | "right-top" | "right-bottom" | "bottom" | "bottom-left" | "bottom-right" | "left" | "left-top" | "left-bottom";
-/**
- * Convert Popper.JS placement to corresponding menu position
- * @param {String} popperPlacement
- */
-export declare function getMenuPosition(popperPlacement?: Placement): "top" | "right" | "bottom" | "left";
+/**
+ * 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 { Placement } from '@popperjs/core';
+import { Placement as GardenPlacement } from '../types';
+/**
+ * Convert Garden RTL aware placement to Popper.JS valid placement
+ * @param {String} gardenPlacement
+ */
+export declare function getPopperPlacement(gardenPlacement: GardenPlacement): Placement;
+/**
+ * Convert Garden RTL aware placement to RTL equivalent Popper.JS placement
+ * @param {String} gardenPlacement
+ */
+export declare function getRtlPopperPlacement(gardenPlacement: GardenPlacement): Placement;
+/**
+ * Convert Popper.JS placement to corresponding arrow position
+ * @param {String} popperPlacement
+ */
+export declare function getArrowPosition(popperPlacement: Placement): "top" | "top-left" | "top-right" | "right" | "right-top" | "right-bottom" | "bottom" | "bottom-left" | "bottom-right" | "left" | "left-top" | "left-bottom";
+/**
+ * Convert Popper.JS placement to corresponding menu position
+ * @param {String} popperPlacement
+ */
+export declare function getMenuPosition(popperPlacement?: Placement): "top" | "right" | "bottom" | "left";

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

@@ -1,20 +1,20 @@
-/**
- * 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" />
-import { IUseModalReturnValue } from '@zendeskgarden/container-modal';
-export interface IModalContext {
-    isLarge?: boolean;
-    isCloseButtonPresent?: boolean;
-    hasHeader: boolean;
-    setHasHeader: (hasHeader: boolean) => void;
-    getTitleProps: IUseModalReturnValue['getTitleProps'];
-    getContentProps: IUseModalReturnValue['getContentProps'];
-    getCloseProps: IUseModalReturnValue['getCloseProps'];
-    setIsCloseButtonPresent: (isPresent: boolean) => void;
-}
-export declare const ModalsContext: import("react").Context<IModalContext | undefined>;
-export declare const useModalContext: () => IModalContext;
+/**
+ * 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" />
+import { IUseModalReturnValue } from '@zendeskgarden/container-modal';
+export interface IModalContext {
+    isLarge?: boolean;
+    isCloseButtonPresent?: boolean;
+    hasHeader: boolean;
+    setHasHeader: (hasHeader: boolean) => void;
+    getTitleProps: IUseModalReturnValue['getTitleProps'];
+    getContentProps: IUseModalReturnValue['getContentProps'];
+    getCloseProps: IUseModalReturnValue['getCloseProps'];
+    setIsCloseButtonPresent: (isPresent: boolean) => void;
+}
+export declare const ModalsContext: import("react").Context<IModalContext | undefined>;
+export declare const useModalContext: () => IModalContext;

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

@@ -1,17 +1,17 @@
-/**
- * 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" />
-import { IUseModalReturnValue } from '@zendeskgarden/container-modal';
-export interface IModalContext {
-    hasTitle: boolean;
-    setHasTitle: (isPresent: boolean) => void;
-    getTitleProps: IUseModalReturnValue['getTitleProps'];
-    getContentProps: IUseModalReturnValue['getContentProps'];
-    getCloseProps: IUseModalReturnValue['getCloseProps'];
-}
-export declare const TooltipModalContext: import("react").Context<IModalContext | undefined>;
-export declare const useTooltipModalContext: () => IModalContext;
+/**
+ * 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" />
+import { IUseModalReturnValue } from '@zendeskgarden/container-modal';
+export interface IModalContext {
+    hasTitle: boolean;
+    setHasTitle: (isPresent: boolean) => void;
+    getTitleProps: IUseModalReturnValue['getTitleProps'];
+    getContentProps: IUseModalReturnValue['getContentProps'];
+    getCloseProps: IUseModalReturnValue['getCloseProps'];
+}
+export declare const TooltipModalContext: import("react").Context<IModalContext | undefined>;
+export declare const useTooltipModalContext: () => IModalContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/react-modals",
-  "version": "8.69.2",
+  "version": "8.69.3",
   "description": "Components relating to modals in the Garden Design System",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -38,8 +38,8 @@
     "styled-components": "^4.2.0 || ^5.0.0"
   },
   "devDependencies": {
-    "@types/react-transition-group": "4.4.5",
-    "@zendeskgarden/react-theming": "^8.69.2",
+    "@types/react-transition-group": "4.4.6",
+    "@zendeskgarden/react-theming": "^8.69.3",
     "@zendeskgarden/svg-icons": "6.33.0"
   },
   "keywords": [
@@ -52,5 +52,5 @@
     "access": "public"
   },
   "zendeskgarden:src": "src/index.ts",
-  "gitHead": "a39f2b421375013a50990d206610e3813abc0bd7"
+  "gitHead": "c861fbeb70120b66b05d2ce3a26ccf3047659aa0"
 }