@scarlab-icons/js 3.0.0 → 3.1.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/README.md CHANGED
@@ -1,4 +1,4 @@
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>
1
+ <p align="center"><a href="https://scarlab-icons.la-moore.ru" target="_blank" rel="noopener noreferrer"><img width="100" src="https://raw.githubusercontent.com/la-moore/scarlab-icons/master/.github/logo.svg" alt="Scarlab logo"></a></p>
2
2
 
3
3
  <p align="center">
4
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>
@@ -6,7 +6,7 @@
6
6
  </p>
7
7
 
8
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.
9
+ Scarlab Icons is a collection of more than 1400 simple, beautiful and open source icons. Each icon is designed on a 24x24 grid with an emphasis on simplicity, consistency, and flexibility.
10
10
 
11
11
  [scarlab-icons](http://scarlab-icons.la-moore.ru/)
12
12
 
@@ -56,6 +56,24 @@ Any other HTML attributes will be passed through to the generated SVG element:
56
56
  </div>
57
57
  ```
58
58
 
59
+ ### Accessibility
60
+ Icons are decorative by default and rendered with `aria-hidden="true"`. Add `aria-label` (or `aria-labelledby`) to give an icon an accessible name — `aria-hidden` is then omitted:
61
+
62
+ ```html
63
+ <div data-scarlab="heart" aria-label="Like"></div>
64
+ ```
65
+
66
+ ### API
67
+
68
+ ```js
69
+ import { getIcon, toSvg } from '@scarlab-icons/js'
70
+
71
+ const icon = getIcon('heart', 'outline') // IconNode | undefined, style defaults to 'base'
72
+ const svg = toSvg(icon, { width: 32, strokeWidth: 3, class: 'my-icon' })
73
+ ```
74
+
75
+ `toSvg` converts camelCase names to kebab-case (`strokeWidth` → `stroke-width`), escapes values and skips `null`, `undefined` and `false`.
76
+
59
77
  ## Figma
60
78
  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
79