@agentable/icons-static 0.1.0

package/LICENSE

@@ -0,0 +1,46 @@
+AGENTABLE COMMERCIAL LICENSE
+
+Copyright (c) 2025 Agentable
+
+This software and associated documentation files (the "Software") are
+proprietary to Agentable and its licensors.
+
+RESTRICTED LICENSE GRANT
+
+Subject to the terms and conditions of this License, Agentable hereby grants
+you a limited, non-exclusive, non-transferable license to use the Software
+solely in connection with:
+
+1. Agentable Platform Services
+2. Applications, websites, or services that are directly integrated with
+   or operated by Agentable
+3. Internal development and testing related to Agentable platform integration
+
+RESTRICTIONS
+
+You may NOT:
+- Use the Software in any project, application, or service that is not
+  directly related to the Agentable platform
+- Distribute, sublicense, or make the Software available to third parties
+  for use outside of Agentable platform services
+- Create derivative works based on the Software for use outside of
+  Agentable platform services
+- Remove or modify any copyright notices or license terms
+
+TERMINATION
+
+This license automatically terminates if you violate any of these terms.
+Upon termination, you must immediately cease all use of the Software and
+destroy all copies in your possession.
+
+DISCLAIMER
+
+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
+AGENTABLE 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.
+
+For questions about licensing or to request permission for use outside of
+these terms, contact: license@agentable.dev

package/README.md

@@ -0,0 +1,78 @@
+# @agentable/icons-static
+
+Framework-agnostic static icon library that can be used with `<i>` tags or
+JavaScript calls, with Tree-Shaking support.
+
+---
+
+## Features
+
+- 🚀 **Framework Agnostic**: Works with any web framework or vanilla JavaScript
+- 📦 **Tree-Shakable**: Only bundle the icons you actually import
+- 🎨 **Customizable**: Control styles through data attributes or JavaScript
+  parameters
+- 🔧 **TypeScript**: Complete type definitions out of the box
+
+---
+
+## Installation
+
+```sh
+pnpm add @agentable/icons-static
+```
+
+---
+
+## Quick Start
+
+### 1. Declarative Usage (Recommended)
+
+Place `<i>` tags in HTML, then use JavaScript to replace them.
+
+**HTML:**
+
+```html
+<i data-icon="home"></i>
+<i data-icon="search" data-color="red" data-size="32"></i>
+```
+
+**JavaScript:**
+
+```javascript
+import { createIcons, Home, Search } from '@agentable/icons-static';
+
+// Only replace the icons you declare, supports tree-shaking
+createIcons({
+  icons: {
+    home: Home,
+    search: Search,
+  },
+}).replace();
+```
+
+### 2. Imperative Usage
+
+Create icons directly in JavaScript.
+
+```javascript
+import { createIcon, Home } from '@agentable/icons-static';
+
+// Returns SVGElement in browser
+const svgEl = createIcon(Home, { color: 'blue', size: 24 });
+document.body.appendChild(svgEl);
+
+// Returns SVG string in Node.js
+const svgString = createIcon(Home, { color: 'blue', size: 24 });
+```
+
+---
+
+## Props
+
+| Name          | Type               | Default        |
+| ------------- | ------------------ | -------------- |
+| `size`        | `number \| string` | `24`           |
+| `color`       | `string`           | `currentColor` |
+| `strokeWidth` | `number`           | `2`            |
+
+Supports all native SVG `SVGSVGElement` attributes.