@tabler/icons-solidjs 3.45.0 → 3.47.0

package/README.md

@@ -5,21 +5,21 @@
 </p>
 
 <p align="center">
-Implementation of the Tabler Icons library for SolidJS applications.
-<p>
+  Implementation of the Tabler Icons library for SolidJS applications.
+</p>
 
 <p align="center">
   <a href="https://tabler.io/icons"><strong>Browse all icons at tabler.io &rarr;</strong></a>
 </p>
 
 <p align="center">
-    <a href="https://github.com/tabler/tabler-icons/releases"><img src="https://img.shields.io/npm/v/@tabler/icons" alt="Latest Release"></a>
-    <a href="https://github.com/tabler/tabler-icons/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons.svg" alt="License"></a>
+  <a href="https://www.npmjs.com/package/@tabler/icons-solidjs"><img src="https://img.shields.io/npm/v/@tabler/icons-solidjs" alt="Latest release"></a>
+  <a href="https://github.com/tabler/tabler-icons/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@tabler/icons-solidjs.svg" alt="License"></a>
 </p>
 
 ## Sponsors
 
-**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) :)**
+**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).**
 
 <a href="https://github.com/sponsors/codecalm">
   <img src="https://cdn.jsdelivr.net/gh/tabler/sponsors@latest/sponsors.svg" alt="Tabler sponsors">
@@ -27,29 +27,25 @@ Implementation of the Tabler Icons library for SolidJS applications.
 
 ## Installation
 
-```
-yarn add @tabler/icons-solidjs
-```
-
-or
-
-```
+```sh
 npm install @tabler/icons-solidjs
 ```
 
-or
-
+```sh
+yarn add @tabler/icons-solidjs
 ```
-pnpm install @tabler/icons-solidjs
+
+```sh
+pnpm add @tabler/icons-solidjs
 ```
 
-or just [download from GitHub](https://github.com/tabler/tabler-icons/releases).
+You can also [download the latest release from GitHub](https://github.com/tabler/tabler-icons/releases).
 
-## How to use
+## Usage
 
-It's build with ESmodules so it's completely tree-shakable. Each icon can be imported as a component.
+The package is built with ES modules, so unused icons are tree-shaken from your bundle. Each icon is exported as a component.
 
-```js
+```jsx
 import { IconArrowRight } from '@tabler/icons-solidjs';
 
 const App = () => {
@@ -59,30 +55,28 @@ const App = () => {
 export default App;
 ```
 
-You can pass additional props to adjust the icon.
+Pass props to adjust the icon:
 
-```js
-<IconArrowRight color="red" size={48} />
+```jsx
+<IconArrowRight color="red" size={48} stroke={1.5} />
 ```
 
 ### Props
 
-| name          | type     | default      |
-| ------------- | -------- | ------------ |
-| `size`        | _Number_ | 24           |
-| `color`       | _String_ | currentColor |
-| `stroke`      | _Number_ | 2            |
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| `size` | _number | string_ | 24 | Width and height of the icon |
+| `color` | _string_ | currentColor | Stroke color for outline icons, fill color for filled icons |
+| `stroke` | _number | string_ | 2 | Stroke width, outline icons only. `strokeWidth` is accepted as an alias |
+| `title` | _string_ | – | Adds a `<title>` element for accessibility |
+| `class` | _string_ | – | Extra classes added to `tabler-icon tabler-icon-{{name}}` |
 
-## Contributing
+Any other attribute is forwarded to the rendered `<svg>` element. The package ships with TypeScript declarations.
 
-For more info on how to contribute please see the [contribution guidelines](https://github.com/tabler/tabler-icons/blob/main/CONTRIBUTING.md).
+## Contributing
 
-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-solidjs/README.md)
+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-solidjs/README.md).
 
 ## License
 
 Tabler Icons is licensed under the [MIT License](https://github.com/tabler/tabler-icons/blob/main/LICENSE).
-
-## Sponsor Tabler
-
-<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>