@pequity/squirrel 5.1.0 → 5.2.0

package/dist/es/p-icon.js

@@ -0,0 +1,9 @@
+const P_ICON_ALIASES = {
+  delete: "octicon:trash-24",
+  edit: "simple-line-icons:pencil",
+  send: "fa:paper-plane",
+  settings: "heroicons:cog-8-tooth-20-solid"
+};
+export {
+  P_ICON_ALIASES
+};

package/dist/squirrel/components/index.d.ts

@@ -12,6 +12,7 @@ import PDropdown from './p-dropdown/p-dropdown.vue';
 import PDropdownSelect from './p-dropdown-select/p-dropdown-select.vue';
 import PFileUpload from './p-file-upload/p-file-upload.vue';
 import PFilterIcon from './p-table-header-cell/p-table-filter-icon.vue';
+import PIcon from './p-icon/p-icon.vue';
 import PInfoIcon from './p-info-icon/p-info-icon.vue';
 import PInlineDatePicker from './p-inline-date-picker/p-inline-date-picker.vue';
 import PInput from './p-input/p-input.vue';
@@ -41,6 +42,7 @@ import PToggle from './p-toggle/p-toggle.vue';
 import { type FileUploadFile } from './p-file-upload/p-file-upload.types';
 import { type HeaderCellAttrs, MIN_WIDTH_COL_RESIZE, type TableCol, type ThAttrs, colsInjectionKey, isColsResizableInjectionKey, isFirstColFixedInjectionKey, isLastColFixedInjectionKey } from './p-table/p-table.types';
 import { type PActionBarAction } from './p-action-bar/p-action-bar.types';
+import { type PIconAlias, P_ICON_ALIASES } from './p-icon/p-icon.types';
 import { SORTING_TYPES, type SortingType, type SortingTypeWithoutNoSorting } from './p-table-sort/p-table-sort.config';
 import { type Size } from './p-btn/p-btn.types';
 import { usePLoading } from './p-loading/usePLoading';
@@ -48,4 +50,4 @@ import { usePModal } from './p-modal/usePModal';
 import { usePTableColResize } from './p-table/usePTableColResize';
 import { usePTableRowVirtualizer } from './p-table/usePTableRowVirtualizer';
 import { useSelectList } from './p-select-list/useSelectList';
-export { PActionBar, PActionBarAction, PAlert, PAvatar, PBtn, PCard, PCheckbox, PChips, PCloseBtn, PDatePicker, PDrawer, PDropdown, PDropdownSelect, PFileUpload, PFilterIcon, PInfoIcon, PInlineDatePicker, PInput, PInputNumber, PInputPercent, PInputSearch, PLink, PLoading, PModal, PPagination, PPaginationInfo, PProgressBar, PRingLoader, PSelect, PSelectBtn, PSelectList, PSelectPill, PSkeletonLoader, PTable, PTableHeaderCell, PTableLoader, PTableSort, PTableTd, PTabs, PTextarea, PToggle, SORTING_TYPES, MIN_WIDTH_COL_RESIZE, colsInjectionKey, isColsResizableInjectionKey, isFirstColFixedInjectionKey, isLastColFixedInjectionKey, usePModal, usePTableColResize, usePTableRowVirtualizer, useSelectList, usePLoading, SortingType, SortingTypeWithoutNoSorting, Size, FileUploadFile, HeaderCellAttrs, TableCol, ThAttrs, };
+export { PActionBar, PActionBarAction, PAlert, PAvatar, PBtn, PCard, PCheckbox, PChips, PCloseBtn, PDatePicker, PDrawer, PDropdown, PDropdownSelect, PFileUpload, PFilterIcon, PIcon, PInfoIcon, PInlineDatePicker, PInput, PInputNumber, PInputPercent, PInputSearch, PLink, PLoading, PModal, PPagination, PPaginationInfo, PProgressBar, PRingLoader, PSelect, PSelectBtn, PSelectList, PSelectPill, PSkeletonLoader, PTable, PTableHeaderCell, PTableLoader, PTableSort, PTableTd, PTabs, PTextarea, PToggle, SORTING_TYPES, MIN_WIDTH_COL_RESIZE, P_ICON_ALIASES, colsInjectionKey, isColsResizableInjectionKey, isFirstColFixedInjectionKey, isLastColFixedInjectionKey, usePModal, usePTableColResize, usePTableRowVirtualizer, useSelectList, usePLoading, SortingType, SortingTypeWithoutNoSorting, Size, FileUploadFile, HeaderCellAttrs, TableCol, ThAttrs, PIconAlias, };

package/dist/squirrel/components/p-icon/p-icon.types.d.ts

