@availity/mui-pagination 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-09-11)
+
+
+### Features
+
+* **mui-pagination:** add pagination package ([dfe53b0](https://github.com/Availity/element/commit/dfe53b0a3e3b02506fc922ca8beef70d6919b3b0))

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { PaginationProps as PaginationProps$1, PaginationItemProps as PaginationItemProps$1 } from '@mui/material';
+
+type PaginationProps = Omit<PaginationProps$1, 'color' | 'shape' | 'renderItem'>;
+declare const Pagination: ({ ...rest }: PaginationProps) => JSX.Element;
+
+type PaginationItemProps = Omit<PaginationItemProps$1, 'components' | 'color' | 'shape'>;
+declare const PaginationItem: (props: PaginationItemProps) => JSX.Element;
+
+export { Pagination, PaginationItem, PaginationItemProps, PaginationProps };

package/dist/index.js

@@ -0,0 +1,90 @@
+"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, {
+  Pagination: () => Pagination,
+  PaginationItem: () => PaginationItem
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/lib/Pagination.tsx
+var import_material2 = require("@mui/material");
+
+// src/lib/PaginationItem.tsx
+var import_material = require("@mui/material");
+var import_mui_icon = require("@availity/mui-icon");
+var import_jsx_runtime = require("react/jsx-runtime");
+var slots = {
+  first: () => /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
+    children: [
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_icon.NavigatePreviousIcon, {
+        sx: { mr: ".2rem" }
+      }),
+      " First"
+    ]
+  }),
+  previous: () => /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
+    children: [
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_icon.NavigatePreviousIcon, {
+        sx: { mr: ".2rem" }
+      }),
+      " Prev"
+    ]
+  }),
+  next: () => /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
+    children: [
+      "Next ",
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_icon.NavigateNextIcon, {
+        sx: { ml: ".2rem" }
+      })
+    ]
+  }),
+  last: () => /* @__PURE__ */ (0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
+    children: [
+      "Last ",
+      /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_mui_icon.NavigateNextIcon, {
+        sx: { ml: ".2rem" }
+      })
+    ]
+  })
+};
+var PaginationItem = (props) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material.PaginationItem, {
+    slots,
+    ...props
+  });
+};
+
+// src/lib/Pagination.tsx
+var import_jsx_runtime = require("react/jsx-runtime");
+var Pagination = ({ ...rest }) => {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_material2.Pagination, {
+    ...rest,
+    renderItem: (item) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)(PaginationItem, {
+      ...item
+    })
+  });
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Pagination,
+  PaginationItem
+});

package/dist/index.mjs

@@ -0,0 +1,64 @@
+// src/lib/Pagination.tsx
+import {
+  Pagination as MuiPagination
+} from "@mui/material";
+
+// src/lib/PaginationItem.tsx
+import { PaginationItem as MuiPaginationItem } from "@mui/material";
+import { NavigateNextIcon, NavigatePreviousIcon } from "@availity/mui-icon";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+var slots = {
+  first: () => /* @__PURE__ */ jsxs(Fragment, {
+    children: [
+      /* @__PURE__ */ jsx(NavigatePreviousIcon, {
+        sx: { mr: ".2rem" }
+      }),
+      " First"
+    ]
+  }),
+  previous: () => /* @__PURE__ */ jsxs(Fragment, {
+    children: [
+      /* @__PURE__ */ jsx(NavigatePreviousIcon, {
+        sx: { mr: ".2rem" }
+      }),
+      " Prev"
+    ]
+  }),
+  next: () => /* @__PURE__ */ jsxs(Fragment, {
+    children: [
+      "Next ",
+      /* @__PURE__ */ jsx(NavigateNextIcon, {
+        sx: { ml: ".2rem" }
+      })
+    ]
+  }),
+  last: () => /* @__PURE__ */ jsxs(Fragment, {
+    children: [
+      "Last ",
+      /* @__PURE__ */ jsx(NavigateNextIcon, {
+        sx: { ml: ".2rem" }
+      })
+    ]
+  })
+};
+var PaginationItem = (props) => {
+  return /* @__PURE__ */ jsx(MuiPaginationItem, {
+    slots,
+    ...props
+  });
+};
+
+// src/lib/Pagination.tsx
+import { jsx as jsx2 } from "react/jsx-runtime";
+var Pagination = ({ ...rest }) => {
+  return /* @__PURE__ */ jsx2(MuiPagination, {
+    ...rest,
+    renderItem: (item) => /* @__PURE__ */ jsx2(PaginationItem, {
+      ...item
+    })
+  });
+};
+export {
+  Pagination,
+  PaginationItem
+};

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

