@zendeskgarden/react-theming 8.69.2 → 8.69.3

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

@@ -1,62 +1,62 @@
-/**
- * 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 { ArrowPosition } from '../types';
-type ArrowOptions = {
-    size?: string;
-    inset?: string;
-    animationModifier?: string;
-};
-export declare const exponentialSymbols: {
-    symbols: {
-        sqrt: {
-            func: {
-                symbol: string;
-                f: (a: number) => number;
-                notation: string;
-                precedence: number;
-                rightToLeft: number;
-                argCount: number;
-            };
-            symbol: string;
-            regSymbol: string;
-        };
-    };
-};
-/**
- * CSS for an arrow at the given position and with the given size. The arrow is
- * positioned via `::before` and `::after` pseudo-elements and inherits the
- * base element's border, background, and box-shadow.
- *
- * IMPORTANT: the element that receives arrow styling must be wrapped in a
- * positioned box (i.e. `relative`, `absolute`, `fixed`) that has a `z-index`
- * greater than or equal to zero. Without this, the arrow cannot properly
- * display inherited border or box-shadow styling.
- *
- * @param {string} position One of:
- *  - `'top'`
- *  - `'top-left'`
- *  - `'top-right'`
- *  - `'right'`
- *  - `'right-top'`
- *  - `'right-bottom'`
- *  - `'bottom'`
- *  - `'bottom-left'`
- *  - `'bottom-right'`
- *  - `'left'`
- *  - `'left-top'`
- *  - `'left-bottom'`
- * @param {string} [options.size='6px'] Distance from the base (hypotenuse) to point
- *  (right angle) of the arrow expressed as a CSS dimension.
- * @param {string} [options.inset='0'] Tweak arrow positioning by adjusting with
- *  either a positive (push the arrow in) or negative (pull the arrow out) value.
- * @param {string} [options.animationModifier] A CSS class or attribute selector
- *  which, when applied, animates the arrow's appearance.
- *
- * @component
- */
-export default function arrowStyles(position: ArrowPosition, options?: ArrowOptions): import("styled-components").FlattenSimpleInterpolation;
-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 { ArrowPosition } from '../types';
+type ArrowOptions = {
+    size?: string;
+    inset?: string;
+    animationModifier?: string;
+};
+export declare const exponentialSymbols: {
+    symbols: {
+        sqrt: {
+            func: {
+                symbol: string;
+                f: (a: number) => number;
+                notation: string;
+                precedence: number;
+                rightToLeft: number;
+                argCount: number;
+            };
+            symbol: string;
+            regSymbol: string;
+        };
+    };
+};
+/**
+ * CSS for an arrow at the given position and with the given size. The arrow is
+ * positioned via `::before` and `::after` pseudo-elements and inherits the
+ * base element's border, background, and box-shadow.
+ *
+ * IMPORTANT: the element that receives arrow styling must be wrapped in a
+ * positioned box (i.e. `relative`, `absolute`, `fixed`) that has a `z-index`
+ * greater than or equal to zero. Without this, the arrow cannot properly
+ * display inherited border or box-shadow styling.
+ *
+ * @param {string} position One of:
+ *  - `'top'`
+ *  - `'top-left'`
+ *  - `'top-right'`
+ *  - `'right'`
+ *  - `'right-top'`
+ *  - `'right-bottom'`
+ *  - `'bottom'`
+ *  - `'bottom-left'`
+ *  - `'bottom-right'`
+ *  - `'left'`
+ *  - `'left-top'`
+ *  - `'left-bottom'`
+ * @param {string} [options.size='6px'] Distance from the base (hypotenuse) to point
+ *  (right angle) of the arrow expressed as a CSS dimension.
+ * @param {string} [options.inset='0'] Tweak arrow positioning by adjusting with
+ *  either a positive (push the arrow in) or negative (pull the arrow out) value.
+ * @param {string} [options.animationModifier] A CSS class or attribute selector
+ *  which, when applied, animates the arrow's appearance.
+ *
+ * @component
+ */
+export default function arrowStyles(position: ArrowPosition, options?: ArrowOptions): import("styled-components").FlattenSimpleInterpolation;
+export {};

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

@@ -1,47 +1,47 @@
-/**
- * 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 { CSSObject } from 'styled-components';
-import { FocusBoxShadowParameters } from './getFocusBoxShadow';
-export declare const SELECTOR_FOCUS_VISIBLE = "&:focus-visible, &[data-garden-focus-visible=\"true\"]";
-type FocusStylesParameters = FocusBoxShadowParameters & {
-    condition?: boolean;
-    selector?: string;
-    styles?: CSSObject;
-};
-/**
- * Garden standard `box-shadow` focus styling.
- *
- * @param {boolean} [options.condition=true] Supplies an optional condition that can be used to prevent the focus `box-shadow`
- * @param {boolean} [options.inset=false] Determines whether the `box-shadow` is inset
- * @param {string|Object} [options.hue='primaryHue'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
- * @param {string} [options.selector=SELECTOR_FOCUS_VISIBLE] Provides a substitute `:focus-visible` pseudo-class CSS selector.
- * @param {number} [options.shade=600] Selects a shade for the given hue
- * @param {string} [options.shadowWidth='md'] Provides a theme object `shadowWidth` key for the cumulative width of the `box-shadow`
- * @param {string|Object} [options.spacerHue='background'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
- * @param {number} [options.spacerShade=600] Selects a shade for the given `spacerHue`
- * @param {string} [options.spacerWidth='xs'] Provides a theme object `shadowWidth` for the white spacer, or `null` to remove
- * @param {Object} [options.styles] Adds CSS property values to be rendered with `:focus-visible`
- * @param {Object} options.theme Provides values used to resolve the desired color
- *
- * @returns CSS structured as follows, with `{values}` determined by the options provided:
- * ```css
- * :focus {
- *   outline: none;
- * }
- *
- * :focus-visible,
- * [data-garden-focus-visible='true'] {
- *   box-shadow: 0 0 0 {1px} #fff,
- *               0 0 0 {3px} {blue};
- *   outline: {2px} solid transparent;
- *   outline-offset: {1px};
- *   // additional {styles} here...
- * }
- * ```
- */
-export declare const focusStyles: ({ condition, selector, shadowWidth, spacerWidth, styles: { boxShadow, ...styles }, theme, ...options }: FocusStylesParameters) => import("styled-components").FlattenSimpleInterpolation;
-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 { CSSObject } from 'styled-components';
+import { FocusBoxShadowParameters } from './getFocusBoxShadow';
+export declare const SELECTOR_FOCUS_VISIBLE = "&:focus-visible, &[data-garden-focus-visible=\"true\"]";
+type FocusStylesParameters = FocusBoxShadowParameters & {
+    condition?: boolean;
+    selector?: string;
+    styles?: CSSObject;
+};
+/**
+ * Garden standard `box-shadow` focus styling.
+ *
+ * @param {boolean} [options.condition=true] Supplies an optional condition that can be used to prevent the focus `box-shadow`
+ * @param {boolean} [options.inset=false] Determines whether the `box-shadow` is inset
+ * @param {string|Object} [options.hue='primaryHue'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
+ * @param {string} [options.selector=SELECTOR_FOCUS_VISIBLE] Provides a substitute `:focus-visible` pseudo-class CSS selector.
+ * @param {number} [options.shade=600] Selects a shade for the given hue
+ * @param {string} [options.shadowWidth='md'] Provides a theme object `shadowWidth` key for the cumulative width of the `box-shadow`
+ * @param {string|Object} [options.spacerHue='background'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
+ * @param {number} [options.spacerShade=600] Selects a shade for the given `spacerHue`
+ * @param {string} [options.spacerWidth='xs'] Provides a theme object `shadowWidth` for the white spacer, or `null` to remove
+ * @param {Object} [options.styles] Adds CSS property values to be rendered with `:focus-visible`
+ * @param {Object} options.theme Provides values used to resolve the desired color
+ *
+ * @returns CSS structured as follows, with `{values}` determined by the options provided:
+ * ```css
+ * :focus {
+ *   outline: none;
+ * }
+ *
+ * :focus-visible,
+ * [data-garden-focus-visible='true'] {
+ *   box-shadow: 0 0 0 {1px} #fff,
+ *               0 0 0 {3px} {blue};
+ *   outline: {2px} solid transparent;
+ *   outline-offset: {1px};
+ *   // additional {styles} here...
+ * }
+ * ```
+ */
+export declare const focusStyles: ({ condition, selector, shadowWidth, spacerWidth, styles: { boxShadow, ...styles }, theme, ...options }: FocusStylesParameters) => import("styled-components").FlattenSimpleInterpolation;
+export {};

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

