@availity/mui-menu 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.1.0 (2023-06-06)
+
+
+### Features
+
+* **mui-menu:** add menu component ([5cc8b1f](https://github.com/Availity/element/commit/5cc8b1f15e0aa987135e0bbac99943f2f46f6287))
+* **mui-menu:** omit menu props ([b81152a](https://github.com/Availity/element/commit/b81152a0f7804d34055962617f32194b02f2557f))

package/README.md

@@ -0,0 +1,61 @@
+# @availity/mui-menu
+
+> Availity MUI Menu component to be used with @availity/element design system.
+
+[![Version](https://img.shields.io/npm/v/@availity/mui-menu.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-menu)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/mui-menu.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-menu)
+[![Dependency Status](https://img.shields.io/librariesio/release/npm/@availity/mui-menu?style=for-the-badge)](https://github.com/Availity/element/blob/main/packages/mui-menu/package.json)
+
+## Documentation
+
+This package extends the MUI Menu component: [MUI Menu Docs](https://mui.com/components/menu/)
+
+Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/components-menu-introduction--docs)
+
+Availity standards for design and usage can be found in the [Availity Design Guide](https://zeroheight.com/2e36e50c7)
+
+## Installation
+
+### Import Through @availity/element (Recommended)
+
+#### NPM
+
+```bash
+npm install @availity/element
+```
+
+#### Yarn
+
+```bash
+yarn add @availity/element
+```
+
+### Direct Import
+
+#### NPM
+
+_This package has a few peer dependencies. Add `@mui/material` & `@emotion/react` to your project if not already installed._
+
+```bash
+npm install @availity/mui-menu
+```
+
+#### Yarn
+
+```bash
+yarn add @availity/mui-menu
+```
+
+### Usage
+
+#### Import through @availity/element
+
+```tsx
+import { Menu } from '@availity/element';
+```
+
+#### Direct import
+
+```tsx
+import { Menu } from '@availity/mui-menu';
+```

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { MenuProps as MenuProps$1, MenuItemProps as MenuItemProps$1, MenuListProps as MenuListProps$1 } from '@mui/material';
+
+type MenuProps = Omit<MenuProps$1, 'BackdropComponent' | 'BackdropProps' | 'classes' | 'disableAutoFocusItem' | 'disableEnforceFocus' | 'disableEscapeKeyDown' | 'onBackdropClick' | 'PopoverClasses' | 'ref' | 'sx' | 'TransitionComponent' | 'TransitionProps'>;
+declare const Menu: (props: MenuProps) => JSX.Element;
+type MenuItemProps = MenuItemProps$1;
+declare const MenuItem: (props: MenuItemProps) => JSX.Element;
+type MenuListProps = MenuListProps$1;
+declare const MenuList: (props: MenuListProps) => JSX.Element;
+
+export { Menu, MenuItem, MenuItemProps, MenuList, MenuListProps, MenuProps };

package/dist/index.js

@@ -0,0 +1,52 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Menu: () => Menu,
+  MenuItem: () => MenuItem,
+  MenuList: () => MenuList
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/Menu.tsx
+var import_material = require("@mui/material");
+var import_jsx_runtime = require("react/jsx-runtime");
+var Menu = (props) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.Menu, {
+    ...props
+  });
+};
+var MenuItem = (props) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.MenuItem, {
+    ...props
+  });
+};
+var MenuList = (props) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.MenuList, {
+    ...props
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Menu,
+  MenuItem,
+  MenuList
+});

package/dist/index.mjs

@@ -0,0 +1,27 @@
+// src/lib/Menu.tsx
+import {
+  Menu as MuiMenu,
+  MenuItem as MuiMenuItem,
+  MenuList as MuiMenuList
+} from "@mui/material";
+import { jsx } from "react/jsx-runtime";
+var Menu = (props) => {
+  return /* @__PURE__ */ jsx(MuiMenu, {
+    ...props
+  });
+};
+var MenuItem = (props) => {
+  return /* @__PURE__ */ jsx(MuiMenuItem, {
+    ...props
+  });
+};
+var MenuList = (props) => {
+  return /* @__PURE__ */ jsx(MuiMenuList, {
+    ...props
+  });
+};
+export {
+  Menu,
+  MenuItem,
+  MenuList
+};

package/introduction.mdx

@@ -0,0 +1,7 @@
+import { Markdown } from '@storybook/blocks';
+import { Meta } from '@storybook/addon-docs';
+import ReadMe from './README.md?raw';
+
+<Meta title="Components/Menu/Introduction" />
+
+<Markdown>{ReadMe}</Markdown>

package/jest.config.js

@@ -0,0 +1,7 @@
+const global = require('../../jest.config.global');
+
+module.exports = {
+  ...global,
+  displayName: 'menu',
+  coverageDirectory: '../../coverage/menu',
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@availity/mui-menu",
+  "version": "0.1.0",
+  "description": "Availity MUI Menu Component - part of the @availity/element design system",
+  "keywords": [
+    "react",
+    "typescript",
+    "availity",
+    "mui"
+  ],
+  "homepage": "https://availity.github.io/element/?path=/docs/components-menu-introduction--docs",
+  "bugs": {
+    "url": "https://github.com/Availity/element/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Availity/element.git",
+    "directory": "packages/menu"
+  },
+  "license": "MIT",
+  "author": "Availity Developers <AVOSS@availity.com>",
+  "browser": "./dist/index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "clean": "rm -rf dist",
+    "clean:nm": "rm -rf node_modules",
+    "bundlesize": "bundlesize",
+    "publish": "yarn npm publish --tolerate-republish --access public",
+    "publish:canary": "yarn npm publish --access public --tag canary"
+  },
+  "devDependencies": {
+    "@mui/material": "^5.11.9",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "tsup": "^5.12.7",
+    "typescript": "^4.6.4"
+  },
+  "peerDependencies": {
+    "@mui/material": "^5.11.9",
+    "react": ">=16.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/project.json

@@ -0,0 +1,41 @@
+{
+  "name": "mui-menu",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/menu/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "options": {
+        "eslintConfig": ".eslintrc.json",
+        "lintFilePatterns": ["packages/menu/**/*.{js,ts}"],
+        "silent": false,
+        "fix": false,
+        "cache": true,
+        "cacheLocation": "./node_modules/.cache/menu/.eslintcache",
+        "maxWarnings": -1,
+        "quiet": false,
+        "noEslintrc": false,
+        "hasTypeAwareRules": true,
+        "cacheStrategy": "metadata"
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/menu"],
+      "options": {
+        "jestConfig": "packages/menu/jest.config.js",
+        "passWithNoTests": true
+      }
+    },
+    "version": {
+      "executor": "@jscutlery/semver:version",
+      "options": {
+        "preset": "conventional",
+        "commitMessageFormat": "chore(${projectName}): release version ${version} [skip ci]",
+        "tagPrefix": "@availity/${projectName}@"
+      }
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/Menu';

package/src/lib/Menu.stories.tsx

@@ -0,0 +1,61 @@
+// Each exported component in the package should have its own stories file
+import { useEffect, useRef, useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+import { Button } from '@availity/mui-button';
+import { Menu, MenuItem } from './Menu';
+
+const meta: Meta<typeof Menu> = {
+  title: 'Components/Menu/Menu',
+  component: Menu,
+  tags: ['autodocs'],
+};
+
+export default meta;
+
+export const _Menu: StoryObj<typeof Menu> = {
+  render: ({ open, ...args }) => {
+    const anchorEl = useRef<HTMLButtonElement>(null);
+    const [controlledOpen, setControlledOpen] = useState(false);
+
+    useEffect(() => {
+      setControlledOpen(open);
+    }, [open]);
+
+    const handleClick = () => {
+      setControlledOpen((prev) => !prev);
+    };
+
+    const handleClose = () => {
+      setControlledOpen(false);
+    };
+
+    return (
+      <>
+        <Button
+          id="basic-button"
+          aria-controls={open ? 'basic-menu' : undefined}
+          aria-haspopup="true"
+          aria-expanded={open ? 'true' : undefined}
+          onClick={handleClick}
+          ref={anchorEl}
+        >
+          Dashboard
+        </Button>
+        <Menu
+          id="basic-menu"
+          anchorEl={anchorEl.current}
+          open={controlledOpen}
+          onClose={handleClose}
+          MenuListProps={{
+            'aria-labelledby': 'basic-button',
+          }}
+          {...args}
+        >
+          <MenuItem onClick={handleClose}>Profile</MenuItem>
+          <MenuItem onClick={handleClose}>My account</MenuItem>
+          <MenuItem onClick={handleClose}>Logout</MenuItem>
+        </Menu>
+      </>
+    );
+  },
+};

package/src/lib/Menu.test.tsx

@@ -0,0 +1,22 @@
+import { render } from '@testing-library/react';
+import { Menu, MenuItem } from './Menu';
+
+describe('Menu', () => {
+  test('should show menu items', () => {
+    const { getByText } = render(
+      <Menu open>
+        <MenuItem>Test</MenuItem>
+      </Menu>
+    );
+    expect(getByText('Test')).toBeTruthy();
+  });
+
+  test('should hide when not open', () => {
+    const { getByText } = render(
+      <Menu open={false}>
+        <MenuItem>Test</MenuItem>
+      </Menu>
+    );
+    expect(() => getByText('Test')).toThrowError();
+  });
+});

package/src/lib/Menu.tsx

@@ -0,0 +1,40 @@
+import {
+  Menu as MuiMenu,
+  MenuProps as MuiMenuProps,
+  MenuItem as MuiMenuItem,
+  MenuItemProps as MuiMenuItemProps,
+  MenuList as MuiMenuList,
+  MenuListProps as MuiMenuListProps,
+} from '@mui/material';
+
+export type MenuProps = Omit<
+  MuiMenuProps,
+  | 'BackdropComponent'
+  | 'BackdropProps'
+  | 'classes'
+  | 'disableAutoFocusItem'
+  | 'disableEnforceFocus'
+  | 'disableEscapeKeyDown'
+  | 'onBackdropClick'
+  | 'PopoverClasses'
+  | 'ref'
+  | 'sx'
+  | 'TransitionComponent'
+  | 'TransitionProps'
+>;
+
+export const Menu = (props: MenuProps): JSX.Element => {
+  return <MuiMenu {...props} />;
+};
+
+export type MenuItemProps = MuiMenuItemProps;
+
+export const MenuItem = (props: MenuItemProps) => {
+  return <MuiMenuItem {...props} />;
+};
+
+export type MenuListProps = MuiMenuListProps;
+
+export const MenuList = (props: MenuListProps) => {
+  return <MuiMenuList {...props} />;
+};

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["."],
+  "exclude": ["dist", "build", "node_modules"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node", "@testing-library/jest-dom"],
+    "allowJs": true
+  },
+  "include": ["**/*.test.js", "**/*.test.ts", "**/*.test.tsx", "**/*.d.ts"]
+}