qumra-icons 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Qumra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,145 @@
+# qumra-icons
+
+طقم أيقونات **قُمرة** — 76 أيقونة تجارة إلكترونية ملوّنة ومتحركة، بواجهة على نمط `lucide-react`.
+
+- تصدير مسمّى لكل أيقونة، قابل للهزّ الشجري (tree-shaking)
+- حركة عند مرور المؤشر، خاصة بمعنى كل أيقونة
+- تيل واحد + برتقالي واحد — هوية قُمرة
+- أنواع TypeScript كاملة · ESM و CJS · يعمل مع SSR
+- شبكة 32×32 · مساحة أمان 2px · بلا حدود
+
+## التثبيت
+
+```bash
+npm i qumra-icons
+```
+
+## الاستخدام
+
+```jsx
+import { Home, Settings, Shihab } from "qumra-icons";
+
+export default function Nav() {
+  return (
+    <nav>
+      <Home />                      {/* 32px */}
+      <Settings size={24} />
+      <Shihab size="1.5rem" />
+    </nav>
+  );
+}
+```
+
+### الحالات
+
+```jsx
+<Home mono />                {/* رمادية حتى مرور المؤشر */}
+<Home mono active />         {/* ملوّنة دائمًا — للعنصر النشط في القائمة */}
+<Home animate />             {/* الحركة تعمل باستمرار */}
+<Home still />               {/* بلا حركة */}
+<Home label="الصفحة الرئيسية" onClick={go} className="ms-2" />
+```
+
+### الخصائص
+
+| الخاصية | النوع | الافتراضي | الوصف |
+|---|---|---|---|
+| `size` | `number \| string` | `32` | المقاس بالبكسل أو بأي وحدة CSS |
+| `mono` | `boolean` | `false` | رمادية حتى مرور المؤشر |
+| `active` | `boolean` | `false` | تبقى ملوّنة مع `mono` |
+| `animate` | `boolean` | `false` | حركة دائمة |
+| `still` | `boolean` | `false` | تعطيل الحركة |
+| `label` | `string` | الاسم العربي | نص `aria-label` |
+| `injectStyles` | `boolean` | `true` | حقن CSS الحركات تلقائيًا |
+
+بقية الخصائص تمرّ كما هي إلى عنصر `<svg>` (`onClick`, `style`, `ref`, …).
+
+## التنسيقات
+
+تُحقن تلقائيًا عند أول عرض. لتفادي وميض أول إطار — خاصة مع SSR — استوردها صراحةً وأوقف الحقن:
+
+```jsx
+import "qumra-icons/styles.css";
+```
+
+الحركات تحترم `prefers-reduced-motion` تلقائيًا.
+
+## الهزّ الشجري
+
+الحزمة ESM ومعلَّمة `sideEffects: false` عدا ملفات CSS، فالاستيراد المسمّى يكفي.
+وللاستيراد المباشر:
+
+```jsx
+import Settings from "qumra-icons/icons/settings";
+```
+
+## بلا React
+
+```html
+<script src="node_modules/qumra-icons/dist/web.js"></script>
+<qumra-icon name="home" size="24"></qumra-icon>
+```
+
+أو من CDN مباشرة بلا تثبيت:
+
+```html
+<script src="https://unpkg.com/qumra-icons"></script>
+<qumra-icon name="home" size="24"></qumra-icon>
+```
+
+أو عبر sprite: `qumra-icons/sprite.svg` — الحركة فيه للأيقونة كاملة فقط.
+
+## السجلّ والأنواع
+
+```ts
+import { iconNames, iconLabels, type IconName, type QumraIcon } from "qumra-icons";
+
+const name: IconName = "home";          // اتحاد بأسماء الأيقونات كلها
+const label = iconLabels[name];         // "الرئيسية"
+```
+
+## الأيقونات
+
+### التنقّل والأقسام
+
+`Home` · `Sales` · `Shipping` · `Catalog` · `Inventory` · `Store` · `Analytics` · `Marketing` · `Content` · `Apps` · `Partners` · `Settings`
+### بدائل الأقسام
+
+`InventoryBuilding` · `ShippingVan` · `ShippingParcel`
+### الخدمات — مقترحات القسم
+
+`ServicesGrid` · `ServicesGears` · `ServicesTools` · `ServicesCards` · `ServicesSparkle`
+### أنواع الخدمات
+
+`ServiceConsulting` · `ServiceDevelopment` · `ServiceDesign` · `ServiceMarketing` · `ServiceSupport` · `ServiceTraining` · `ServiceIntegration` · `ServiceAutomation`
+### الإحصائيات
+
+`StatsOverview` · `StatsSales` · `StatsProducts` · `StatsTraffic`
+### التجارة والدفع
+
+`Payments` · `Orders` · `Customers` · `Offers` · `Cart` · `CartAbandoned` · `Payment`
+### الباقات — المعتمد حاليًا
+
+`PlanStarter` · `PlanGrowth` · `PlanBusiness` · `PlanBusinessBuilding`
+### الباقات — مفهوم النبات
+
+`PlanPlant1` · `PlanPlant2` · `PlanPlant3`
+### الترقية والصلاحيات
+
+`Upgrade` · `Premium` · `Forbidden`
+### الحساب والافتراضيات
+
+`Avatar` · `Community` · `StoreLogo` · `AppDefault` · `ThemeDefault`
+### التواصل والتكامل
+
+`Email` · `Phone` · `Api` · `Webhook` · `Chat` · `Guide` · `Video` · `Link` · `Copy` · `Lock` · `Share`
+### الشريط العلوي — أدوات
+
+`Search` · `Notifications` · `DarkMode` · `Language` · `Academy` · `Website` · `Support`
+### داخل الصفحة
+
+`Launch` · `Shihab` · `Ai` · `Assistant`
+
+## الترخيص
+
+MIT