@availity/mui-transitions 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.1.0 (2024-02-22)
+
+
+### Features
+
+* **mui-transitions:** add collapse ([b368bf7](https://github.com/Availity/element/commit/b368bf73810b50e710f1dc6698932c9ee1cc5ffc))

package/README.md

@@ -0,0 +1,61 @@
+# @availity/mui-transitions
+
+> Availity MUI transition components to be used with @availity/element design system.
+
+[![Version](https://img.shields.io/npm/v/@availity/mui-transitions.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-transitions)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/mui-transitions.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/mui-transitions)
+[![Dependency Status](https://img.shields.io/librariesio/release/npm/@availity/mui-transitions?style=for-the-badge)](https://github.com/Availity/element/blob/main/packages/mui-transitions/package.json)
+
+## Documentation
+
+This package extends the MUI transition components: [MUI Transitions Docs](https://mui.com/components/transitions/)
+
+Live demo and documentation in our [Storybook](https://availity.github.io/element/?path=/docs/components-transitions-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-transitions
+```
+
+#### Yarn
+
+```bash
+yarn add @availity/mui-transitions
+```
+
+### Usage
+
+#### Import through @availity/element
+
+```tsx
+import { Collapse } from '@availity/element';
+```
+
+#### Direct import
+
+```tsx
+import { Collapse } from '@availity/mui-transitions';
+```

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { CollapseProps as CollapseProps$1 } from '@mui/material/Collapse';
+
+type CollapseProps = CollapseProps$1;
+declare const Collapse: (props: CollapseProps) => JSX.Element;
+
+export { Collapse, CollapseProps };

package/dist/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Collapse: () => Collapse
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/Collapse.tsx
+var import_Collapse = __toESM(require("@mui/material/Collapse"));
+var import_jsx_runtime = require("react/jsx-runtime");
+var Collapse = (props) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_Collapse.default, {
+    ...props
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Collapse
+});

package/dist/index.mjs

@@ -0,0 +1,11 @@
+// src/lib/Collapse.tsx
+import MuiCollapse from "@mui/material/Collapse";
+import { jsx } from "react/jsx-runtime";
+var Collapse = (props) => {
+  return /* @__PURE__ */ jsx(MuiCollapse, {
+    ...props
+  });
+};
+export {
+  Collapse
+};

package/introduction.stories.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/Transitions/Introduction" />
+
+<Markdown>{ReadMe}</Markdown>

package/jest.config.js

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

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@availity/mui-transitions",
+  "version": "0.1.0",
+  "description": "Availity MUI Transitions Component - part of the @availity/element design system",
+  "keywords": [
+    "react",
+    "typescript",
+    "availity",
+    "mui"
+  ],
+  "homepage": "https://availity.github.io/element/?path=/docs/components-transitions-introduction--docs",
+  "bugs": {
+    "url": "https://github.com/Availity/element/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Availity/element.git",
+    "directory": "packages/transitions"
+  },
+  "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",
+    "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,42 @@
+{
+  "name": "mui-transitions",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/transitions/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "options": {
+        "eslintConfig": ".eslintrc.json",
+        "lintFilePatterns": ["packages/transitions/**/*.{js,ts}"],
+        "silent": false,
+        "fix": false,
+        "cache": true,
+        "cacheLocation": "./node_modules/.cache/transitions/.eslintcache",
+        "maxWarnings": -1,
+        "quiet": false,
+        "noEslintrc": false,
+        "hasTypeAwareRules": true,
+        "cacheStrategy": "metadata"
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/transitions"],
+      "options": {
+        "jestConfig": "packages/transitions/jest.config.js",
+        "passWithNoTests": true
+      }
+    },
+    "version": {
+      "executor": "@jscutlery/semver:version",
+      "options": {
+        "preset": "conventional",
+        "commitMessageFormat": "chore(${projectName}): release version ${version} [skip ci]",
+        "tagPrefix": "@availity/${projectName}@",
+        "trackDeps": true
+      }
+    }
+  }
+}

package/src/index.ts

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

package/src/lib/Collapse.stories.tsx

@@ -0,0 +1,105 @@
+// Each exported component in the package should have its own stories file
+
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+import { Collapse, CollapseProps } from './Collapse';
+import Switch from '@mui/material/Switch/Switch';
+import FormControlLabel from '@mui/material/FormControlLabel/FormControlLabel';
+import Box from '@mui/material/Box/Box';
+import Paper from '@mui/material/Paper/Paper';
+import visuallyHidden from '@mui/utils/visuallyHidden';
+import Table from '@mui/material/Table/Table';
+import TableHead from '@mui/material/TableHead/TableHead';
+import TableRow from '@mui/material/TableRow/TableRow';
+import TableCell from '@mui/material/TableCell/TableCell';
+import TableBody from '@mui/material/TableBody/TableBody';
+import Alert from '@mui/material/Alert/Alert';
+
+/** Expand from the start edge of the child element. */
+const meta: Meta<typeof Collapse> = {
+  title: 'Components/Transitions/Collapse',
+  component: Collapse,
+  tags: ['autodocs'],
+};
+
+export default meta;
+
+export const _Collapse: StoryObj<typeof Collapse> = {
+  render: (args: CollapseProps) => {
+    const [visible, setVisible] = useState(true);
+
+    const onClose = () => {
+      setVisible(false);
+      setTimeout(() => setVisible(true), 1000);
+    };
+
+    return (
+      <Collapse in={visible} {...args}>
+        <Alert onClose={onClose}>Dismissable Alert</Alert>
+      </Collapse>
+    );
+  },
+};
+
+export const _Options: StoryObj<typeof Collapse> = {
+  render: () => {
+    const [checked, setChecked] = useState(true);
+
+    const handleChange = () => {
+      setChecked((prev) => !prev);
+    };
+
+    const background = <Paper sx={{ m: 1, width: 100, height: 100, bgcolor: 'grey.200' }} elevation={4} />;
+
+    return (
+      <Box>
+        <FormControlLabel control={<Switch checked={checked} onChange={handleChange} />} label="Show" />
+        <Table role="presentation" sx={{ width: 250 }}>
+          <TableHead>
+            <TableRow>
+              <TableCell>
+                <Box sx={visuallyHidden}>Orientation</Box>
+              </TableCell>
+              <TableCell>
+                <Box sx={{ width: 120 }}>collapsedSize 0</Box>
+              </TableCell>
+              <TableCell>
+                <Box sx={{ width: 120 }}>collapsedSize 40</Box>
+              </TableCell>
+            </TableRow>
+          </TableHead>
+          <TableBody>
+            <TableRow sx={{ verticalAlign: 'top' }}>
+              <TableCell>
+                <Box sx={{ height: 120 }}>Vertical</Box>
+              </TableCell>
+              <TableCell>
+                <Collapse in={checked}>{background}</Collapse>
+              </TableCell>
+              <TableCell>
+                <Collapse in={checked} collapsedSize={40}>
+                  {background}
+                </Collapse>
+              </TableCell>
+            </TableRow>
+            <TableRow sx={{ verticalAlign: 'top' }}>
+              <TableCell>
+                <Box sx={{ height: 120 }}>Horizontal</Box>
+              </TableCell>
+              <TableCell>
+                <Collapse orientation="horizontal" in={checked}>
+                  {background}
+                </Collapse>
+              </TableCell>
+              <TableCell>
+                <Collapse orientation="horizontal" in={checked} collapsedSize={40}>
+                  {background}
+                </Collapse>
+              </TableCell>
+            </TableRow>
+          </TableBody>
+        </Table>
+      </Box>
+    );
+  },
+};

package/src/lib/Collapse.test.tsx

@@ -0,0 +1,9 @@
+import { render } from '@testing-library/react';
+import { Collapse } from './Collapse';
+
+describe('Collapse', () => {
+  test('should render successfully', () => {
+    const { getByText } = render(<Collapse>Test</Collapse>);
+    expect(getByText('Test')).toBeTruthy();
+  });
+});

package/src/lib/Collapse.tsx

@@ -0,0 +1,7 @@
+import MuiCollapse, { CollapseProps as MuiCollapseProps } from '@mui/material/Collapse';
+
+export type CollapseProps = MuiCollapseProps;
+
+export const Collapse = (props: CollapseProps): JSX.Element => {
+  return <MuiCollapse {...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"]
+}