@@ -0,0 +1,7 @@
+export declare const P_ICON_ALIASES: {
+    readonly delete: "octicon:trash-24";
+    readonly edit: "simple-line-icons:pencil";
+    readonly send: "fa:paper-plane";
+    readonly settings: "heroicons:cog-8-tooth-20-solid";
+};
+export type PIconAlias = keyof typeof P_ICON_ALIASES;

package/dist/squirrel/components/p-icon/p-icon.vue.d.ts

@@ -0,0 +1,17 @@
+import { type IconifyIconAttributes } from 'iconify-icon';
+import { type PIconAlias } from './p-icon.types';
+import 'iconify-icon';
+interface Props extends /* @vue-ignore */ Omit<IconifyIconAttributes, 'icon'> {
+    icon: IconifyIconAttributes['icon'] | PIconAlias;
+}
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<Props>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<Props>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@pequity/squirrel",
   "description": "Squirrel component library",
-  "version": "5.1.0",
-  "packageManager": "pnpm@9.9.0",
+  "version": "5.2.0",
+  "packageManager": "pnpm@9.10.0",
   "type": "module",
   "scripts": {
     "preinstall": "npx only-allow pnpm",
@@ -52,27 +52,27 @@
   "devDependencies": {
     "@babel/core": "^7.25.2",
     "@babel/preset-env": "^7.25.4",
-    "@commitlint/cli": "^19.4.1",
-    "@commitlint/config-conventional": "^19.4.1",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
     "@pequity/eslint-config": "^0.0.13",
     "@playwright/test": "^1.47.0",
     "@popperjs/core": "2.11.8",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@storybook/addon-a11y": "^8.2.9",
-    "@storybook/addon-actions": "^8.2.9",
-    "@storybook/addon-essentials": "^8.2.9",
-    "@storybook/addon-interactions": "^8.2.9",
-    "@storybook/addon-links": "^8.2.9",
-    "@storybook/blocks": "^8.2.9",
-    "@storybook/manager-api": "^8.2.9",
-    "@storybook/test": "^8.2.9",
+    "@storybook/addon-a11y": "^8.3.0",
+    "@storybook/addon-actions": "^8.3.0",
+    "@storybook/addon-essentials": "^8.3.0",
+    "@storybook/addon-interactions": "^8.3.0",
+    "@storybook/addon-links": "^8.3.0",
+    "@storybook/blocks": "^8.3.0",
+    "@storybook/manager-api": "^8.3.0",
+    "@storybook/test": "^8.3.0",
     "@storybook/test-runner": "^0.19.1",
-    "@storybook/theming": "^8.2.9",
-    "@storybook/vue3": "^8.2.9",
-    "@storybook/vue3-vite": "^8.2.9",
+    "@storybook/theming": "^8.3.0",
+    "@storybook/vue3": "^8.3.0",
+    "@storybook/vue3-vite": "^8.3.0",
     "@tanstack/vue-virtual": "3.10.7",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.13",
     "@types/jsdom": "^21.1.7",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^22.5.4",
@@ -87,7 +87,8 @@
     "eslint-plugin-storybook": "^0.8.0",
     "floating-vue": "5.2.2",
     "glob": "^11.0.0",
-    "husky": "^9.1.5",
+    "husky": "^9.1.6",
+    "iconify-icon": "^2.1.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "lint-staged": "^15.2.10",
@@ -100,16 +101,16 @@
     "rimraf": "^6.0.1",
     "sass": "^1.78.0",
     "semantic-release": "^24.1.1",
-    "storybook": "^8.2.9",
+    "storybook": "^8.3.0",
     "svgo": "^3.3.2",
-    "tailwindcss": "^3.4.10",
+    "tailwindcss": "^3.4.11",
     "ts-jest": "^29.2.5",
     "typescript": "5.5.4",
     "v-calendar": "3.1.2",
-    "vite": "^5.4.3",
+    "vite": "^5.4.4",
     "vue": "3.4.38",
     "vue-currency-input": "3.1.0",
-    "vue-router": "4.4.3",
+    "vue-router": "4.4.5",
     "vue-toastification": "2.0.0-rc.5",
     "vue-tsc": "2.1.6"
   }

package/squirrel/components/index.ts

@@ -12,6 +12,7 @@ import PDropdown from '@squirrel/components/p-dropdown/p-dropdown.vue';
 import PDropdownSelect from '@squirrel/components/p-dropdown-select/p-dropdown-select.vue';
 import PFileUpload from '@squirrel/components/p-file-upload/p-file-upload.vue';
 import PFilterIcon from '@squirrel/components/p-table-header-cell/p-table-filter-icon.vue';
+import PIcon from '@squirrel/components/p-icon/p-icon.vue';
 import PInfoIcon from '@squirrel/components/p-info-icon/p-info-icon.vue';
 import PInlineDatePicker from '@squirrel/components/p-inline-date-picker/p-inline-date-picker.vue';
 import PInput from '@squirrel/components/p-input/p-input.vue';
@@ -50,6 +51,7 @@ import {
   isLastColFixedInjectionKey,
 } from '@squirrel/components/p-table/p-table.types';
 import { type PActionBarAction } from '@squirrel/components/p-action-bar/p-action-bar.types';
+import { type PIconAlias, P_ICON_ALIASES } from '@squirrel/components/p-icon/p-icon.types';
 import {
   SORTING_TYPES,
   type SortingType,
@@ -78,6 +80,7 @@ export {
   PDropdownSelect,
   PFileUpload,
   PFilterIcon,
+  PIcon,
   PInfoIcon,
   PInlineDatePicker,
   PInput,
@@ -106,6 +109,7 @@ export {
   PToggle,
   SORTING_TYPES,
   MIN_WIDTH_COL_RESIZE,
+  P_ICON_ALIASES,
   colsInjectionKey,
   isColsResizableInjectionKey,
   isFirstColFixedInjectionKey,
@@ -122,4 +126,5 @@ export {
   HeaderCellAttrs,
   TableCol,
   ThAttrs,
+  PIconAlias,
 };

package/squirrel/components/p-icon/p-icon.spec.js

@@ -0,0 +1,79 @@
+import PIcon from '@squirrel/components/p-icon/p-icon.vue';
+import { P_ICON_ALIASES } from '@squirrel/components/p-icon/p-icon.types';
+import { createWrapperFor } from '@tests/jest.helpers';
+
+const createWrapper = (props, attrs) => {
+  return createWrapperFor(PIcon, {
+    props: {
+      icon: 'ant-design:build-twotone',
+      ...props,
+    },
+    attrs,
+    global: {
+      stubs: {
+        'iconify-icon': true,
+      },
+    },
+  });
+};
+
+describe('PIcon.vue', () => {
+  it('renders an icon', async () => {
+    const wrapper = createWrapper({
+      icon: 'ant-design:build-twotone',
+    });
+
+    const icon = wrapper.findComponent('iconify-icon-stub');
+
+    expect(icon.exists()).toBe(true);
+    expect(icon.attributes().icon).toBe('ant-design:build-twotone');
+  });
+
+  it('passes arbitrary attrs to the icon component', async () => {
+    const wrapper = createWrapper({}, { 'data-test': 'test' });
+
+    const icon = wrapper.findComponent('iconify-icon-stub');
+
+    expect(icon.attributes()['data-test']).toBe('test');
+  });
+
+  it('passes down events to the icon component', async () => {
+    const clickFn = jest.fn();
+
+    const wrapper = createWrapperFor(
+      {
+        template: '<PIcon icon="ant-design:build-twotone" @click="onClick" />',
+        components: {
+          PIcon,
+        },
+        methods: {
+          onClick: clickFn,
+        },
+      },
+      {
+        global: {
+          stubs: {
+            'iconify-icon': true,
+          },
+        },
+      }
+    );
+
+    const icon = wrapper.findComponent('iconify-icon-stub');
+
+    await icon.trigger('click');
+
+    expect(clickFn).toHaveBeenCalled();
+  });
+
+  it.each(Object.entries(P_ICON_ALIASES))(
+    'renders the %s icon when the %s is passed as an icon prop',
+    async (iconAliasKey, iconAlias) => {
+      const wrapper = createWrapper({ icon: iconAliasKey });
+
+      const icon = wrapper.findComponent('iconify-icon-stub');
+
+      expect(icon.attributes().icon).toBe(iconAlias);
+    }
+  );
+});

package/squirrel/components/p-icon/p-icon.stories.js

@@ -0,0 +1,128 @@
+import PIcon from '@squirrel/components/p-icon/p-icon.vue';
+import { P_ICON_ALIASES } from '@squirrel/components/p-icon/p-icon.types';
+
+export default {
+  title: 'Components/PIcon',
+  component: PIcon,
+  tags: ['autodocs'],
+  parameters: {
+    docs: {
+      description: {
+        component: `**PIcon** is a wrapper for the [iconify-icon](https://iconify.design/docs/iconify-icon/#attributes) web component that adds custom **icon aliases**, making it easier to maintain a consistent and unified icon set.
+
+All the customization options provided by [iconify-icon](https://iconify.design/docs/iconify-icon/#attributes) are available.
+
+- Learn how to control icon dimensions [here](https://iconify.design/docs/iconify-icon/dimensions.html).
+- Discover how to adjust icon colors [here](https://iconify.design/docs/iconify-icon/color).
+- Check out the available icons [here](https://icon-sets.iconify.design/).`,
+      },
+    },
+  },
+  args: {
+    icon: 'ant-design:build-twotone',
+    mode: 'svg',
+    inline: false,
+    width: '4rem',
+    height: '4rem',
+    flip: '',
+    rotate: '',
+  },
+  argTypes: {
+    icon: {
+      control: { type: 'text' },
+      description: 'Icon',
+    },
+    mode: {
+      control: { type: 'select' },
+      options: ['svg', 'style', 'bg', 'mask'],
+      description: 'Sets icon rendering mode. See [rendering modes](https://iconify.design/docs/iconify-icon/modes).',
+    },
+    inline: {
+      control: { type: 'boolean' },
+      description:
+        'Changes vertical alignment. See [vertical alignment](https://iconify.design/docs/iconify-icon/inline.html).',
+    },
+    width: {
+      control: { type: 'text' },
+      description: 'Icon width. See [icon dimensions](https://iconify.design/docs/iconify-icon/dimensions.html).',
+    },
+    height: {
+      control: { type: 'text' },
+      description: 'Icon height. See [icon dimensions](https://iconify.design/docs/iconify-icon/dimensions.html).',
+    },
+    flip: {
+      control: { type: 'select' },
+      options: ['', 'horizontal', 'vertical'],
+      description: 'Flip icon. See [icon transformations](https://iconify.design/docs/iconify-icon/transform.html).',
+    },
+    rotate: {
+      control: { type: 'select' },
+      options: ['', '90deg', '180deg', '270deg'],
+      description: 'Rotates icon. See [icon transformations](https://iconify.design/docs/iconify-icon/transform.html).',
+    },
+    color: {
+      control: { type: 'color' },
+      description: 'Icon color. See [icon colors](https://iconify.design/docs/iconify-icon/color).',
+    },
+  },
+};
+
+export const Default = {
+  render: (args) => ({
+    components: { PIcon },
+    setup() {
+      return { args };
+    },
+    template: `<PIcon v-bind="args" class="text-p-purple-50" :style="{ color: args.color }" />`,
+  }),
+};
+
+export const IconAlias = {
+  ...Default,
+  args: {
+    icon: 'delete',
+  },
+  argTypes: {
+    icon: {
+      control: { type: 'select' },
+      options: Object.keys(P_ICON_ALIASES),
+    },
+  },
+  parameters: {
+    docs: {
+      description: {
+        story: `The **icon** prop accepts an alias that points to a specific icon. This allows for a consistent and unified icon set.`,
+      },
+    },
+  },
+};
+
+export const AllIconAliases = {
+  ...Default,
+  render: (args) => ({
+    components: { PIcon },
+    setup() {
+      return { args, P_ICON_ALIASES };
+    },
+    template: `
+      <div class="mt-2 flex w-full gap-4">
+        <div
+          v-for="(iconClass, iconAlias) in P_ICON_ALIASES"
+          :key="iconAlias"
+          :title="iconClass"
+          class="flex flex-col items-center justify-center gap-y-2"
+        >
+          <PIcon v-bind="args" :icon="iconAlias" class="text-p-purple-50" :style="{ color: args.color }" />
+          <div>{{ iconAlias }}</div>
+        </div>
+      </div>
+    `,
+  }),
+  parameters: {
+    docs: {
+      description: {
+        story: `All available icon aliases.`,
+      },
+    },
+  },
+};

package/squirrel/components/p-icon/p-icon.types.ts

@@ -0,0 +1,8 @@
+export const P_ICON_ALIASES = {
+  delete: 'octicon:trash-24',
+  edit: 'simple-line-icons:pencil',
+  send: 'fa:paper-plane',
+  settings: 'heroicons:cog-8-tooth-20-solid',
+} as const;
+
+export type PIconAlias = keyof typeof P_ICON_ALIASES;

package/squirrel/components/p-icon/p-icon.vue

@@ -0,0 +1,22 @@
+<template>
+  <iconify-icon v-bind="{ ...$props, icon: isPIcon(icon) ? P_ICON_ALIASES[icon] : icon }" />
+</template>
+
+<script setup lang="ts">
+import { type IconifyIconAttributes } from 'iconify-icon';
+import { type PIconAlias, P_ICON_ALIASES } from '@squirrel/components/p-icon/p-icon.types';
+import 'iconify-icon';
+
+defineOptions({
+  name: 'PIcon',
+});
+
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+interface Props extends /* @vue-ignore */ Omit<IconifyIconAttributes, 'icon'> {
+  icon: IconifyIconAttributes['icon'] | PIconAlias;
+}
+
+const isPIcon = (icon: string): icon is PIconAlias => !!P_ICON_ALIASES[icon as PIconAlias];
+
+defineProps<Props>();
+</script>