@availity/mui-autocomplete 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-11-15)
+
+
+### Features
+
+* **mui-autocomplete:** add autocomplete package ([3217d31](https://github.com/Availity/element/commit/3217d31d041c6a2e9ad616ed0a00e8362976adfc))
+* **mui-autocomplete:** add autocomplete package ([772c989](https://github.com/Availity/element/commit/772c98978f2c8e3edc01d8deb38dfc5cc2339298))

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import * as react from 'react';
+import { ChipTypeMap, AutocompleteProps as AutocompleteProps$1 } from '@mui/material';
+import { TextFieldProps } from '@availity/mui-textfield';
+
+interface AutocompleteProps<T, Multiple extends boolean | undefined, DisableClearable extends boolean | undefined, FreeSolo extends boolean | undefined, ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']> extends Omit<AutocompleteProps$1<T, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'renderInput'> {
+    FieldProps?: TextFieldProps;
+}
+declare const Autocomplete: <T, Multiple extends boolean | undefined = false, DisableClearable extends boolean | undefined = false, FreeSolo extends boolean | undefined = false, ChipComponent extends react.ElementType<any> = "div">({ FieldProps, ...props }: AutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>) => JSX.Element;
+
+export { Autocomplete, AutocompleteProps };

package/dist/index.js

@@ -0,0 +1,48 @@
+"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, {
+  Autocomplete: () => Autocomplete
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/Autocomplete.tsx
+var import_material = require("@mui/material");
+var import_mui_textfield = require("@availity/mui-textfield");
+var import_mui_form_utils = require("@availity/mui-form-utils");
+var import_jsx_runtime = require("react/jsx-runtime");
+var Autocomplete = ({
+  FieldProps,
+  ...props
+}) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.Autocomplete, {
+    renderInput: (params) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_textfield.TextField, {
+      ...FieldProps,
+      ...params
+    }),
+    popupIcon: /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_form_utils.SelectPropOverrides.IconComponent, {}),
+    ...props
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Autocomplete
+});

package/dist/index.mjs

@@ -0,0 +1,23 @@
+// src/lib/Autocomplete.tsx
+import {
+  Autocomplete as MuiAutocomplete
+} from "@mui/material";
+import { TextField } from "@availity/mui-textfield";
+import { SelectPropOverrides } from "@availity/mui-form-utils";
+import { jsx } from "react/jsx-runtime";
+var Autocomplete = ({
+  FieldProps,
+  ...props
+}) => {
+  return /* @__PURE__ */ jsx(MuiAutocomplete, {
+    renderInput: (params) => /* @__PURE__ */ jsx(TextField, {
+      ...FieldProps,
+      ...params
+    }),
+    popupIcon: /* @__PURE__ */ jsx(SelectPropOverrides.IconComponent, {}),
+    ...props
+  });
+};
+export {
+  Autocomplete
+};

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/Autocomplete/Introduction" />
+
+<Markdown>{ReadMe}</Markdown>

