@scarlab-icons/js 0.0.0-stage → 3.0.0

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Alex Moore
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,66 @@
1
- # Temporary Holding Version
1
+ <p align="center"><a href="https://scarlab-icons.la-moore.ru" target="_blank" rel="noopener noreferrer"><img width="100" src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0iY3VycmVudENvbG9yIiBzdHJva2U9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBzdHJva2Utd2lkdGg9IjMuMyIgY29sb3I9IiNmZjY4MDAiIHdpZHRoPSI3MSIgaGVpZ2h0PSI3MSI+PHBhdGggZD0iTTE2Ljg2NiA0LjQ4OWMtLjI1NS43NTMtLjg2NSAxLjQwNS0xLjc2MSAxLjg1YTcuMSA3LjEgMCAwIDEtMy4xMDQuNjY4IDcuMDUgNy4wNSAwIDAgMS0zLjEtLjY2N2MtLjk3Mi0uNDctMS42MS0xLjIwNS0xLjgyMi0yLjA0My0uMTQ3LS41OC0uOTA2LS40NDYtMS4zNzEtLjA2OS0uNDg5LjM5Ni0uOTQuODM4LTEuMzQ1IDEuMzE4LS4xOC4yMTEtLjI3NS40OTktLjE1NS43NDkuMDguMTY4LjE5OC4zMTYuMzQzLjQzM2wuMzQ2LjI4IDMuNDk0IDIuODNjLjI1Mi4yMDUuNTk4LjIzLjkxNS4xNTVhMi40IDIuNCAwIDAgMSAuNTU3LS4wNjVoNC4yNzVxLjMzNyAwIC42Ni4wOTJjLjMyOC4wOTQuNjkzLjA3Ni45NTgtLjEzOGwxLjQ5LTEuMjA2IDIuMDU5LTEuNjY5LjM0Ni0uMjhjLjE0NC0uMTE2LjI2LS4yNjUuMzQtLjQzM2EuMzcuMzcgMCAwIDAtLjA1NC0uMzggMTAgMTAgMCAwIDAtMS40NjctMS41NGMtLjUzMi0uNDUyLTEuMzgtLjU0Ny0xLjYwNC4xMTUiPjwvcGF0aD48cGF0aCBkPSJNMTQuMzU4IDQuODVjLjM2Ni0uMTgzLjk3NS0uNTguOTc1LTEuMThhMS4xIDEuMSAwIDAgMC0uNDUtLjgzNCAyLjQgMi40IDAgMCAwLS41MjUtLjM0NyA1LjQgNS40IDAgMCAwLTIuMzU5LS40ODggNS4zNiA1LjM2IDAgMCAwLTIuMzU0LjQ4OHEtLjI4Ni4xMzktLjUyNS4zNDdhMS4xIDEuMSAwIDAgMC0uNDU0LjgzNGMwIC42LjYxMy45OTcuOTggMS4xOGE1LjQgNS40IDAgMCAwIDIuMzUzLjQ4OSA1LjQgNS40IDAgMCAwIDIuMzU5LS40ODhNMTQuODk1IDEyLjM1NWEuNzYuNzYgMCAwIDEtLjMtLjYwNWwtMS4xMDQuODM0LS42NTguNTAxLS4wNzUuMDU4YTEuMjUgMS4yNSAwIDAgMS0xLjUxMyAwbC0uMDc5LS4wNThLTEuNzYyLTEuMzQzYS43NS43NSAwIDAgMS0uMy0uNjA1Ljc1Ljc1IDAgMCAxIC4zLS42MDUuNzQuNzQgMCAwIDEgLjQ0NS0uMTQ2aDQuMjc1Yy4xNjYgMCAuMzI3LjA1NC40NTkuMTU0bC4wODMuMDc1YS43My43MyAwIDAgMSAuMjMuNTNNMjIgMTIuMDEzYzAgMi41MS0uOTQzIDQuOTMtMi42NCA2Ljc3YTEwIDEwIDAgMCAxLTUuNjI4IDMuMDgxYy0uNDguMDg1LS44OTgtLjMwMi0uODk4LS43OXYtNC4zMDljMC0uMzcuMjUyLS42ODUuNTc2LS44NjRxLjE4OC0uMTAyLjM1Ny0uMjMybDEuODQyLTEuNDAyYTIuNCAyLjQgMCAwIDAgLjk0LTIuMTg0Yy0uMDQtLjM1Ni4wNDgtLjczNC4zMjYtLjk2bDIuNzktMi4yNmEuODMuODMgMCAwIDEgLjUyLS4xODdsLjk3OS0uMDA0Yy4xODcgMCAuMzI2LjE1My4zODIuMzMxLjI5Ni45NDQuNDU1IDEuOTQ5LjQ1NSAyLjk5ekwxMS4xNjcgMTYuNzljMC0uMzczLS4yNTUtLjY5LS41ODQtLjg2NmEzIDMgMCAwIDEtLjM1NC0uMjIzbC0xLjgzNy0xLjQwMmEyLjQxIDIuNDEgMCAwIDEtLjkzMi0yLjI5M2MuMDU2LS4zNzItLjAyNS0uNzc1LS4zMTctMS4wMTJsLTIuNjEtMi4xMTlhLjgzLjgzIDAgMCAwLS41MjUtLjE4N0gyLjgzM2MtLjE4NyAwLS4zMjYuMTU1LS4zODIuMzM0QTEwIDEwIDAgMCAwIDIgMTJ2LjAyNmMwIDIuNTEuOTQzIDQuOTI5IDIuNjQxIDYuNzc2YTEwIDEwIDAgMCAwIDUuNjI3IDMuMDgyYy40OC4wODQuODk5LS4zMDIuODk5LS43OXoiPjwvcGF0aD48L3N2Zz4=" alt="Scarlab logo"></a></p>
2
2
 
