@workday/canvas-kit-react 6.8.9 → 6.9.0-next.5

package/layout/lib/utils/position.ts

@@ -0,0 +1,96 @@
+import {
+  ContentDirection,
+  PartialEmotionCanvasTheme,
+  useTheme,
+} from '@workday/canvas-kit-react/common';
+import {PropertyPosition, PropertyZIndex} from './types';
+
+/** style props to for standard position properties */
+export type PositionStandardProps = {
+  /** sets `position` property  */
+  position?: PropertyPosition;
+  /** sets `zIndex` property  */
+  zIndex?: PropertyZIndex;
+  /** sets `top` property  */
+  top?: number | string;
+  /** sets `right` property (no bidirectional support) */
+  right?: number | string;
+  /** sets `bottom` property  */
+  bottom?: number | string;
+  /** sets `left` property (no bidirectional support)  */
+  left?: number | string;
+};
+
+export type PositionLogicalProps = {
+  /** sets `left` property (bidirectional support)  */
+  insetInlineStart?: number | string;
+  /** sets `right` property (bidirectional support) */
+  insetInlineEnd?: number | string;
+};
+
+const getInsetInlineStartStyle = (value: number | string, isRTL = false) => {
+  const attr = isRTL ? 'right' : 'left';
+  return {[attr]: value};
+};
+
+const getInsetInlineEndStyle = (value: number | string, isRTL = false) => {
+  const attr = isRTL ? 'left' : 'right';
+  return {[attr]: value};
+};
+
+const standardPositionProps = {
+  position: 'position',
+  zIndex: 'zIndex',
+  top: 'top',
+  right: 'right',
+  bottom: 'bottom',
+  left: 'left',
+};
+
+const logicalPositionProps = {
+  insetInlineStart: getInsetInlineStartStyle,
+  insetInlineEnd: getInsetInlineEndStyle,
+};
+
+export type PositionStyleProps = PositionStandardProps & PositionLogicalProps;
+
+/**
+ * A style prop function that takes components props and returns position styles.
+ * If no `PositionProps` are found, it returns an empty object.
+ *
+ * @example
+ * // You'll most likely use `position` with low-level, styled components
+ * const BoxExample = () => (
+ *   <Box position="absolute" top="50%">
+ *     Hello, positions!
+ *   </Box>
+ * );
+ *
+ */
+export function position<P extends PositionStyleProps & {theme?: PartialEmotionCanvasTheme}>(
+  props: P
+) {
+  // position will always be used within the context of a component, but eslint doesn't know that
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const {canvas} = useTheme(props.theme);
+  let styles = {};
+  for (const key in props) {
+    if (key in props) {
+      if (key in standardPositionProps) {
+        const value = props[key];
+        const attr = standardPositionProps[key as keyof PositionStandardProps];
+        // @ts-ignore TS doesn't like adding a potentially unknown key to an object, but because we own this object, it's fine.
+        styles[attr] = value;
+        continue;
+      }
+      if (key in logicalPositionProps) {
+        const value = props[key as keyof PositionLogicalProps] as string | number;
+        const styleFn = logicalPositionProps[key as keyof PositionLogicalProps];
+        const isRTL = canvas.direction === ContentDirection.RTL;
+        const style = styleFn(value, isRTL);
+        styles = {...styles, ...style};
+      }
+    }
+  }
+  return styles;
+}

package/layout/lib/utils/space.ts

