@zendeskgarden/react-theming 9.0.0-next.8 → 9.0.0

package/dist/typings/elements/ThemeProvider.d.ts

@@ -6,9 +6,4 @@
  */
 import React, { PropsWithChildren } from 'react';
 import { IThemeProviderProps } from '../types';
-export declare const ThemeProvider: {
-    ({ theme, ...other }: PropsWithChildren<IThemeProviderProps>): React.JSX.Element;
-    defaultProps: {
-        theme: import("../types").IGardenTheme;
-    };
-};
+export declare const ThemeProvider: ({ theme, ...other }: PropsWithChildren<IThemeProviderProps>) => React.JSX.Element;

package/dist/typings/elements/palette/index.d.ts

@@ -9,11 +9,9 @@ declare const PALETTE: {
     white: string;
     product: {
         support: string;
-        message: string;
         explore: string;
         gather: string;
         guide: string;
-        connect: string;
         chat: string;
         talk: string;
         sell: string;
@@ -115,8 +113,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     pink: {
         100: string;
@@ -131,8 +127,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     crimson: {
         100: string;
@@ -147,8 +141,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     orange: {
         100: string;
@@ -163,8 +155,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     lemon: {
         100: string;
@@ -179,8 +169,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     lime: {
         100: string;
@@ -195,8 +183,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     mint: {
         100: string;
@@ -211,8 +197,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     teal: {
         100: string;
@@ -227,8 +211,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     azure: {
         100: string;
@@ -243,8 +225,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     royal: {
         100: string;
@@ -259,8 +239,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
     purple: {
         100: string;
@@ -275,8 +253,6 @@ declare const PALETTE: {
         1000: string;
         1100: string;
         1200: string;
-        M400: string;
-        M600: string;
     };
 };
 export default PALETTE;

package/dist/typings/index.d.ts

@@ -7,9 +7,9 @@
 export { ThemeProvider } from './elements/ThemeProvider';
 export { default as DEFAULT_THEME } from './elements/theme';
 export { default as PALETTE } from './elements/palette';
-export { default as PALETTE_V8 } from './elements/palette/v8';
 export { default as retrieveComponentStyles } from './utils/retrieveComponentStyles';
 export { getArrowPosition } from './utils/getArrowPosition';
+export { getCheckeredBackground } from './utils/getCheckeredBackground';
 export { getColor } from './utils/getColor';
 export { getColorV8 } from './utils/getColorV8';
 export { getFloatingPlacements } from './utils/getFloatingPlacements';
@@ -23,4 +23,5 @@ export { useWindow } from './utils/useWindow';
 export { useText } from './utils/useText';
 export { default as menuStyles } from './utils/menuStyles';
 export { focusStyles, SELECTOR_FOCUS_VISIBLE } from './utils/focusStyles';
-export { ARROW_POSITION, MENU_POSITION, PLACEMENT, type IGardenTheme, type IThemeProviderProps, type ArrowPosition, type ColorParameters, type FocusBoxShadowParameters, type FocusStylesParameters, type MenuPosition, type Placement } from './types';
+export { StyledBaseIcon } from './utils/StyledBaseIcon';
+export { ARROW_POSITION, MENU_POSITION, PLACEMENT, type IGardenTheme, type IThemeProviderProps, type ArrowPosition, type CheckeredBackgroundParameters, type ColorParameters, type FocusBoxShadowParameters, type FocusStylesParameters, type MenuPosition, type Placement } from './types';

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

@@ -11,6 +11,13 @@ export declare const MENU_POSITION: readonly ["top", "right", "bottom", "left"];
 export type MenuPosition = (typeof MENU_POSITION)[number];
 export declare const PLACEMENT: readonly ["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 type CheckeredBackgroundParameters = {
+    overlay?: string;
+    positionY?: number;
+    repeat?: 'repeat' | 'repeat-x';
+    size: number;
+    theme: IGardenTheme;
+};
 export type ColorParameters = {
     dark?: {
         hue?: string;
@@ -85,11 +92,13 @@ export interface IGardenTheme {
                 background: Record<string, string>;
                 border: Record<string, string>;
                 foreground: Record<string, string>;
+                shadow: Record<string, string>;
             };
             light: {
                 background: Record<string, string>;
                 border: Record<string, string>;
                 foreground: Record<string, string>;
+                shadow: Record<string, string>;
             };
         };
     };
@@ -131,6 +140,7 @@ export interface IGardenTheme {
         xxl: string;
         xxxl: string;
     };
+    opacity: Record<number, number>;
     palette: Record<string, Hue>;
     shadowWidths: {
         xs: string;

package/dist/typings/utils/StyledBaseIcon.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 StyledBaseIcon: import("styled-components").StyledComponent<({ children, theme, ...props }: any) => React.DetailedReactHTMLElement<any, HTMLElement>, import("styled-components").DefaultTheme, {}, never>;

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

@@ -8,24 +8,9 @@ import { ArrowPosition } from '../types';
 type ArrowOptions = {
     size?: string;
     inset?: string;
+    shift?: 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
@@ -53,6 +38,8 @@ export declare const exponentialSymbols: {
  *  (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.shift='0'] Shifts arrow positioning along
+ * the edge of the parent container.
  * @param {string} [options.animationModifier] A CSS class or attribute selector
  *  which, when applied, animates the arrow's appearance.
  *

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

@@ -0,0 +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.
+ */
+import { CheckeredBackgroundParameters } from '../types';
+/**
+ * Get a checkered background image.
+ *
+ * @param {Object} options.theme Provides information for pattern color and LTR/RTL layout
+ * @param {number} options.size The pixel size of the checkered pattern
+ * @param {string} [options.overlay] Optional
+ * [color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) with transparency or
+ * [`linear-gradient()`](https://developer.mozilla.org/en-US/docs/Web/CSS/gradient/linear-gradient)
+ * overlay to apply on top of the checkered pattern
+ * @param {number} [options.positionY=0] Optional vertical position for starting the pattern (default `0`)
+ * @param {string} [options.repeat='repeat'] Optional repeat value for the pattern; either `'repeat'` or `'repeat-x'` (default `'repeat'`)
+ */
+export declare const getCheckeredBackground: ({ theme, size, overlay, positionY, repeat }: CheckeredBackgroundParameters) => string;

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

@@ -4,7 +4,6 @@
  * 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 { ColorParameters } from '../types';
 /**
  * Get a color value from the theme. Variable lookup takes precedence, followed
@@ -12,7 +11,7 @@ import { ColorParameters } from '../types';
  * `shade`, `offset`, and `transparency` are used as fallbacks to determine the
  * color.
  *
- * @param {Object} [options.theme] Provides values used to resolve the desired color
+ * @param {Object} options.theme Provides values used to resolve the desired color
  * @param {string} [options.variable] A variable key (i.e. `'background.default'`) used to resolve a color value for the theme color base
  * @param {Object} [options.dark] An object with `hue`, `shade`, `offset`, and `transparency` values to be used in dark mode
  * @param {Object} [options.light] An object with `hue`, `shade`, `offset`, and `transparency` values to be used in light mode
@@ -25,6 +24,6 @@ import { ColorParameters } from '../types';
  *  - `'chromeHue'` = `theme.colors.chromeHue`
  * @param {number} [options.shade] A hue shade
  * @param {number} [options.offset] A positive or negative value to adjust the shade
- * @param {number} [options.transparency] An alpha-channel value between 0 and 1
+ * @param {number} [options.transparency] A `theme.opacity` key or an alpha-channel value between 0 and 1
  */
 export declare const getColor: (({ dark, hue, light, offset, shade, theme, transparency, variable }: ColorParameters) => string) & import("lodash").MemoizedFunction;

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

@@ -4,7 +4,6 @@
  * 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 { Hue } from '../types';
 import { DefaultTheme } from 'styled-components';
 export declare const DEFAULT_SHADE = 600;

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

@@ -33,5 +33,5 @@ type MenuOptions = {
  * @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 default function menuStyles(position: MenuPosition, options?: MenuOptions): import("styled-components").FlattenInterpolation<import("styled-components").ThemeProps<DefaultTheme>>;
 export {};

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

@@ -16,4 +16,4 @@ import { FC } from 'react';
  * @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;
+export declare const useText: (component: Pick<FC, "displayName">, props: Record<string, any>, name: string, text: string, condition?: boolean) => string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zendeskgarden/react-theming",
-  "version": "9.0.0-next.8",
+  "version": "9.0.0",
   "description": "Theming utilities and components within the Garden Design System",
   "license": "Apache-2.0",
   "author": "Zendesk Garden <garden@zendesk.com>",
@@ -22,19 +22,18 @@
   "types": "dist/typings/index.d.ts",
   "dependencies": {
     "@floating-ui/react-dom": "^2.0.0",
-    "chroma-js": "^2.4.2",
+    "color2k": "^2.0.3",
     "lodash.get": "^4.4.2",
     "lodash.memoize": "^4.1.2",
-    "polished": "^4.0.0",
+    "polished": "^4.3.1",
     "prop-types": "^15.5.7"
   },
   "peerDependencies": {
-    "react": ">=16.8.0",
-    "react-dom": ">=16.8.0",
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0",
     "styled-components": "^4.2.0 || ^5.3.1"
   },
   "devDependencies": {
-    "@types/chroma-js": "2.4.4",
     "@types/lodash.get": "4.4.9",
     "@types/lodash.memoize": "4.1.9"
   },
@@ -47,6 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "zendeskgarden:src": "src/index.ts",
-  "gitHead": "a3d6534843d5a4f5cb60b52bc67264f3230f2da0"
+  "zendeskgarden:src": "src/index.ts"
 }

package/LICENSE.md

@@ -1,176 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS