@availity/mui-chip 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 (2023-06-16)
+
+
+### Features
+
+* **mui-chip:** initial commit ([7729cfc](https://github.com/Availity/element/commit/7729cfce5f19b0f286c48275d609eadcb9534cdd))

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { ChipProps as ChipProps$1 } from '@mui/material';
+
+type ChipProps = {
+    /** The color of the component. Nondefault colors are only to be used with size `small`.
+     * @default default */
+    color?: 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
+    /** The size of the component. Size `small` is for statuses and inline counters. */
+    size?: 'small' | 'medium';
+} & Omit<ChipProps$1, 'children' | 'color' | 'variant' | 'skipFocusWhenDisabled' | 'disabled' | 'size' | 'icon' | 'clickable'>;
+declare const Chip: ({ color, onDelete, ...rest }: ChipProps) => JSX.Element;
+
+export { Chip, ChipProps };

package/dist/index.js

@@ -0,0 +1,41 @@
+"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, {
+  Chip: () => Chip
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/Chip.tsx
+var import_material = require("@mui/material");
+var import_jsx_runtime = require("react/jsx-runtime");
+var Chip = ({ color = "default", onDelete, ...rest }) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.Chip, {
+    color,
+    onClick: onDelete,
+    onDelete,
+    ...rest
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Chip
+});

package/dist/index.mjs

@@ -0,0 +1,14 @@
+// src/lib/Chip.tsx
+import { Chip as MuiChip } from "@mui/material";
+import { jsx } from "react/jsx-runtime";
+var Chip = ({ color = "default", onDelete, ...rest }) => {
+  return /* @__PURE__ */ jsx(MuiChip, {
+    color,
+    onClick: onDelete,
+    onDelete,
+    ...rest
+  });
+};
+export {
+  Chip
+};

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

package/jest.config.js

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

package/package.json

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

package/src/lib/Chip.stories.tsx

@@ -0,0 +1,72 @@
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+import { Avatar, Collapse } from '@mui/material';
+import { Chip, ChipProps } from './Chip';
+
+const meta: Meta<typeof Chip> = {
+  title: 'Components/Chip/Chip',
+  component: Chip,
+  tags: ['autodocs'],
+  args: {
+    label: 'Chip',
+    size: 'medium',
+    color: 'default',
+  },
+};
+
+export default meta;
+
+export const _Chip: StoryObj<typeof Chip> = {
+  render: (args: ChipProps) => <Chip {...args} />,
+  args: {
+    label: 'Chip',
+  },
+};
+
+export const _RemovableChip: StoryObj<typeof Chip> = {
+  render: (args: ChipProps) => {
+    const [visible, setVisible] = useState(true);
+
+    const onDelete = () => {
+      setVisible(false);
+      setTimeout(() => setVisible(true), 1000);
+    };
+
+    return (
+      <Collapse in={visible}>
+        <Chip {...args} onDelete={onDelete} />
+      </Collapse>
+    );
+  },
+};
+
+export const _Avatar: StoryObj<typeof Chip> = {
+  render: (args: ChipProps) => <Chip {...args} avatar={<Avatar>A</Avatar>} />,
+};
+
+/** Status styling is achieved by using size `small` */
+export const _Status: StoryObj<typeof Chip> = {
+  render: () => (
+    <>
+      Item 1 <Chip color="success" label="Approved" size="small" />
+      <br />
+      Item 2 <Chip color="info" label="Info" size="small" />
+      <br />
+      Item 3 <Chip color="warning" label="Pending" size="small" />
+      <br />
+      Item 4 <Chip color="error" label="Declined" size="small" />
+      <br />
+      Item 5 <Chip color="secondary" label="Neutral" size="small" />
+      <br />
+    </>
+  ),
+};
+
+/** Inline counter styling is achieved by using size `small`. For counters that affix to the corner of an element see `Badge`. */
+export const _InlineCounter: StoryObj<typeof Chip> = {
+  render: () => (
+    <div>
+      Items <Chip color="error" label="5" size="small" />
+    </div>
+  ),
+};

package/src/lib/Chip.test.tsx

@@ -0,0 +1,17 @@
+import { render } from '@testing-library/react';
+import { Chip } from './Chip';
+
+describe('Chip', () => {
+  test('should render successfully', () => {
+    const { getByText } = render(<Chip label="Test" />);
+    expect(getByText('Test')).toBeTruthy();
+  });
+  test('should have clickable styling when onDelete passed', () => {
+    const onDelete = () => {
+      // do nothing
+    };
+    const { getByRole } = render(<Chip label="Test" onDelete={onDelete} />);
+    expect(getByRole('button')).toBeTruthy();
+    expect(getByRole('button')).toHaveClass('MuiChip-clickable');
+  });
+});

package/src/lib/Chip.tsx

@@ -0,0 +1,16 @@
+import { Chip as MuiChip, ChipProps as MuiChipProps } from '@mui/material';
+
+export type ChipProps = {
+  /** The color of the component. Nondefault colors are only to be used with size `small`.
+   * @default default */
+  color?: 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
+  /** The size of the component. Size `small` is for statuses and inline counters. */
+  size?: 'small' | 'medium';
+} & Omit<
+  MuiChipProps,
+  'children' | 'color' | 'variant' | 'skipFocusWhenDisabled' | 'disabled' | 'size' | 'icon' | 'clickable'
+>;
+
+export const Chip = ({ color = 'default', onDelete, ...rest }: ChipProps): JSX.Element => {
+  return <MuiChip color={color} onClick={onDelete} onDelete={onDelete} {...rest} />;
+};

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"]
+}