@@ -0,0 +1,207 @@
+import {
+  ContentDirection,
+  PartialEmotionCanvasTheme,
+  useTheme,
+} from '@workday/canvas-kit-react/common';
+import {space as spaceTokens, CanvasSpace, CanvasSpaceKeys} from '@workday/canvas-kit-react/tokens';
+
+type SpacePropValues = CanvasSpaceKeys | number | (string & {});
+
+/** These props automatically adjust for bidirectionality (LTR & RTL) */
+export type SpaceLogicalProps = {
+  /** sets margin-left property (bidirectional support) */
+  marginInlineStart?: SpacePropValues;
+  /** sets margin-right property (bidirectional support) */
+  marginInlineEnd?: SpacePropValues;
+  /** sets padding-left property (bidirectional support) */
+  paddingInlineStart?: SpacePropValues;
+  /** sets padding-right property (bidirectional support) */
+  paddingInlineEnd?: SpacePropValues;
+};
+
+/** These props do not adjust for bidirectionality (LTR & RTL) */
+export type SpaceStandardProps = {
+  /** sets margin property */
+  margin?: SpacePropValues;
+  /** sets margin-left and margin-right properties */
+  marginX?: SpacePropValues;
+  /** sets margin-top and margin-bottom properties */
+  marginY?: SpacePropValues;
+  /** sets margin-top property */
+  marginTop?: SpacePropValues;
+  /** sets margin-right property (no bidirectional support) */
+  marginRight?: SpacePropValues;
+  /** sets margin-bottom property */
+  marginBottom?: SpacePropValues;
+  /** sets margin-left property (no bidirectional support) */
+  marginLeft?: SpacePropValues;
+  /** sets padding property */
+  padding?: SpacePropValues;
+  /** sets padding-left and margin-right properties */
+  paddingX?: SpacePropValues;
+  /** sets padding-top and padding-bottom properties */
+  paddingY?: SpacePropValues;
+  /** sets padding-top property */
+  paddingTop?: SpacePropValues;
+  /** sets padding-right property (no bidirectional support) */
+  paddingRight?: SpacePropValues;
+  /** sets padding-bottom */
+  paddingBottom?: SpacePropValues;
+  /** sets padding-left property (no bidirectional support) */
+  paddingLeft?: SpacePropValues;
+};
+
+export type SpaceStyleProps = SpaceStandardProps & SpaceLogicalProps;
+
+const margin = (value: SpacePropValues) => {
+  return {margin: spaceTokens[value as keyof CanvasSpace] || value};
+};
+
+const marginX = (value: SpacePropValues) => {
+  return {
+    marginLeft: spaceTokens[value as CanvasSpaceKeys] || value,
+    marginRight: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const marginY = (value: SpacePropValues) => {
+  return {
+    marginTop: spaceTokens[value as CanvasSpaceKeys] || value,
+    marginBottom: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const marginTop = (value: SpacePropValues) => {
+  return {
+    marginTop: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const marginRight = (value: SpacePropValues, isRTL = false) => {
+  const attr = isRTL ? 'marginLeft' : 'marginRight';
+  return {
+    [attr]: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const marginBottom = (value: SpacePropValues) => {
+  return {
+    marginBottom: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const marginLeft = (value: SpacePropValues, isRTL = false) => {
+  const attr = isRTL ? 'marginRight' : 'marginLeft';
+  return {
+    [attr]: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const padding = (value: SpacePropValues) => {
+  return {
+    padding: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const paddingX = (value: SpacePropValues) => {
+  return {
+    paddingLeft: spaceTokens[value as CanvasSpaceKeys] || value,
+    paddingRight: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const paddingY = (value: SpacePropValues) => {
+  return {
+    paddingTop: spaceTokens[value as CanvasSpaceKeys] || value,
+    paddingBottom: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const paddingTop = (value: SpacePropValues) => {
+  return {
+    paddingTop: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const paddingRight = (value: SpacePropValues, isRTL = false) => {
+  const attr = isRTL ? 'paddingLeft' : 'paddingRight';
+  return {
+    [attr]: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const paddingBottom = (value: SpacePropValues) => {
+  return {
+    paddingBottom: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const paddingLeft = (value: SpacePropValues, isRTL = false) => {
+  const attr = isRTL ? 'paddingRight' : 'paddingLeft';
+  return {
+    [attr]: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const logicalSpaceStyleProps = {
+  marginInlineStart: marginLeft,
+  marginInlineEnd: marginRight,
+  paddingInlineStart: paddingLeft,
+  paddingInlineEnd: paddingRight,
+};
+
+const standardSpaceStyleProps = {
+  margin,
+  marginX,
+  marginY,
+  marginTop,
+  marginRight,
+  marginBottom,
+  marginLeft,
+  padding,
+  paddingX,
+  paddingY,
+  paddingTop,
+  paddingRight,
+  paddingBottom,
+  paddingLeft,
+};
+
+/**
+ * A style prop function that takes component props and returns space styles.
+ * If no `SpaceStyleProps` are found, it returns an empty object.
+ *
+ * @example
+ * // You'll most likely use `space` with low-level, styled components
+ * const BoxExample = () => (
+ *   <Box padding="xs" margin="m">
+ *     Hello, space!
+ *   </Box>
+ * );
+ *
+ */
+export function space<P extends SpaceStyleProps & {theme?: PartialEmotionCanvasTheme}>(props: P) {
+  // space will always be used within the context of a component, but eslint doesn't know that
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const {canvas} = useTheme(props.theme);
+  let styles = {};
+  for (const key in props) {
+    if (props.hasOwnProperty(key)) {
+      if (key in standardSpaceStyleProps) {
+        const value = props[key as keyof SpaceStandardProps] as SpacePropValues;
+        const spaceFn = standardSpaceStyleProps[key as keyof SpaceStandardProps];
+        const style = spaceFn(value);
+        styles = {...styles, ...style};
+        continue;
+      }
+      if (key in logicalSpaceStyleProps) {
+        const value = props[key as keyof SpaceLogicalProps] as SpacePropValues;
+        const spaceFn = logicalSpaceStyleProps[key as keyof SpaceLogicalProps];
+        const isRTL = canvas.direction === ContentDirection.RTL;
+        const style = spaceFn(value, isRTL);
+        styles = {...styles, ...style};
+      }
+    }
+  }
+  return styles;
+}

package/layout/lib/utils/stack.ts

@@ -0,0 +1,78 @@
+import {
+  ContentDirection,
+  PartialEmotionCanvasTheme,
+  useTheme,
+} from '@workday/canvas-kit-react/common';
+import {space as spaceTokens, CanvasSpaceKeys} from '@workday/canvas-kit-react/tokens';
+
+export type StackDirection = 'row' | 'column' | 'row-reverse' | 'column-reverse';
+
+const selector = '& > *:not(style) ~ *:not(style)';
+
+export type StackSpacing = CanvasSpaceKeys | number | (string & {});
+
+export type StackStyleProps = {
+  /** sets space values between child elements (bidirectional support) */
+  spacing: StackSpacing;
+  /**
+   * sets the direction for the stack
+   * @default "row"
+   * */
+  flexDirection?: StackDirection;
+  /**
+   * when `true` wraps each child element in a `Stack.Item`
+   * @default false
+   * */
+  shouldWrapChildren?: boolean;
+};
+
+const column = (value: StackSpacing) => ({
+  marginTop: spaceTokens[value as CanvasSpaceKeys] || value,
+});
+
+const columnReverse = (value: StackSpacing) => ({
+  marginBottom: spaceTokens[value as CanvasSpaceKeys] || value,
+});
+
+const row = (value: StackSpacing, isRTL = false) => {
+  const attr = isRTL ? 'marginRight' : 'marginLeft';
+  return {
+    [attr]: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const rowReverse = (value: StackSpacing, isRTL = false) => {
+  const attr = isRTL ? 'marginLeft' : 'marginRight';
+  return {
+    [attr]: spaceTokens[value as CanvasSpaceKeys] || value,
+  };
+};
+
+const stackDirectionProps = {
+  column,
+  'column-reverse': columnReverse,
+  row,
+  'row-reverse': rowReverse,
+};
+
+export function stack<P extends StackStyleProps & {theme?: PartialEmotionCanvasTheme}>(props: P) {
+  let styles = {};
+  const {flexDirection = 'row', spacing} = props;
+  if (flexDirection === 'column' || flexDirection === 'column-reverse') {
+    const stackFn = stackDirectionProps[flexDirection];
+    styles = stackFn(spacing);
+  }
+
+  if (flexDirection === 'row' || flexDirection === 'row-reverse') {
+    // stack will always be used within the context of a component, but eslint doesn't know that
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const {canvas} = useTheme(props.theme);
+    const stackFn = stackDirectionProps[flexDirection];
+    const isRTL = canvas.direction === ContentDirection.RTL;
+    styles = stackFn(spacing, isRTL);
+  }
+
+  return {
+    [selector]: styles,
+  };
+}

package/layout/lib/utils/types.ts

@@ -0,0 +1,148 @@
+import {
+  Globals,
+  GlobalsNumber,
+  SelfPosition,
+  DisplayOutside,
+  DisplayInside,
+  DisplayInternal,
+  DisplayLegacy,
+  LineStyle,
+  ContentDistribution,
+  ContentPosition,
+} from 'csstype';
+
+// We're temporarily creating these types from csstype
+// to improve type completion until we move to csstype v3.
+
+// Border
+export type PropertyBorder = Globals | LineStyle | (string & {});
+
+// Flex Item
+export type PropertyJustifySelf =
+  | Globals
+  | SelfPosition
+  | 'auto'
+  | 'baseline'
+  | 'left'
+  | 'normal'
+  | 'right'
+  | 'stretch'
+  | (string & {});
+
+export type PropertyAlignSelf =
+  | Globals
+  | SelfPosition
+  | 'auto'
+  | 'baseline'
+  | 'normal'
+  | 'stretch'
+  | (string & {});
+
+export type PropertyOrder = GlobalsNumber;
+
+// Layout
+export type PropertyDisplay =
+  | Globals
+  | DisplayOutside
+  | DisplayInside
+  | DisplayInternal
+  | DisplayLegacy
+  | 'contents'
+  | 'list-item'
+  | 'none'
+  | (string & {});
+
+export type PropertyListStyle = Globals | 'inside' | 'none' | 'outside' | (string & {});
+
+export type PropertyOverflow =
+  | Globals
+  | '-moz-hidden-unscrollable'
+  | 'auto'
+  | 'clip'
+  | 'hidden'
+  | 'scroll'
+  | 'visible'
+  | (string & {});
+
+export type PropertyOverflowX =
+  | Globals
+  | '-moz-hidden-unscrollable'
+  | 'auto'
+  | 'clip'
+  | 'hidden'
+  | 'scroll'
+  | 'visible';
+
+export type PropertyOverflowY =
+  | Globals
+  | '-moz-hidden-unscrollable'
+  | 'auto'
+  | 'clip'
+  | 'hidden'
+  | 'scroll'
+  | 'visible';
+
+export type PropertyVerticalAlign =
+  | Globals
+  | 'baseline'
+  | 'bottom'
+  | 'middle'
+  | 'sub'
+  | 'super'
+  | 'text-bottom'
+  | 'text-top'
+  | 'top'
+  | (string & {});
+
+// Position
+export type PropertyPosition =
+  | Globals
+  | '-webkit-sticky'
+  | 'absolute'
+  | 'fixed'
+  | 'relative'
+  | 'static'
+  | 'sticky';
+
+export type PropertyZIndex = GlobalsNumber | 'auto';
+
+// Flex
+export type PropertyAlignItems =
+  | Globals
+  | SelfPosition
+  | 'baseline'
+  | 'normal'
+  | 'stretch'
+  | (string & {});
+
+export type PropertyAlignContent =
+  | Globals
+  | ContentDistribution
+  | ContentPosition
+  | 'baseline'
+  | 'normal'
+  | (string & {});
+
+export type PropertyJustifyItems =
+  | Globals
+  | SelfPosition
+  | 'baseline'
+  | 'left'
+  | 'legacy'
+  | 'normal'
+  | 'right'
+  | 'stretch'
+  | (string & {});
+
+export type PropertyJustifyContent =
+  | Globals
+  | ContentDistribution
+  | ContentPosition
+  | 'left'
+  | 'normal'
+  | 'right'
+  | (string & {});
+
+export type PropertyFlexWrap = Globals | 'nowrap' | 'wrap' | 'wrap-reverse';
+
+export type PropertyFlexDirection = Globals | 'column' | 'column-reverse' | 'row' | 'row-reverse';

package/loading-animation/lib/LoadingDots.tsx

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import {keyframes} from '@emotion/core';
+import {keyframes} from '@emotion/react';
 import canvas, {borderRadius} from '@workday/canvas-kit-react/tokens';
 import {styled} from '@workday/canvas-kit-react/common';
 

package/menu/LICENSE

@@ -0,0 +1,52 @@
+Apache License, Version 2.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:
+You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and 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 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
+
+©2021 Workday, Inc. All rights reserved. Workday and the Workday logo are registered trademarks of Workday, Inc. All other brand and product names are trademarks or registered trademarks of their respective holders.
+
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

package/menu/README.md

@@ -0,0 +1,32 @@
+# Canvas Kit Menu
+
+Canvas Kit Menu Component
+
+## Installation
+
+```sh
+yarn add @workday/canvas-kit-react
+```
+
+## Usage
+
+```tsx
+import * as React from 'react';
+import {Menu} from '@workday/canvas-kit-react/menu';
+
+<Menu />;
+```
+
+## Static Properties
+
+> None
+
+## Component Props
+
+### Required
+
+> None
+
+### Optional
+
+> None

package/menu/index.ts

@@ -0,0 +1,8 @@
+export {useMenuModel} from './lib/useMenuModel';
+export {Menu} from './lib/Menu';
+
+export {useMenuCard} from './lib/MenuCard';
+export {useMenuItem} from './lib/MenuItem';
+export {useMenuList} from './lib/MenuList';
+export {useMenuPopper} from './lib/MenuPopper';
+export {useMenuTarget, useMenuTargetContext} from './lib/MenuTarget';