@@ -1,25 +1,25 @@
-/**
- * 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="lodash" />
-import { DefaultTheme } from 'styled-components';
-export type Hue = Record<number | string, string> | string;
-export declare const DEFAULT_SHADE = 600;
-/**
- * Get the palette color for the given hue, shade, and theme.
- *
- * @param {string|Object} hue A `theme.palette` hue or one of the following `theme.colors` keys:
- *  - `'primaryHue'` = `theme.colors.primaryHue`
- *  - `'dangerHue'` = `theme.colors.dangerHue`
- *  - `'warningHue'` = `theme.colors.warningHue`
- *  - `'successHue'` = `theme.colors.successHue`
- *  - `'neutralHue'` = `theme.colors.neutralHue`
- *  - `'chromeHue'` = `theme.colors.chromeHue`
- * @param {number} [shade=DEFAULT_SHADE] A hue shade.
- * @param {Object} theme Context `theme` object.
- * @param {Number} [transparency] An alpha-channel value between 0 and 1.
- */
-export declare const getColor: ((hue: Hue, shade?: number, theme?: DefaultTheme, transparency?: number) => string | undefined) & import("lodash").MemoizedFunction;
+/**
+ * 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="lodash" />
+import { DefaultTheme } from 'styled-components';
+export type Hue = Record<number | string, string> | string;
+export declare const DEFAULT_SHADE = 600;
+/**
+ * Get the palette color for the given hue, shade, and theme.
+ *
+ * @param {string|Object} hue A `theme.palette` hue or one of the following `theme.colors` keys:
+ *  - `'primaryHue'` = `theme.colors.primaryHue`
+ *  - `'dangerHue'` = `theme.colors.dangerHue`
+ *  - `'warningHue'` = `theme.colors.warningHue`
+ *  - `'successHue'` = `theme.colors.successHue`
+ *  - `'neutralHue'` = `theme.colors.neutralHue`
+ *  - `'chromeHue'` = `theme.colors.chromeHue`
+ * @param {number} [shade=DEFAULT_SHADE] A hue shade.
+ * @param {Object} theme Context `theme` object.
+ * @param {Number} [transparency] An alpha-channel value between 0 and 1.
+ */
+export declare const getColor: ((hue: Hue, shade?: number, theme?: DefaultTheme, transparency?: number) => string | undefined) & import("lodash").MemoizedFunction;

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

@@ -1,9 +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 { ThemeProps, DefaultTheme } from 'styled-components';
-/** @component */
-export default function getDocument({ theme }?: Partial<ThemeProps<Partial<DefaultTheme>>>): 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 { ThemeProps, DefaultTheme } from 'styled-components';
+/** @component */
+export default function getDocument({ theme }?: Partial<ThemeProps<Partial<DefaultTheme>>>): any;

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