package/jest.config.js

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

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@availity/mui-autocomplete",
+  "version": "0.1.0",
+  "description": "Availity MUI Autocomplete Component - part of the @availity/element design system",
+  "keywords": [
+    "react",
+    "typescript",
+    "availity",
+    "mui"
+  ],
+  "homepage": "https://availity.github.io/element/?path=/docs/components-autocomplete-introduction--docs",
+  "bugs": {
+    "url": "https://github.com/Availity/element/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Availity/element.git",
+    "directory": "packages/autocomplete"
+  },
+  "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"
+  },
+  "dependencies": {
+    "@availity/mui-form-utils": "0.5.3",
+    "@availity/mui-textfield": "0.3.2"
+  },
+  "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-autocomplete",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/autocomplete/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "options": {
+        "eslintConfig": ".eslintrc.json",
+        "lintFilePatterns": ["packages/autocomplete/**/*.{js,ts}"],
+        "silent": false,
+        "fix": false,
+        "cache": true,
+        "cacheLocation": "./node_modules/.cache/autocomplete/.eslintcache",
+        "maxWarnings": -1,
+        "quiet": false,
+        "noEslintrc": false,
+        "hasTypeAwareRules": true,
+        "cacheStrategy": "metadata"
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/autocomplete"],
+      "options": {
+        "jestConfig": "packages/autocomplete/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/Autocomplete';

package/src/lib/Autocomplete.stories.tsx

@@ -0,0 +1,44 @@
+// Each exported component in the package should have its own stories file
+
+import type { Meta, StoryObj } from '@storybook/react';
+import { Autocomplete, AutocompleteProps } from './Autocomplete';
+import {
+  Box,
+  Chip,
+  MenuItem,
+  Autocomplete as MuiAutocomplete,
+  AutocompleteProps as MuiAutocompleteProps,
+  TextField as MuiTextField,
+  SelectChangeEvent,
+  Typography,
+} from '@mui/material';
+import { TextField } from '@availity/mui-textfield';
+import { Select, SelectPropOverrides } from '@availity/mui-form-utils';
+import { useState } from 'react';
+
+const meta: Meta<typeof Autocomplete> = {
+  title: 'Components/Autocomplete/Autocomplete',
+  component: Autocomplete,
+  tags: ['autodocs'],
+  args: {
+    options: ['1', '2', '3', '4', '5'],
+  },
+};
+
+export default meta;
+
+export const _Autocomplete: StoryObj<typeof Autocomplete> = {
+  render: (args) => <Autocomplete {...args} />,
+  args: {
+    FieldProps: { label: 'AvTextField' },
+  },
+};
+
+export const _Variants: StoryObj<typeof Autocomplete> = {
+  render: (args) => (
+    <>
+      <Autocomplete {...args} FieldProps={{ label: 'Single Select', margin: 'normal' }} />
+      <Autocomplete {...args} FieldProps={{ label: 'Multi Select', margin: 'normal' }} multiple />
+    </>
+  ),
+};

package/src/lib/Autocomplete.test.tsx

@@ -0,0 +1,9 @@
+import { render } from '@testing-library/react';
+import { Autocomplete } from './Autocomplete';
+
+describe('Autocomplete', () => {
+  test('should render successfully', () => {
+    const { getByLabelText } = render(<Autocomplete FieldProps={{ label: 'Test' }} options={['1', '2', '3']} />);
+    expect(getByLabelText('Test')).toBeTruthy();
+  });
+});

package/src/lib/Autocomplete.tsx

@@ -0,0 +1,37 @@
+import {
+  Autocomplete as MuiAutocomplete,
+  AutocompleteProps as MuiAutocompleteProps,
+  AutocompleteRenderInputParams,
+  ChipTypeMap,
+} from '@mui/material';
+import { TextField, TextFieldProps } from '@availity/mui-textfield';
+import { SelectPropOverrides } from '@availity/mui-form-utils';
+
+export interface AutocompleteProps<
+  T,
+  Multiple extends boolean | undefined,
+  DisableClearable extends boolean | undefined,
+  FreeSolo extends boolean | undefined,
+  ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']
+> extends Omit<MuiAutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>, 'renderInput'> {
+  FieldProps?: TextFieldProps;
+}
+
+export const Autocomplete = <
+  T,
+  Multiple extends boolean | undefined = false,
+  DisableClearable extends boolean | undefined = false,
+  FreeSolo extends boolean | undefined = false,
+  ChipComponent extends React.ElementType = ChipTypeMap['defaultComponent']
+>({
+  FieldProps,
+  ...props
+}: AutocompleteProps<T, Multiple, DisableClearable, FreeSolo, ChipComponent>): JSX.Element => {
+  return (
+    <MuiAutocomplete
+      renderInput={(params: AutocompleteRenderInputParams) => <TextField {...FieldProps} {...params} />}
+      popupIcon={<SelectPropOverrides.IconComponent />}
+      {...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"]
+}