@availity/mui-textfield 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## 0.1.0 (2023-09-25)
+
+
+### Features
+
+* **mui-form-utils:** move Input to form-utils pkg ([991596c](https://github.com/Availity/element/commit/991596c5256360979c58e4e7c36313a7f1f4ce09))
+* **mui-textfield:** add textfield component ([edf7e72](https://github.com/Availity/element/commit/edf7e728e9e8a79ee78219e41fc5659d175d70e5))
+* **mui-textfield:** add textfield component ([fec1a7f](https://github.com/Availity/element/commit/fec1a7fedda2420577e29b6c0e264d244a91a00e))
+* **mui-textfield:** update styles ([69f8291](https://github.com/Availity/element/commit/69f82910269a6fdcd2b5de852b3c8a777c09b24d))
+* **mui-textfield:** use mui-form-utils ([9623a25](https://github.com/Availity/element/commit/9623a25fc8b6cfafa8c53e383450f501f3068af8))
+
+
+### Bug Fixes
+
+* **mui-textfield:** fix test ([81d11c4](https://github.com/Availity/element/commit/81d11c47900aaccd7bf2d27a2c6ec51544083325))
+* **mui-textfield:** remove unneeded aria-labelledby ([2c20c98](https://github.com/Availity/element/commit/2c20c98eee1f163525b0198cf4b9f5188342c09a))

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import * as react from 'react';
+import { InputProps } from '@availity/mui-form-utils';
+
+type TextFieldProps = {
+    helperText?: string;
+} & Omit<InputProps, 'aria-describedby' | 'classes' | 'disableInjectingGlobalStyles' | 'color' | 'multiline' | 'notched' | 'fullWidth' | 'inputProps'>;
+declare const TextField: react.ForwardRefExoticComponent<Pick<TextFieldProps, "className" | "style" | "label" | "slot" | "title" | "id" | "lang" | "name" | "type" | "role" | "tabIndex" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "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" | "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" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "nonce" | "placeholder" | "spellCheck" | "translate" | "radioGroup" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "autoFocus" | "disabled" | "value" | "autoComplete" | "readOnly" | "required" | "size" | "rows" | "error" | "margin" | "inputRef" | "endAdornment" | "renderSuffix" | "maxRows" | "minRows" | "startAdornment" | "helperText"> & react.RefAttributes<unknown>>;
+
+export { TextField, TextFieldProps };

package/dist/index.js

@@ -0,0 +1,94 @@
+"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, {
+  TextField: () => TextField
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/TextField.tsx
+var import_react = require("react");
+var import_FormControl = __toESM(require("@mui/material/FormControl"));
+var import_InputAdornment = __toESM(require("@mui/material/InputAdornment"));
+var import_FormHelperText = __toESM(require("@mui/material/FormHelperText"));
+var import_mui_form_utils = require("@availity/mui-form-utils");
+var import_mui_icon = require("@availity/mui-icon");
+var import_jsx_runtime = require("react/jsx-runtime");
+var smallStyles = { sx: { padding: "8px 8px" } };
+var mediumStyles = { sx: { padding: "16px 8px" } };
+var iconStyles = { marginRight: "4px", paddingTop: "4px" };
+var TextField = (0, import_react.forwardRef)(
+  ({ error, helperText, id, label, startAdornment, endAdornment, required, size, ...rest }, ref) => {
+    const labelId = `${id}-label`;
+    const helperId = `${id}-helper-text`;
+    return /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_FormControl.default, {
+      size: "small",
+      children: [
+        label && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_form_utils.FormLabel, {
+          id: labelId,
+          htmlFor: id,
+          required,
+          error: !!error,
+          disabled: rest.disabled,
+          children: label
+        }),
+        /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_form_utils.Input, {
+          inputRef: ref,
+          id,
+          "aria-describedby": helperId,
+          error: !!error,
+          inputProps: size === "medium" ? mediumStyles : smallStyles,
+          startAdornment: startAdornment ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_InputAdornment.default, {
+            position: "start",
+            children: startAdornment
+          }) : void 0,
+          endAdornment: endAdornment ? /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_InputAdornment.default, {
+            position: "end",
+            children: endAdornment
+          }) : void 0,
+          size,
+          ...rest
+        }),
+        /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_FormHelperText.default, {
+          id: helperId,
+          error,
+          children: [
+            error && /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_icon.WarningTriangleIcon, {
+              sx: iconStyles
+            }),
+            helperText
+          ]
+        })
+      ]
+    });
+  }
+);
+TextField.displayName = "TextField";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TextField
+});

package/dist/index.mjs

@@ -0,0 +1,61 @@
+// src/lib/TextField.tsx
+import { forwardRef } from "react";
+import FormControl from "@mui/material/FormControl";
+import InputAdornment from "@mui/material/InputAdornment";
+import FormHelperText from "@mui/material/FormHelperText";
+import { FormLabel, Input } from "@availity/mui-form-utils";
+import { WarningTriangleIcon } from "@availity/mui-icon";
+import { jsx, jsxs } from "react/jsx-runtime";
+var smallStyles = { sx: { padding: "8px 8px" } };
+var mediumStyles = { sx: { padding: "16px 8px" } };
+var iconStyles = { marginRight: "4px", paddingTop: "4px" };
+var TextField = forwardRef(
+  ({ error, helperText, id, label, startAdornment, endAdornment, required, size, ...rest }, ref) => {
+    const labelId = `${id}-label`;
+    const helperId = `${id}-helper-text`;
+    return /* @__PURE__ */ jsxs(FormControl, {
+      size: "small",
+      children: [
+        label && /* @__PURE__ */ jsx(FormLabel, {
+          id: labelId,
+          htmlFor: id,
+          required,
+          error: !!error,
+          disabled: rest.disabled,
+          children: label
+        }),
+        /* @__PURE__ */ jsx(Input, {
+          inputRef: ref,
+          id,
+          "aria-describedby": helperId,
+          error: !!error,
+          inputProps: size === "medium" ? mediumStyles : smallStyles,
+          startAdornment: startAdornment ? /* @__PURE__ */ jsx(InputAdornment, {
+            position: "start",
+            children: startAdornment
+          }) : void 0,
+          endAdornment: endAdornment ? /* @__PURE__ */ jsx(InputAdornment, {
+            position: "end",
+            children: endAdornment
+          }) : void 0,
+          size,
+          ...rest
+        }),
+        /* @__PURE__ */ jsxs(FormHelperText, {
+          id: helperId,
+          error,
+          children: [
+            error && /* @__PURE__ */ jsx(WarningTriangleIcon, {
+              sx: iconStyles
+            }),
+            helperText
+          ]
+        })
+      ]
+    });
+  }
+);
+TextField.displayName = "TextField";
+export {
+  TextField
+};

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

package/jest.config.js

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

package/package.json

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

package/src/lib/TextField.stories.tsx

@@ -0,0 +1,45 @@
+// Each exported component in the package should have its own stories file
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+import { EyeIcon, EyeSlashIcon } from '@availity/mui-icon';
+import { IconButton } from '@availity/mui-button';
+
+import { TextField, TextFieldProps } from './TextField';
+
+const meta: Meta<typeof TextField> = {
+  title: 'Components/TextField/TextField',
+  component: TextField,
+  tags: ['autodocs'],
+};
+
+export default meta;
+
+export const _TextField: StoryObj<typeof TextField> = {
+  render: (args: TextFieldProps) => <TextField {...args} />,
+  args: {
+    label: 'Field Label',
+    id: 'test',
+  },
+};
+
+export const _PasswordField: StoryObj<typeof TextField> = {
+  render: (args: TextFieldProps) => {
+    const [showPassword, setShowPassword] = useState(false);
+
+    return (
+      <TextField
+        {...args}
+        type={showPassword ? 'text' : 'password'}
+        id="password"
+        endAdornment={
+          <IconButton title="password visibility toggle" onClick={() => setShowPassword((prev) => !prev)}>
+            {showPassword ? <EyeIcon /> : <EyeSlashIcon />}
+          </IconButton>
+        }
+      />
+    );
+  },
+  args: {
+    label: 'Password',
+  },
+};

package/src/lib/TextField.test.tsx

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

package/src/lib/TextField.tsx

@@ -0,0 +1,60 @@
+import { forwardRef } from 'react';
+import FormControl from '@mui/material/FormControl';
+import InputAdornment from '@mui/material/InputAdornment';
+import FormHelperText from '@mui/material/FormHelperText';
+import { FormLabel, Input, InputProps } from '@availity/mui-form-utils';
+import { WarningTriangleIcon } from '@availity/mui-icon';
+
+export type TextFieldProps = {
+  helperText?: string;
+} & Omit<
+  InputProps,
+  | 'aria-describedby'
+  | 'classes'
+  | 'disableInjectingGlobalStyles'
+  | 'color'
+  | 'multiline'
+  | 'notched'
+  | 'fullWidth'
+  | 'inputProps'
+>;
+
+const smallStyles = { sx: { padding: '8px 8px' } };
+const mediumStyles = { sx: { padding: '16px 8px' } };
+const iconStyles = { marginRight: '4px', paddingTop: '4px' };
+
+export const TextField = forwardRef(
+  ({ error, helperText, id, label, startAdornment, endAdornment, required, size, ...rest }: TextFieldProps, ref) => {
+    const labelId = `${id}-label`;
+    const helperId = `${id}-helper-text`;
+
+    return (
+      <FormControl size="small">
+        {label && (
+          <FormLabel id={labelId} htmlFor={id} required={required} error={!!error} disabled={rest.disabled}>
+            {label}
+          </FormLabel>
+        )}
+        <Input
+          inputRef={ref}
+          id={id}
+          aria-describedby={helperId}
+          error={!!error}
+          inputProps={size === 'medium' ? mediumStyles : smallStyles}
+          startAdornment={
+            startAdornment ? <InputAdornment position="start">{startAdornment}</InputAdornment> : undefined
+          }
+          endAdornment={endAdornment ? <InputAdornment position="end">{endAdornment}</InputAdornment> : undefined}
+          size={size}
+          {...rest}
+        />
+        <FormHelperText id={helperId} error={error}>
+          {error && <WarningTriangleIcon sx={iconStyles} />}
+          {helperText}
+        </FormHelperText>
+      </FormControl>
+    );
+  }
+);
+
+TextField.displayName = 'TextField';

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