package/jest.config.js

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

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@availity/mui-pagination",
+  "version": "0.1.0",
+  "description": "Availity MUI Pagination Component - part of the @availity/element design system",
+  "keywords": [
+    "react",
+    "typescript",
+    "availity",
+    "mui"
+  ],
+  "homepage": "https://availity.github.io/element/?path=/docs/components-pagination-introduction--docs",
+  "bugs": {
+    "url": "https://github.com/Availity/element/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Availity/element.git",
+    "directory": "packages/pagination"
+  },
+  "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-icon": "0.4.1",
+    "@mui/material": "^5.11.9",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "tsup": "^5.12.7",
+    "typescript": "^4.6.4"
+  },
+  "peerDependencies": {
+    "@availity/mui-icon": "0.4.1",
+    "@mui/material": "^5.11.9",
+    "react": ">=16.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/project.json

@@ -0,0 +1,42 @@
+{
+  "name": "mui-pagination",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/pagination/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "options": {
+        "eslintConfig": ".eslintrc.json",
+        "lintFilePatterns": ["packages/pagination/**/*.{js,ts}"],
+        "silent": false,
+        "fix": false,
+        "cache": true,
+        "cacheLocation": "./node_modules/.cache/pagination/.eslintcache",
+        "maxWarnings": -1,
+        "quiet": false,
+        "noEslintrc": false,
+        "hasTypeAwareRules": true,
+        "cacheStrategy": "metadata"
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/pagination"],
+      "options": {
+        "jestConfig": "packages/pagination/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,2 @@
+export * from './lib/Pagination';
+export * from './lib/PaginationItem';

package/src/lib/Pagination.stories.tsx

@@ -0,0 +1,81 @@
+// Each exported component in the package should have its own stories file
+
+import type { Meta, StoryObj } from '@storybook/react';
+import { Grid } from '@mui/material';
+import { Pagination, PaginationProps } from './Pagination';
+
+const meta: Meta<typeof Pagination> = {
+  title: 'Components/Pagination/Pagination',
+  component: Pagination,
+  tags: ['autodocs'],
+  args: {
+    count: 10,
+  },
+  argTypes: {
+    size: {
+      table: {
+        defaultValue: { summary: `determined by Theme` },
+      },
+    },
+  },
+};
+
+export default meta;
+
+export const _Pagination: StoryObj<typeof Pagination> = {
+  render: (args: PaginationProps) => <Pagination {...args} />,
+};
+
+export const _Variants: StoryObj<typeof Pagination> = {
+  render: () => (
+    <Grid container spacing={1}>
+      <Grid item xs={2}>
+        Text
+      </Grid>
+      <Grid item xs={10}>
+        <Pagination variant="text" count={10} />
+      </Grid>
+      <Grid item xs={2}>
+        Outlined
+      </Grid>
+      <Grid item xs={10}>
+        <Pagination variant="outlined" count={10} />
+      </Grid>
+    </Grid>
+  ),
+};
+
+export const _FirstLast: StoryObj<typeof Pagination> = {
+  render: () => (
+    <Grid container spacing={1}>
+      <Grid item xs={2}>
+        Text
+      </Grid>
+      <Grid item xs={10}>
+        <Pagination
+          variant="text"
+          count={10}
+          boundaryCount={0}
+          hideNextButton
+          hidePrevButton
+          showFirstButton
+          showLastButton
+        />
+      </Grid>
+      <Grid item xs={2}>
+        Outlined
+      </Grid>
+      <Grid item xs={10}>
+        <Pagination
+          variant="outlined"
+          count={10}
+          boundaryCount={0}
+          hideNextButton
+          hidePrevButton
+          showFirstButton
+          showLastButton
+        />
+      </Grid>
+    </Grid>
+  ),
+};

package/src/lib/Pagination.test.tsx

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

package/src/lib/Pagination.tsx

@@ -0,0 +1,12 @@
+import {
+  Pagination as MuiPagination,
+  PaginationProps as MuiPaginationProps,
+  PaginationPropsSizeOverrides,
+} from '@mui/material';
+import { PaginationItem } from './PaginationItem';
+
+export type PaginationProps = Omit<MuiPaginationProps, 'color' | 'shape' | 'renderItem'>;
+
+export const Pagination = ({ ...rest }: PaginationProps): JSX.Element => {
+  return <MuiPagination {...rest} renderItem={(item) => <PaginationItem {...item} />} />;
+};

package/src/lib/PaginationItem.stories.tsx

@@ -0,0 +1,76 @@
+// Each exported component in the package should have its own stories file
+
+import type { Meta, StoryObj } from '@storybook/react';
+import { Grid } from '@mui/material';
+import { PaginationItem, PaginationItemProps } from './PaginationItem';
+
+const meta: Meta<typeof PaginationItem> = {
+  title: 'Components/Pagination/PaginationItem',
+  component: PaginationItem,
+  tags: ['autodocs'],
+  args: {
+    type: 'next',
+  },
+  argTypes: {
+    size: {
+      table: {
+        defaultValue: { summary: `determined by Theme` },
+      },
+    },
+  },
+};
+
+export default meta;
+
+export const _PaginationItem: StoryObj<typeof PaginationItem> = {
+  render: (args: PaginationItemProps) => <PaginationItem {...args} />,
+};
+
+export const _Types: StoryObj<typeof PaginationItem> = {
+  render: () => (
+    <Grid container spacing={1}>
+      <Grid item xs={3}>
+        Text
+      </Grid>
+      <Grid item xs={9}>
+        Outlined
+      </Grid>
+      <Grid item xs={3}>
+        <PaginationItem variant="text" type="page" page="1" selected />
+      </Grid>
+      <Grid item xs={9}>
+        <PaginationItem variant="outlined" type="page" page="1" selected />
+      </Grid>
+      <Grid item xs={3}>
+        <PaginationItem variant="text" type="page" page="1" />
+      </Grid>
+      <Grid item xs={9}>
+        <PaginationItem variant="outlined" type="page" page="1" />
+      </Grid>
+      <Grid item xs={3}>
+        <PaginationItem variant="text" type="first" />
+      </Grid>
+      <Grid item xs={9}>
+        <PaginationItem variant="outlined" type="first" />
+      </Grid>
+      <Grid item xs={3}>
+        <PaginationItem variant="text" type="previous" />
+      </Grid>
+      <Grid item xs={9}>
+        <PaginationItem variant="outlined" type="previous" />
+      </Grid>
+      <Grid item xs={3}>
+        <PaginationItem variant="text" type="next" />
+      </Grid>
+      <Grid item xs={9}>
+        <PaginationItem variant="outlined" type="next" />
+      </Grid>
+      <Grid item xs={3}>
+        <PaginationItem variant="text" type="last" />
+      </Grid>
+      <Grid item xs={9}>
+        <PaginationItem variant="outlined" type="last" />
+      </Grid>
+    </Grid>
+  ),
+};

package/src/lib/PaginationItem.test.tsx

@@ -0,0 +1,13 @@
+import { render } from '@testing-library/react';
+import { PaginationItem } from './PaginationItem';
+
+describe('PaginationItem', () => {
+  test('should render successfully', () => {
+    const { getByText } = render(<PaginationItem page={1} />);
+    expect(getByText('1')).toBeTruthy();
+  });
+  test('should replace default MUI prev/next iconbuttons', () => {
+    const { getByText } = render(<PaginationItem type="previous" />);
+    expect(getByText('Prev')).toBeTruthy();
+  });
+});

package/src/lib/PaginationItem.tsx

@@ -0,0 +1,31 @@
+import { PaginationItem as MuiPaginationItem, PaginationItemProps as MuiPaginationItemProps } from '@mui/material';
+import { NavigateNextIcon, NavigatePreviousIcon } from '@availity/mui-icon';
+
+export type PaginationItemProps = Omit<MuiPaginationItemProps, 'components' | 'color' | 'shape'>;
+
+const slots = {
+  first: () => (
+    <>
+      <NavigatePreviousIcon sx={{ mr: '.2rem' }} /> First
+    </>
+  ),
+  previous: () => (
+    <>
+      <NavigatePreviousIcon sx={{ mr: '.2rem' }} /> Prev
+    </>
+  ),
+  next: () => (
+    <>
+      Next <NavigateNextIcon sx={{ ml: '.2rem' }} />
+    </>
+  ),
+  last: () => (
+    <>
+      Last <NavigateNextIcon sx={{ ml: '.2rem' }} />
+    </>
+  ),
+};
+
+export const PaginationItem = (props: PaginationItemProps): JSX.Element => {
+  return <MuiPaginationItem slots={slots} {...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"]
+}