@availity/mui-checkbox 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-10-04)
+
+
+### Features
+
+* **mui-checkbox:** init ([c7200a8](https://github.com/Availity/element/commit/c7200a84175174f43d502b47881dd7e57e02aa0e))

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import * as react from 'react';
+import { CheckboxProps as CheckboxProps$1 } from '@mui/material';
+
+interface CheckboxProps extends Omit<CheckboxProps$1, 'size'> {
+    children?: React.ReactNode;
+    color?: 'primary' | 'error';
+}
+declare const Checkbox: react.ForwardRefExoticComponent<Pick<CheckboxProps, "classes" | "checkedIcon" | "color" | "icon" | "className" | "style" | "form" | "slot" | "title" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "nonce" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onResize" | "onResizeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "action" | "centerRipple" | "disabled" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "sx" | "TouchRippleProps" | "touchRippleRef" | "key" | "autoFocus" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "name" | "value" | "checked" | "disableFocusRipple" | "edge" | "inputProps" | "inputRef" | "readOnly" | "required" | "indeterminate" | "indeterminateIcon"> & react.RefAttributes<HTMLButtonElement>>;
+
+export { Checkbox, CheckboxProps };

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, {
+  Checkbox: () => Checkbox
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/Checkbox.tsx
+var import_react = require("react");
+var import_material = require("@mui/material");
+var import_jsx_runtime = require("react/jsx-runtime");
+var Checkbox = (0, import_react.forwardRef)((props, ref) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.Checkbox, {
+    ...props,
+    ref,
+    size: "medium"
+  });
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Checkbox
+});

package/dist/index.mjs

@@ -0,0 +1,14 @@
+// src/lib/Checkbox.tsx
+import { forwardRef } from "react";
+import { Checkbox as MuiCheckbox } from "@mui/material";
+import { jsx } from "react/jsx-runtime";
+var Checkbox = forwardRef((props, ref) => {
+  return /* @__PURE__ */ jsx(MuiCheckbox, {
+    ...props,
+    ref,
+    size: "medium"
+  });
+});
+export {
+  Checkbox
+};

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

package/jest.config.js

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

package/package.json

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

package/src/lib/Checkbox.stories.tsx

@@ -0,0 +1,136 @@
+// Each exported component in the package should have its own stories file
+
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+import { FormControlLabel } from '@availity/mui-form-utils';
+import { Box, FormGroup } from '@mui/material';
+import { HeartEmptyIcon, HeartIcon } from '@availity/mui-icon';
+import { Checkbox, CheckboxProps } from './Checkbox';
+
+const meta: Meta<typeof Checkbox> = {
+  title: 'Components/Checkbox/Checkbox',
+  component: Checkbox,
+  tags: ['autodocs'],
+};
+
+export default meta;
+
+export const _Checkbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => (
+    <>
+      <Checkbox {...args} defaultChecked />
+      <Checkbox {...args} />
+      <Checkbox {...args} disabled />
+      <Checkbox {...args} disabled checked />
+    </>
+  ),
+  args: {
+    color: 'primary',
+  },
+};
+
+export const _CustomCheckbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => (
+    <>
+      <Checkbox {...args} defaultChecked />
+      <Checkbox {...args} />
+      <Checkbox {...args} disabled />
+      <Checkbox {...args} disabled checked />
+    </>
+  ),
+  args: {
+    color: 'error',
+    icon: <HeartEmptyIcon />,
+    checkedIcon: <HeartIcon />,
+  },
+};
+
+export const _LabeledCheckbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => (
+    <>
+      <FormControlLabel control={<Checkbox {...args} defaultChecked />} label="Label" />
+      <FormControlLabel required control={<Checkbox {...args} />} label="Required" />
+      <FormControlLabel disabled control={<Checkbox {...args} />} label="Disabled" />
+    </>
+  ),
+  args: {
+    children: 'This text is a child of Checkbox',
+  },
+};
+
+export const _ControlledCheckbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => {
+    const [checked, setChecked] = useState(false);
+    const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => setChecked(event.target.checked);
+    return <Checkbox {...args} checked={checked} onChange={handleChange} inputProps={{ 'aria-label': 'controlled' }} />;
+  },
+  args: {
+    children: 'This text is a child of Checkbox',
+  },
+};
+export const _IndeterminateCheckbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => {
+    const [checked, setChecked] = useState([true, false]);
+
+    const handleChange1 = (event: React.ChangeEvent<HTMLInputElement>) => {
+      setChecked([event.target.checked, event.target.checked]);
+    };
+
+    const handleChange2 = (event: React.ChangeEvent<HTMLInputElement>) => {
+      setChecked([event.target.checked, checked[1]]);
+    };
+
+    const handleChange3 = (event: React.ChangeEvent<HTMLInputElement>) => {
+      setChecked([checked[0], event.target.checked]);
+    };
+
+    const children = (
+      <Box sx={{ display: 'flex', flexDirection: 'column', ml: 3 }}>
+        <FormControlLabel label="Child 1" control={<Checkbox checked={checked[0]} onChange={handleChange2} />} />
+        <FormControlLabel label="Child 2" control={<Checkbox checked={checked[1]} onChange={handleChange3} />} />
+      </Box>
+    );
+    return (
+      <div>
+        <FormControlLabel
+          label="Parent"
+          control={
+            <Checkbox
+              {...args}
+              checked={checked[0] && checked[1]}
+              indeterminate={checked[0] !== checked[1]}
+              onChange={handleChange1}
+            />
+          }
+        />
+        {children}
+      </div>
+    );
+  },
+  args: {},
+};
+
+export const _FormGroupCheckbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => (
+    <FormGroup>
+      <FormControlLabel control={<Checkbox {...args} defaultChecked />} label="Label" />
+      <FormControlLabel required control={<Checkbox {...args} />} label="Required" />
+      <FormControlLabel disabled control={<Checkbox {...args} />} label="Disabled" />
+    </FormGroup>
+  ),
+  args: {
+    color: 'primary',
+  },
+};
+export const _FormGroupHorizontalCheckbox: StoryObj<typeof Checkbox> = {
+  render: (args: CheckboxProps) => (
+    <FormGroup row>
+      <FormControlLabel control={<Checkbox {...args} defaultChecked />} label="Label" />
+      <FormControlLabel required control={<Checkbox {...args} />} label="Required" />
+      <FormControlLabel disabled control={<Checkbox {...args} />} label="Disabled" />
+    </FormGroup>
+  ),
+  args: {
+    color: 'primary',
+  },
+};

package/src/lib/Checkbox.test.tsx

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

package/src/lib/Checkbox.tsx

@@ -0,0 +1,11 @@
+import { forwardRef } from 'react';
+import { Checkbox as MuiCheckbox, CheckboxProps as MuiCheckboxProps } from '@mui/material';
+
+export interface CheckboxProps extends Omit<MuiCheckboxProps, 'size'> {
+  children?: React.ReactNode;
+  color?: 'primary' | 'error';
+}
+
+export const Checkbox = forwardRef<HTMLButtonElement, CheckboxProps>((props, ref) => {
+  return <MuiCheckbox {...props} ref={ref} size="medium" />;
+});

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