@i316/heroicons-angular 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,64 @@
+This package contains two kinds of material, under different licenses.
+
+1. ICON DESIGNS
+
+The icon artwork (the svg/ files, and the shape data inside every generated
+component) is Heroicons by Tailwind Labs,
+https://github.com/tailwindlabs/heroicons, licensed under MIT.
+
+Changes made for i316:
+  - 24px outline and solid sets only, recolored to currentColor and reformatted
+  - converted into React, React Native, Vue, Angular and web-component formats
+
+The upstream license/notice follows verbatim.
+
+------------------------------------------------------------------------
+MIT License
+
+Copyright (c) Tailwind Labs, Inc.
+
+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.
+------------------------------------------------------------------------
+
+2. i316 CODE
+
+Everything else (component runtime, generated module code, web component,
+Babel plugin) is licensed under the MIT License:
+
+MIT License
+
+Copyright (c) 2026 rahil316
+
+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

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# @i316/heroicons-angular
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+i316: Heroicons icons for Angular 17+. 324 icons in 2 styles: `outline` (default), `solid`.
+
+Other i316 Heroicons packages: `@i316/heroicons-react` (React web), `@i316/heroicons-react-native` (React Native), `@i316/heroicons-vue` (Vue 3) and `@i316/heroicons-web` (plain HTML web component and raw SVGs).
+
+```sh
+npm install @i316/heroicons-angular
+```
+
+This installs `@i316/angular` too: one small standalone directive that renders every i316 collection. This package itself is plain icon data.
+
+## Usage
+
+```ts
+import { Component } from '@angular/core';
+import { HeroIcon, ChevronDownOutline, BellSolid } from '@i316/heroicons-angular';
+
+@Component({
+  selector: 'app-toolbar',
+  standalone: true,
+  imports: [HeroIcon],
+  template: `
+    <svg heroIcon [icon]="chevronDown" [size]="20" color="#e11d48"></svg>
+    <svg heroIcon [icon]="bell" title="Notifications"></svg>
+  `,
+})
+export class Toolbar {
+  chevronDown = ChevronDownOutline;
+  bell = BellSolid;
+}
+```
+
+Icon data is exported from the root as `<Name><Style>` (`ChevronDownOutline`), or per style as `<Name>` (`import { ChevronDown } from '@i316/heroicons-angular/outline'`). Each icon is its own module, so production builds ship only the icons you reference. Switch styles by binding a different constant.
+
+### Defaults
+
+```ts
+import { provideHeroIcons } from '@i316/heroicons-angular';
+
+bootstrapApplication(App, { providers: [provideHeroIcons({ size: 20, strokeWidth: 2 })] });
+// or, for one component subtree: @Component({ providers: [provideHeroIcons({ color: 'slategray' })] })
+```
+
+Inputs on an icon override the defaults. Nested providers merge over their parent's values.
+
+## Inputs
+
+| Input | Default | |
+|---|---|---|
+| `size` | `24` | width and height |
+| `color` | `currentColor` | icon color |
+| `strokeWidth` | `1.5` | `outline` only; ignored by the other styles |
+| `title` | none | accessible name (see below) |
+| `icon` | required | the icon data constant |
+
+**Accessibility:** icons are decorative by default (`aria-hidden="true"`). Set `title` to make one meaningful: it renders a `<title>` and `role="img"`. Your own `aria-label` or `role` also removes `aria-hidden`.
+
+**Styling:** every icon has the classes `hero-icon hero-icon-<name>`, plus any `class` you set on the `<svg>`.
+
+Works with Angular SSR. Peer dependency: `@angular/core >= 17`.
+
+## License
+
+Icons: Heroicons by Tailwind Labs (https://github.com/tailwindlabs/heroicons), licensed under [MIT](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE). i316 modified them: 24px outline and solid sets only, recolored to currentColor and reformatted; converted into React, React Native, Vue, Angular and web-component formats.
+
+i316 code (components, runtime, tooling): MIT, © 2026 rahil316. See `LICENSE` for both licenses in full.