@@ -1,37 +1,37 @@
-/**
- * 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 { IGardenTheme } from '../types';
-import { Hue } from './getColor';
-export type FocusBoxShadowParameters = {
-    boxShadow?: string;
-    inset?: boolean;
-    hue?: Hue;
-    shade?: number;
-    shadowWidth?: 'sm' | 'md';
-    spacerHue?: Hue;
-    spacerShade?: number;
-    spacerWidth?: null | 'xs' | 'sm';
-    theme: IGardenTheme;
-};
-/**
- * Get a CSS `box-shadow` property value for focus state styling. The `hue` and
- * `shade` are used to determine the color of the focus ring.
- *
- * @param {string} [options.boxShadow] Provides an existing `box-shadow` (a drop shadow, for example) to be retained along with the focus ring
- * @param {boolean} [options.inset=false] Determines whether the `box-shadow` is inset
- * @param {string|Object} [options.hue='primaryHue'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
- * @param {number} [options.shade=600] Selects a shade for the given `hue`
- * @param {string} [options.shadowWidth='md'] Provides a theme object `shadowWidth` key for the cumulative width of the `box-shadow`
- * @param {string|Object} [options.spacerHue='background'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
- * @param {number} [options.spacerShade=600] Selects a shade for the given `spacerHue`
- * @param {string} [options.spacerWidth='xs'] Provides a theme object `shadowWidth` for the white spacer, or `null` to remove
- * @param {Object} options.theme Provides values used to resolve the desired color
- *
- * @returns A `box-shadow` property value for the given options. Default is a
- * 3px `blue[600]` ring with a 1px white spacer overlay.
- */
-export declare const getFocusBoxShadow: ({ boxShadow, inset, hue, shade, shadowWidth, spacerHue, spacerShade, spacerWidth, theme }: FocusBoxShadowParameters) => string;
+/**
+ * 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 { IGardenTheme } from '../types';
+import { Hue } from './getColor';
+export type FocusBoxShadowParameters = {
+    boxShadow?: string;
+    inset?: boolean;
+    hue?: Hue;
+    shade?: number;
+    shadowWidth?: 'sm' | 'md';
+    spacerHue?: Hue;
+    spacerShade?: number;
+    spacerWidth?: null | 'xs' | 'sm';
+    theme: IGardenTheme;
+};
+/**
+ * Get a CSS `box-shadow` property value for focus state styling. The `hue` and
+ * `shade` are used to determine the color of the focus ring.
+ *
+ * @param {string} [options.boxShadow] Provides an existing `box-shadow` (a drop shadow, for example) to be retained along with the focus ring
+ * @param {boolean} [options.inset=false] Determines whether the `box-shadow` is inset
+ * @param {string|Object} [options.hue='primaryHue'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
+ * @param {number} [options.shade=600] Selects a shade for the given `hue`
+ * @param {string} [options.shadowWidth='md'] Provides a theme object `shadowWidth` key for the cumulative width of the `box-shadow`
+ * @param {string|Object} [options.spacerHue='background'] Provides a theme object `palette` hue or `color` key, or any valid CSS color notation
+ * @param {number} [options.spacerShade=600] Selects a shade for the given `spacerHue`
+ * @param {string} [options.spacerWidth='xs'] Provides a theme object `shadowWidth` for the white spacer, or `null` to remove
+ * @param {Object} options.theme Provides values used to resolve the desired color
+ *
+ * @returns A `box-shadow` property value for the given options. Default is a
+ * 3px `blue[600]` ring with a 1px white spacer overlay.
+ */
+export declare const getFocusBoxShadow: ({ boxShadow, inset, hue, shade, shadowWidth, spacerHue, spacerShade, spacerWidth, theme }: FocusBoxShadowParameters) => string;

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

@@ -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.
- */
-/**
- * Get unitless line height based on the given pixel-valued height and font size.
- *
- * @param {string|number} height Desired line height in pixels.
- * @param {string|number} fontSize Font size (in pixels) of text contained within the line.
- *
- * @component
- */
-export default function getLineHeight(height: string | number, fontSize: string | number): number;
+/**
+ * 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.
+ */
+/**
+ * Get unitless line height based on the given pixel-valued height and font size.
+ *
+ * @param {string|number} height Desired line height in pixels.
+ * @param {string|number} fontSize Font size (in pixels) of text contained within the line.
+ *
+ * @component
+ */
+export default function getLineHeight(height: string | number, fontSize: string | number): number;

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

