@stacksjs/iconify-oi 0.0.1

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 +53 -0
  2. package/package.json +41 -0
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # @stacksjs/iconify-oi
2
+
3
+ Open Iconic icons for stx from Iconify.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ bun add @stacksjs/iconify-oi
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ### In stx templates
14
+
15
+ ```html
16
+ <script>
17
+ import { home } from '@stacksjs/iconify-oi'
18
+ import { renderIcon } from '@stacksjs/iconify-core'
19
+
20
+ export const homeIcon = renderIcon(home, { size: 24, color: 'currentColor' })
21
+ </script>
22
+
23
+ <div class="icon">
24
+ {!! homeIcon !!}
25
+ </div>
26
+ ```
27
+
28
+ ### In TypeScript/JavaScript
29
+
30
+ ```typescript
31
+ import { home, account, settings } from '@stacksjs/iconify-oi'
32
+ import { renderIcon } from '@stacksjs/iconify-core'
33
+
34
+ const svg = renderIcon(home, {
35
+ size: 24,
36
+ color: '#000000',
37
+ })
38
+ ```
39
+
40
+ ## Available Icons
41
+
42
+ This package contains 223 icons from Open Iconic.
43
+
44
+ ## License
45
+
46
+ MIT
47
+
48
+ License: https://github.com/iconic/open-iconic/blob/master/ICON-LICENSE
49
+
50
+ ## Credits
51
+
52
+ - Icons: Iconic (https://github.com/iconic/open-iconic)
53
+ - Iconify: https://iconify.design/
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "@stacksjs/iconify-oi",
3
+ "version": "0.0.1",
4
+ "description": "Open Iconic icons for stx from Iconify",
5
+ "author": "Iconic",
6
+ "license": "MIT",
7
+ "type": "module",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.js"
12
+ },
13
+ "./*": "./dist/*"
14
+ },
15
+ "main": "./dist/index.js",
16
+ "module": "./dist/index.js",
17
+ "types": "./dist/index.d.ts",
18
+ "files": [
19
+ "dist"
20
+ ],
21
+ "scripts": {
22
+ "build": "bun build.ts"
23
+ },
24
+ "dependencies": {
25
+ "@stacksjs/iconify-core": "^0.1.12"
26
+ },
27
+ "keywords": [
28
+ "iconify",
29
+ "icons",
30
+ "svg",
31
+ "oi",
32
+ "Open Iconic",
33
+ "stx"
34
+ ],
35
+ "repository": {
36
+ "type": "git",
37
+ "url": "https://github.com/stacksjs/stx.git",
38
+ "directory": "packages/iconify-oi"
39
+ },
40
+ "sideEffects": false
41
+ }