3
- 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.
3
+ <p align="center">
4
+ <a href="https://www.npmjs.com/package/@scarlab-icons/js"><img src="https://img.shields.io/npm/v/@scarlab-icons/js?color=%23cb0000" alt="npm version"></a>
5
+ <a href="https://www.npmjs.com/package/@scarlab-icons/js"><img src="https://img.shields.io/npm/dm/@scarlab-icons/js" alt="npm version"></a>
6
+ </p>
7
+
8
+ # [Scarlab Icons](http://scarlab-icons.la-moore.ru/)
9
+ Scarlab Icons is a collection of more than 2800 simply, beautiful and open source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency, and flexibility.
10
+
11
+ [scarlab-icons](http://scarlab-icons.la-moore.ru/)
12
+
13
+ ```shell
14
+ npm install @scarlab-icons/js
15
+ ```
16
+
17
+ ### Include
18
+ ```js
19
+ import { replace } from '@scarlab-icons/js'
20
+ ```
21
+
22
+ ### Use
23
+
24
+ ```html
25
+ <!-- HTML elements with data attributes -->
26
+ <div data-scarlab="activity" data-style="base" class="icon"></div>
27
+ <div data-scarlab="heart" data-style="ghost" stroke="red"></div>
28
+ <div data-scarlab="star" data-style="outline" data-stroke-width="3"></div>
29
+ ```
30
+
31
+ ```js
32
+ // Auto-replace elements with data-scarlab attribute
33
+ replace({
34
+ stroke: 'currentColor',
35
+ strokeWidth: 2
36
+ })
37
+ ```
38
+
39
+ ### Data Attributes
40
+
41
+ - `data-scarlab` - Icon name (required)
42
+ - `data-style` - Icon style: `base`, `ghost`, `outline`, `solid` (optional, default: `base`)
43
+ - `data-stroke-width` - Stroke width for non-solid icons (optional, default: `2`)
44
+
45
+ ### Custom Attributes
46
+
47
+ Any other HTML attributes will be passed through to the generated SVG element:
48
+
49
+ ```html
50
+ <div data-scarlab="activity"
51
+ data-style="base"
52
+ class="custom-icon"
53
+ width="32"
54
+ height="32"
55
+ stroke="#ff6800">
56
+ </div>
57
+ ```
58
+
59
+ ## Figma
60
+ Scarlab Icons is available as a [Figma component library](https://www.figma.com/community/file/1051907827478622063/Scarab-Icons). To use the components, log in to your Figma account and duplicate the file to your drafts.
61
+
62
+ Or you can use Scarlab Icons as a [Figma plugin](https://www.figma.com/community/plugin/1053846082213772972/Scarlab-Icons)
63
+
64
+
65
+ ## License
66
+ Scarlab Icons is licensed under the [MIT License](https://github.com/la-moore/scarlab-icons/blob/master/LICENSE)..