@@ -1,9 +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 { ThemeProps, DefaultTheme } from 'styled-components';
-/** @component */
-export default function isRtl({ theme }?: Partial<ThemeProps<Partial<DefaultTheme>>>): 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 { ThemeProps, DefaultTheme } from 'styled-components';
+/** @component */
+export default function isRtl({ theme }?: Partial<ThemeProps<Partial<DefaultTheme>>>): boolean;

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

@@ -1,24 +1,24 @@
-/**
- * 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';
-type QUERY = 'up' | 'down' | 'only' | 'between';
-type BREAKPOINT = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
-/**
- * Get a media query string for the given query specifier, breakpoint name, and theme.
- *
- * @param {string} query A query specifier, one of:
- * - `'up'` = match screen widths including the given breakpoint and up.
- * - `'down'` = match screen widths included within the given breakpoint and down.
- * - `'only'` = match screen widths included within the given breakpoint.
- * - `'between'` = match screen widths including the first breakpoint up through
- *   screen widths included within the second breakpoint.
- * @param {string|Array} breakpoint A `theme.breakpoints` key, one of: `'xs'`, `'sm'`,
- *   `'md'`, `'lg'`, `'xl'`; or an array of two keys when 'between' is the specified query.
- * @param {Object} theme Context `theme` object.
- */
-export default function mediaQuery(query: QUERY, breakpoint: BREAKPOINT | [BREAKPOINT, BREAKPOINT], theme?: DefaultTheme): string;
-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 { DefaultTheme } from 'styled-components';
+type QUERY = 'up' | 'down' | 'only' | 'between';
+type BREAKPOINT = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+/**
+ * Get a media query string for the given query specifier, breakpoint name, and theme.
+ *
+ * @param {string} query A query specifier, one of:
+ * - `'up'` = match screen widths including the given breakpoint and up.
+ * - `'down'` = match screen widths included within the given breakpoint and down.
+ * - `'only'` = match screen widths included within the given breakpoint.
+ * - `'between'` = match screen widths including the first breakpoint up through
+ *   screen widths included within the second breakpoint.
+ * @param {string|Array} breakpoint A `theme.breakpoints` key, one of: `'xs'`, `'sm'`,
+ *   `'md'`, `'lg'`, `'xl'`; or an array of two keys when 'between' is the specified query.
+ * @param {Object} theme Context `theme` object.
+ */
+export default function mediaQuery(query: QUERY, breakpoint: BREAKPOINT | [BREAKPOINT, BREAKPOINT], theme?: DefaultTheme): string;
+export {};

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

