@tabler/icons-sprite 3.46.0 → 3.47.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.
Files changed (4) hide show
  1. package/README.md +32 -24
  2. package/dist/tabler-sprite-nostroke.svg +1 -1
  3. package/dist/tabler-sprite.svg +1 -1
  4. package/package.json +2 -2
package/README.md CHANGED
@@ -1,25 +1,25 @@
1
- # Tabler Icons
1
+ # Tabler Icons Sprite
2
2
 
3
3
  <p align="center">
4
4
  <a href="https://tabler.io/icons?ref=tabler-icons-readme"><img src="https://raw.githubusercontent.com/tabler/tabler-icons/main/.github/packages/og-package-sprite.png" alt="Tabler Icons" width="838"></a>
5
5
  </p>
6
6
 
7
7
  <p align="center">
8
- A set of <!--icons-count-->6184<!--/icons-count--> free MIT-licensed high-quality SVG icons for you to use in your web projects. Each icon is designed on a 24x24 grid and a 2px stroke.
9
- <p>
8
+ SVG sprite with all <!--icons-count-->6202<!--/icons-count--> Tabler Icons, ready to use with <code>&lt;use&gt;</code>.
9
+ </p>
10
10
 
11
11
  <p align="center">
12
12
  <a href="https://tabler.io/icons"><strong>Browse all icons at tabler.io &rarr;</strong></a>
13
13
  </p>
14
14
 
15
15
  <p align="center">
16
- <a href="https://github.com/tabler/tabler-icons/releases"><img src="https://img.shields.io/npm/v/@tabler/icons-sprite" alt="Latest Release"></a>
17
- <a href="https://github.com/tabler/tabler-icons/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons-sprite.svg" alt="License"></a>
16
+ <a href="https://www.npmjs.com/package/@tabler/icons-sprite"><img src="https://img.shields.io/npm/v/@tabler/icons-sprite" alt="Latest release"></a>
17
+ <a href="https://github.com/tabler/tabler-icons/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons-sprite.svg" alt="License"></a>
18
18
  </p>
19
19
 
20
20
  ## Sponsors
21
21
 
22
- **If you want to support my project and help me grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or just [donate on PayPal](https://paypal.me/codecalm) :)**
22
+ **If you want to support our project and help us grow it, you can [become a sponsor on GitHub](https://github.com/sponsors/codecalm) or [donate on PayPal](https://paypal.me/codecalm).**
23
23
 
24
24
  <a href="https://github.com/sponsors/codecalm">
25
25
  <img src="https://cdn.jsdelivr.net/gh/tabler/sponsors@latest/sponsors.svg" alt="Tabler sponsors">
@@ -27,44 +27,52 @@
27
27
 
28
28
  ## Installation
29
29
 
30
+ ```sh
31
+ npm install @tabler/icons-sprite
30
32
  ```
33
+
34
+ ```sh
31
35
  yarn add @tabler/icons-sprite
32
36
  ```
33
37
 
34
- or
35
-
36
- ```
37
- npm install @tabler/icons-sprite
38
+ ```sh
39
+ pnpm add @tabler/icons-sprite
38
40
  ```
39
41
 
40
- or
42
+ You can also [download the latest release from GitHub](https://github.com/tabler/tabler-icons/releases).
41
43
 
42
- ```
43
- pnpm install @tabler/icons-sprite
44
+ ## Usage
45
+
46
+ Reference an icon from the sprite by its name prefixed with `tabler-`. Replace `activity` in the example below with any valid icon name.
47
+
48
+ ```html
49
+ <svg width="24" height="24">
50
+ <use xlink:href="path/to/tabler-sprite.svg#tabler-activity" />
51
+ </svg>
44
52
  ```
45
53
 
46
- or just [download from GitHub](https://github.com/tabler/tabler-icons/releases).
54
+ The package ships three sprites in the `dist` directory:
47
55
 
48
- ## Usage
56
+ | File | Description |
57
+ | --- | --- |
58
+ | `tabler-sprite.svg` | Outline icons with a fixed 2px stroke |
59
+ | `tabler-sprite-nostroke.svg` | Outline icons without a `stroke-width` attribute, so you can set the stroke width with CSS |
60
+ | `tabler-sprite-filled.svg` | Filled icons |
49
61
 
50
- Add an icon to be displayed on your page with the following markup (`activity` in the following example can be replaced with any valid icon name):
62
+ ## CDN
51
63
 
52
64
  ```html
53
65
  <svg width="24" height="24">
54
- <use xlink:href="path/to/tabler-sprite.svg#tabler-activity" />
66
+ <use xlink:href="https://cdn.jsdelivr.net/npm/@tabler/icons-sprite@latest/dist/tabler-sprite.svg#tabler-activity" />
55
67
  </svg>
56
68
  ```
57
69
 
58
- ## Contributing
70
+ Replace `latest` with a specific version number to pin a release.
59
71
 
60
- For more info on how to contribute please see the [contribution guidelines](https://github.com/tabler/tabler-icons/blob/main/CONTRIBUTING.md).
72
+ ## Contributing
61
73
 
62
- Caught a mistake or want to contribute to the documentation? [Edit this page on GitHub](https://github.com/tabler/tabler-icons/blob/main/packages/icons/README.md)
74
+ Bug reports and icon requests are welcome in the [issue tracker](https://github.com/tabler/tabler-icons/issues). Caught a mistake in this page? [Edit it on GitHub](https://github.com/tabler/tabler-icons/blob/main/packages/icons-sprite/README.md).
63
75
 
64
76
  ## License
65
77
 
66
78
  Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/main/LICENSE).
67
-
68
- ## Sponsor Tabler
69
-
70
- <a href="https://github.com/sponsors/codecalm" target="_blank"><img src="https://github.com/tabler/tabler/raw/dev/src/static/sponsor-banner-readme.png?raw=true" alt="Sponsor Tabler" /></a>