eastern-area-fe-package 0.3.3 → 0.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +124 -124
  2. package/package.json +113 -113
package/README.md CHANGED
@@ -1,124 +1,124 @@
1
- # eastern-area-fe-package
2
-
3
- A shared React icon utility library for `eastern-area-fe` and `eastern-area-crm-fe`.
4
-
5
- `eastern-area-fe-package` provides:
6
-
7
- - `DynamicIcon`: runtime icon resolution for both custom SVG icons and Tabler icons.
8
- - `STATIC_ICONS_LIST` / `STATIC_ICONS_MAP`: Arabic-labeled custom icons.
9
- - `TABLER_ICONS_LIST` / `TABLER_ICONS_MAP`: the full `@tabler/icons-react` catalog.
10
- - `ALL_ICONS_LIST`: a combined list of every supported icon.
11
- - A dedicated `static` entrypoint for custom icons only.
12
-
13
- ## Install
14
-
15
- ```bash
16
- npm install eastern-area-fe-package
17
- # or
18
- bun add eastern-area-fe-package
19
- ```
20
-
21
- Peer dependencies:
22
-
23
- - `react` >= 18
24
- - `react-dom` >= 18
25
-
26
- ## Usage
27
-
28
- ```tsx
29
- import { DynamicIcon, ALL_ICONS_LIST, STATIC_ICONS_LIST } from 'eastern-area-fe-package';
30
-
31
- <DynamicIcon iconName="Hospital" size={24} color="#067647" />;
32
- <DynamicIcon iconName="Settings" size={24} width={28} className="my-icon" />;
33
- ```
34
-
35
- ### Static-only import
36
-
37
- The root package entrypoint includes the full Tabler icon set, which means `DynamicIcon` can resolve both custom and Tabler icon names.
38
- If you only need the custom icons and want a smaller bundle, import the static-only entrypoint:
39
-
40
- ```tsx
41
- import { STATIC_ICONS_LIST, STATIC_ICONS_MAP } from 'eastern-area-fe-package/static';
42
- ```
43
-
44
- ## Public exports
45
-
46
- | Export | Type | Description |
47
- | ------------------- | ---------------- | ------------------------------------------------------------ |
48
- | `DynamicIcon` | React component | Renders the requested icon from custom or Tabler collections |
49
- | `STATIC_ICONS_LIST` | `IconListItem[]` | Custom SVG icons with Arabic labels |
50
- | `STATIC_ICONS_MAP` | `IconsMap` | Lookup map for custom icons by name |
51
- | `TABLER_ICONS_LIST` | `IconListItem[]` | All Tabler icons as a list |
52
- | `TABLER_ICONS_MAP` | `IconsMap` | Lookup map for all Tabler icons by name |
53
- | `ALL_ICONS_LIST` | `IconListItem[]` | Combined static + Tabler icon list |
54
-
55
- ## API
56
-
57
- ### `DynamicIcon`
58
-
59
- `DynamicIcon` props:
60
-
61
- | Prop | Type | Default | Description |
62
- | ----------- | ------------------------- | ----------- | ----------------------------------------------------------- |
63
- | `iconName?` | `string` | `undefined` | Icon name to render. Supports custom and Tabler icon names. |
64
- | `size?` | `number \| string` | `undefined` | Sets both width and height unless `width` is provided. |
65
- | `width?` | `number \| string` | `undefined` | Sets the SVG width separately if needed. |
66
- | `color?` | `string` | `undefined` | Sets the icon color when supported by the SVG. |
67
- | `...rest` | `SVGProps<SVGSVGElement>` | — | Forwarded to the rendered SVG component. |
68
-
69
- If `iconName` is missing or not found, the component falls back to the first icon in `ALL_ICONS_LIST`.
70
-
71
- ### `STATIC_ICONS_LIST` / `STATIC_ICONS_MAP`
72
-
73
- Custom icons are exported with Arabic labels. Each entry has the shape:
74
-
75
- ```ts
76
- interface IconListItem {
77
- name: string;
78
- icon: ComponentType<SVGProps<SVGSVGElement>>;
79
- labelAr: string;
80
- }
81
- ```
82
-
83
- Use `STATIC_ICONS_LIST` for icon pickers or menus, and `STATIC_ICONS_MAP` for quick lookup by name.
84
-
85
- ### `TABLER_ICONS_LIST` / `TABLER_ICONS_MAP`
86
-
87
- These exports expose the complete Tabler icon catalog from `@tabler/icons-react`.
88
- `TABLER_ICONS_MAP` lets you look up icons by their Tabler name.
89
-
90
- ### `ALL_ICONS_LIST`
91
-
92
- A merged list of custom static icons and all Tabler icons. Useful for searching, filtering, or fallback behavior.
93
-
94
- ## Types
95
-
96
- | Type | Description |
97
- | ------------------ | ------------------------------------- |
98
- | `IconListItem` | A named SVG icon with an Arabic label |
99
- | `IconsMap` | Map from icon name to `IconListItem` |
100
- | `DynamicIconProps` | Props accepted by `DynamicIcon` |
101
- | `StaticIconName` | Union of all custom icon names |
102
- | `TablerIconName` | Union of all Tabler icon names |
103
- | `IconName` | Union of all supported icon names |
104
-
105
- ## Development
106
-
107
- ```bash
108
- bun install
109
- bun run build
110
- bun run dev
111
- ```
112
-
113
- - `bun run build` runs `tsc -b && vite build`.
114
- - `bun run dev` rebuilds on file changes in watch mode.
115
-
116
- ## Package entrypoints
117
-
118
- - Root: `eastern-area-fe-package`
119
- - Static-only: `eastern-area-fe-package/static`
120
-
121
- ## Notes
122
-
123
- - The package ships both ESM and CommonJS builds under `dist/`.
124
- - If you prefer clean source control, do not commit `dist/` and keep it in `.gitignore`.
1
+ # eastern-area-fe-package
2
+
3
+ A shared React icon utility library for `eastern-area-fe` and `eastern-area-crm-fe`.
4
+
5
+ `eastern-area-fe-package` provides:
6
+
7
+ - `DynamicIcon`: runtime icon resolution for both custom SVG icons and Tabler icons.
8
+ - `STATIC_ICONS_LIST` / `STATIC_ICONS_MAP`: Arabic-labeled custom icons.
9
+ - `TABLER_ICONS_LIST` / `TABLER_ICONS_MAP`: the full `@tabler/icons-react` catalog.
10
+ - `ALL_ICONS_LIST`: a combined list of every supported icon.
11
+ - A dedicated `static` entrypoint for custom icons only.
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ npm install eastern-area-fe-package
17
+ # or
18
+ bun add eastern-area-fe-package
19
+ ```
20
+
21
+ Peer dependencies:
22
+
23
+ - `react` >= 18
24
+ - `react-dom` >= 18
25
+
26
+ ## Usage
27
+
28
+ ```tsx
29
+ import { DynamicIcon, ALL_ICONS_LIST, STATIC_ICONS_LIST } from 'eastern-area-fe-package';
30
+
31
+ <DynamicIcon iconName="Hospital" size={24} color="#067647" />;
32
+ <DynamicIcon iconName="Settings" size={24} width={28} className="my-icon" />;
33
+ ```
34
+
35
+ ### Static-only import
36
+
37
+ The root package entrypoint includes the full Tabler icon set, which means `DynamicIcon` can resolve both custom and Tabler icon names.
38
+ If you only need the custom icons and want a smaller bundle, import the static-only entrypoint:
39
+
40
+ ```tsx
41
+ import { STATIC_ICONS_LIST, STATIC_ICONS_MAP } from 'eastern-area-fe-package/static';
42
+ ```
43
+
44
+ ## Public exports
45
+
46
+ | Export | Type | Description |
47
+ | ------------------- | ---------------- | ------------------------------------------------------------ |
48
+ | `DynamicIcon` | React component | Renders the requested icon from custom or Tabler collections |
49
+ | `STATIC_ICONS_LIST` | `IconListItem[]` | Custom SVG icons with Arabic labels |
50
+ | `STATIC_ICONS_MAP` | `IconsMap` | Lookup map for custom icons by name |
51
+ | `TABLER_ICONS_LIST` | `IconListItem[]` | All Tabler icons as a list |
52
+ | `TABLER_ICONS_MAP` | `IconsMap` | Lookup map for all Tabler icons by name |
53
+ | `ALL_ICONS_LIST` | `IconListItem[]` | Combined static + Tabler icon list |
54
+
55
+ ## API
56
+
57
+ ### `DynamicIcon`
58
+
59
+ `DynamicIcon` props:
60
+
61
+ | Prop | Type | Default | Description |
62
+ | ----------- | ------------------------- | ----------- | ----------------------------------------------------------- |
63
+ | `iconName?` | `string` | `undefined` | Icon name to render. Supports custom and Tabler icon names. |
64
+ | `size?` | `number \| string` | `undefined` | Sets both width and height unless `width` is provided. |
65
+ | `width?` | `number \| string` | `undefined` | Sets the SVG width separately if needed. |
66
+ | `color?` | `string` | `undefined` | Sets the icon color when supported by the SVG. |
67
+ | `...rest` | `SVGProps<SVGSVGElement>` | — | Forwarded to the rendered SVG component. |
68
+
69
+ If `iconName` is missing or not found, the component falls back to the first icon in `ALL_ICONS_LIST`.
70
+
71
+ ### `STATIC_ICONS_LIST` / `STATIC_ICONS_MAP`
72
+
73
+ Custom icons are exported with Arabic labels. Each entry has the shape:
74
+
75
+ ```ts
76
+ interface IconListItem {
77
+ name: string;
78
+ icon: ComponentType<SVGProps<SVGSVGElement>>;
79
+ labelAr: string;
80
+ }
81
+ ```
82
+
83
+ Use `STATIC_ICONS_LIST` for icon pickers or menus, and `STATIC_ICONS_MAP` for quick lookup by name.
84
+
85
+ ### `TABLER_ICONS_LIST` / `TABLER_ICONS_MAP`
86
+
87
+ These exports expose the complete Tabler icon catalog from `@tabler/icons-react`.
88
+ `TABLER_ICONS_MAP` lets you look up icons by their Tabler name.
89
+
90
+ ### `ALL_ICONS_LIST`
91
+
92
+ A merged list of custom static icons and all Tabler icons. Useful for searching, filtering, or fallback behavior.
93
+
94
+ ## Types
95
+
96
+ | Type | Description |
97
+ | ------------------ | ------------------------------------- |
98
+ | `IconListItem` | A named SVG icon with an Arabic label |
99
+ | `IconsMap` | Map from icon name to `IconListItem` |
100
+ | `DynamicIconProps` | Props accepted by `DynamicIcon` |
101
+ | `StaticIconName` | Union of all custom icon names |
102
+ | `TablerIconName` | Union of all Tabler icon names |
103
+ | `IconName` | Union of all supported icon names |
104
+
105
+ ## Development
106
+
107
+ ```bash
108
+ bun install
109
+ bun run build
110
+ bun run dev
111
+ ```
112
+
113
+ - `bun run build` runs `tsc -b && vite build`.
114
+ - `bun run dev` rebuilds on file changes in watch mode.
115
+
116
+ ## Package entrypoints
117
+
118
+ - Root: `eastern-area-fe-package`
119
+ - Static-only: `eastern-area-fe-package/static`
120
+
121
+ ## Notes
122
+
123
+ - The package ships both ESM and CommonJS builds under `dist/`.
124
+ - If you prefer clean source control, do not commit `dist/` and keep it in `.gitignore`.
package/package.json CHANGED
@@ -1,113 +1,113 @@
1
- {
2
- "name": "eastern-area-fe-package",
3
- "version": "0.3.3",
4
- "description": "Shared React components and utilities between eastern-area-fe and eastern-area-crm-fe",
5
- "type": "module",
6
- "main": "./dist/index.cjs",
7
- "module": "./dist/index.js",
8
- "types": "./dist/index.d.ts",
9
- "exports": {
10
- ".": {
11
- "types": "./dist/index.d.ts",
12
- "import": "./dist/index.js",
13
- "require": "./dist/index.cjs"
14
- },
15
- "./components": {
16
- "types": "./dist/components-entry.d.ts",
17
- "import": "./dist/components-entry.js",
18
- "require": "./dist/components-entry.cjs"
19
- },
20
- "./types": {
21
- "types": "./dist/types-entry.d.ts",
22
- "import": "./dist/types-entry.js",
23
- "require": "./dist/types-entry.cjs"
24
- },
25
- "./static": {
26
- "types": "./dist/static.d.ts",
27
- "import": "./dist/static.js",
28
- "require": "./dist/static.cjs"
29
- },
30
- "./cn": {
31
- "types": "./dist/cn.d.ts",
32
- "import": "./dist/cn.js",
33
- "require": "./dist/cn.cjs"
34
- },
35
- "./hooks": {
36
- "types": "./dist/hooks-entry.d.ts",
37
- "import": "./dist/hooks-entry.js",
38
- "require": "./dist/hooks-entry.cjs"
39
- },
40
- "./utils": {
41
- "types": "./dist/utils.d.ts",
42
- "import": "./dist/utils.js",
43
- "require": "./dist/utils.cjs"
44
- },
45
- "./routes": {
46
- "types": "./dist/routes-entry.d.ts",
47
- "import": "./dist/routes-entry.js",
48
- "require": "./dist/routes-entry.cjs"
49
- },
50
- "./icons/static": {
51
- "types": "./dist/icons-static.d.ts",
52
- "import": "./dist/icons-static.js",
53
- "require": "./dist/icons-static.cjs"
54
- },
55
- "./icons/tabler": {
56
- "types": "./dist/icons-tabler.d.ts",
57
- "import": "./dist/icons-tabler.js",
58
- "require": "./dist/icons-tabler.cjs"
59
- },
60
- "./package.json": "./package.json"
61
- },
62
- "files": [
63
- "dist"
64
- ],
65
- "sideEffects": false,
66
- "scripts": {
67
- "dev": "vite build --watch",
68
- "build": "vite build",
69
- "type-check": "tsc --noEmit",
70
- "prepublishOnly": "bun run type-check && bun run build",
71
- "release": "standard-version && git push --follow-tags origin main"
72
- },
73
- "keywords": [
74
- "react",
75
- "eastern-area",
76
- "shared",
77
- "components",
78
- "utilities"
79
- ],
80
- "license": "UNLICENSED",
81
- "peerDependencies": {
82
- "@tabler/icons-react": "^3.46.0",
83
- "clsx": ">=2",
84
- "react": ">=18",
85
- "react-dom": ">=18",
86
- "tailwind-merge": ">=3"
87
- },
88
- "devDependencies": {
89
- "@svgr/plugin-svgo": "^8.1.0",
90
- "@tabler/icons-react": "^3.46.0",
91
- "@types/react": "^19.2.17",
92
- "@types/react-dom": "^19.2.3",
93
- "@typescript/typescript6": "^6.0.2",
94
- "@vitejs/plugin-react": "^6.0.3",
95
- "clsx": "^2.1.1",
96
- "eslint": "^8.57.1",
97
- "eslint-config-prettier": "^9.1.2",
98
- "eslint-plugin-import": "^2.32.0",
99
- "eslint-plugin-prettier": "^5.5.6",
100
- "eslint-plugin-react": "^7.37.5",
101
- "eslint-plugin-react-hooks": "^4.6.2",
102
- "prettier": "^3.9.6",
103
- "svgo": "^4.1.0",
104
- "tailwind-merge": "^3.6.0",
105
- "typescript": "^7.0.2",
106
- "vite": "^8.1.5",
107
- "vite-plugin-dts": "^5.0.3",
108
- "vite-plugin-svgr": "^5.2.0"
109
- },
110
- "dependencies": {
111
- "standard-version": "^9.5.0"
112
- }
113
- }
1
+ {
2
+ "name": "eastern-area-fe-package",
3
+ "version": "0.3.4",
4
+ "description": "Shared React components and utilities between eastern-area-fe and eastern-area-crm-fe",
5
+ "type": "module",
6
+ "main": "./dist/index.cjs",
7
+ "module": "./dist/index.js",
8
+ "types": "./dist/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "types": "./dist/index.d.ts",
12
+ "import": "./dist/index.js",
13
+ "require": "./dist/index.cjs"
14
+ },
15
+ "./components": {
16
+ "types": "./dist/components-entry.d.ts",
17
+ "import": "./dist/components-entry.js",
18
+ "require": "./dist/components-entry.cjs"
19
+ },
20
+ "./types": {
21
+ "types": "./dist/types-entry.d.ts",
22
+ "import": "./dist/types-entry.js",
23
+ "require": "./dist/types-entry.cjs"
24
+ },
25
+ "./static": {
26
+ "types": "./dist/static.d.ts",
27
+ "import": "./dist/static.js",
28
+ "require": "./dist/static.cjs"
29
+ },
30
+ "./cn": {
31
+ "types": "./dist/cn.d.ts",
32
+ "import": "./dist/cn.js",
33
+ "require": "./dist/cn.cjs"
34
+ },
35
+ "./hooks": {
36
+ "types": "./dist/hooks-entry.d.ts",
37
+ "import": "./dist/hooks-entry.js",
38
+ "require": "./dist/hooks-entry.cjs"
39
+ },
40
+ "./utils": {
41
+ "types": "./dist/utils.d.ts",
42
+ "import": "./dist/utils.js",
43
+ "require": "./dist/utils.cjs"
44
+ },
45
+ "./routes": {
46
+ "types": "./dist/routes-entry.d.ts",
47
+ "import": "./dist/routes-entry.js",
48
+ "require": "./dist/routes-entry.cjs"
49
+ },
50
+ "./icons/static": {
51
+ "types": "./dist/icons-static.d.ts",
52
+ "import": "./dist/icons-static.js",
53
+ "require": "./dist/icons-static.cjs"
54
+ },
55
+ "./icons/tabler": {
56
+ "types": "./dist/icons-tabler.d.ts",
57
+ "import": "./dist/icons-tabler.js",
58
+ "require": "./dist/icons-tabler.cjs"
59
+ },
60
+ "./package.json": "./package.json"
61
+ },
62
+ "files": [
63
+ "dist"
64
+ ],
65
+ "sideEffects": false,
66
+ "scripts": {
67
+ "dev": "vite build --watch",
68
+ "build": "vite build",
69
+ "type-check": "tsc --noEmit",
70
+ "prepublishOnly": "bun run type-check && bun run build",
71
+ "release": "standard-version && git push --follow-tags origin main"
72
+ },
73
+ "keywords": [
74
+ "react",
75
+ "eastern-area",
76
+ "shared",
77
+ "components",
78
+ "utilities"
79
+ ],
80
+ "license": "UNLICENSED",
81
+ "peerDependencies": {
82
+ "@tabler/icons-react": "^3.46.0",
83
+ "clsx": ">=2",
84
+ "react": ">=18",
85
+ "react-dom": ">=18",
86
+ "tailwind-merge": ">=3"
87
+ },
88
+ "devDependencies": {
89
+ "@svgr/plugin-svgo": "^8.1.0",
90
+ "@tabler/icons-react": "^3.46.0",
91
+ "@types/react": "^19.2.17",
92
+ "@types/react-dom": "^19.2.3",
93
+ "@typescript/typescript6": "^6.0.2",
94
+ "@vitejs/plugin-react": "^6.0.3",
95
+ "clsx": "^2.1.1",
96
+ "eslint": "^8.57.1",
97
+ "eslint-config-prettier": "^9.1.2",
98
+ "eslint-plugin-import": "^2.32.0",
99
+ "eslint-plugin-prettier": "^5.5.6",
100
+ "eslint-plugin-react": "^7.37.5",
101
+ "eslint-plugin-react-hooks": "^4.6.2",
102
+ "prettier": "^3.9.6",
103
+ "svgo": "^4.1.0",
104
+ "tailwind-merge": "^3.6.0",
105
+ "typescript": "^7.0.2",
106
+ "vite": "^8.1.5",
107
+ "vite-plugin-dts": "^5.0.3",
108
+ "vite-plugin-svgr": "^5.2.0"
109
+ },
110
+ "dependencies": {
111
+ "standard-version": "^9.5.0"
112
+ }
113
+ }