@@ -1,37 +1,37 @@
-/**
- * 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';
-import { MenuPosition } from '../types';
-type MenuOptions = {
-    theme?: DefaultTheme;
-    hidden?: boolean;
-    margin?: string;
-    zIndex?: number;
-    animationModifier?: string;
-    childSelector?: string;
-};
-/**
- * CSS for a `wrapper > menu` at the given position. The wrapper provides
- * absolute positioning (e.g. via Popper). The menu provides basic styling and
- * optional animation.
- *
- * @param {string} position One of:
- *  - `'top'`
- *  - `'right'`
- *  - `'bottom'`
- *  - `'left'`
- * @param {Object} [options.theme=`DEFAULT_THEME`] Context theme object.
- * @param {boolean} [options.hidden] Determine whether the menu is hidden.
- * @param {string} [options.margin] Amount of margin between menu and trigger.
- * @param {number} [options.zIndex] The menu wrapper's z-index.
- * @param {string} [options.childSelector=`> *`] A CSS selector that identifies the
- *  child menu component.
- * @param {string} [options.animationModifier] A CSS class or attribute selector
- *  which, when applied, animates the menu's appearance.
- */
-export default function menuStyles(position: MenuPosition, options?: MenuOptions): import("styled-components").FlattenSimpleInterpolation;
-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 { DefaultTheme } from 'styled-components';
+import { MenuPosition } from '../types';
+type MenuOptions = {
+    theme?: DefaultTheme;
+    hidden?: boolean;
+    margin?: string;
+    zIndex?: number;
+    animationModifier?: string;
+    childSelector?: string;
+};
+/**
+ * CSS for a `wrapper > menu` at the given position. The wrapper provides
+ * absolute positioning (e.g. via Popper). The menu provides basic styling and
+ * optional animation.
+ *
+ * @param {string} position One of:
+ *  - `'top'`
+ *  - `'right'`
+ *  - `'bottom'`
+ *  - `'left'`
+ * @param {Object} [options.theme=`DEFAULT_THEME`] Context theme object.
+ * @param {boolean} [options.hidden] Determine whether the menu is hidden.
+ * @param {string} [options.margin] Amount of margin between menu and trigger.
+ * @param {number} [options.zIndex] The menu wrapper's z-index.
+ * @param {string} [options.childSelector=`> *`] A CSS selector that identifies the
+ *  child menu component.
+ * @param {string} [options.animationModifier] A CSS class or attribute selector
+ *  which, when applied, animates the menu's appearance.
+ */
+export default function menuStyles(position: MenuPosition, options?: MenuOptions): import("styled-components").FlattenSimpleInterpolation;
+export {};

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

@@ -1,9 +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 { ThemeProps, DefaultTheme } from 'styled-components';
-/** @component */
-export default function retrieveComponentStyles(componentId: string, props: Partial<ThemeProps<Partial<DefaultTheme>>>): 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 { ThemeProps, DefaultTheme } from 'styled-components';
+/** @component */
+export default function retrieveComponentStyles(componentId: string, props: Partial<ThemeProps<Partial<DefaultTheme>>>): any;

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

@@ -1,8 +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 { DefaultTheme } from 'styled-components';
-export declare const useDocument: (theme?: Partial<DefaultTheme>) => Document | undefined;
+/**
+ * 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';
+export declare const useDocument: (theme?: Partial<DefaultTheme>) => Document | undefined;

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

@@ -1,19 +1,19 @@
-/**
- * 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 { FC } from 'react';
-/**
- * Provides default text for a11y (i.e. aria-label) or other critical attribute
- * strings. If necessary, a development mode console warning prompts the
- * consumer to provide customized, translated text.
- *
- * @param component The React component to which the `props` belong
- * @param props The component props to check for `name`
- * @param name The name of the component prop to set default text on
- * @param text The default text to apply if the value of `props[name]` is undefined
- * @param condition An optional condition that can be used to prevent evaluation
- */
-export declare const useText: (component: Pick<FC, 'displayName'>, props: Record<string, any>, name: string, text: string, condition?: boolean) => string | undefined;
+/**
+ * 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 { FC } from 'react';
+/**
+ * Provides default text for a11y (i.e. aria-label) or other critical attribute
+ * strings. If necessary, a development mode console warning prompts the
+ * consumer to provide customized, translated text.
+ *
+ * @param component The React component to which the `props` belong
+ * @param props The component props to check for `name`
+ * @param name The name of the component prop to set default text on
+ * @param text The default text to apply if the value of `props[name]` is undefined
+ * @param condition An optional condition that can be used to prevent evaluation
+ */
+export declare const useText: (component: Pick<FC, 'displayName'>, props: Record<string, any>, name: string, text: string, condition?: boolean) => string | undefined;

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

@@ -1,8 +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 { DefaultTheme } from 'styled-components';
-export declare const useWindow: (theme?: Partial<DefaultTheme>) => Window | undefined;
+/**
+ * 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';
+export declare const useWindow: (theme?: Partial<DefaultTheme>) => Window | undefined;