cdransf/eleventy-plugin-tabler-icons
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update tabler icons package

Browse source
This commit is contained in:
Cory Dransfeldt 2024-03-13 12:00:40 -07:00
parent 7bf1bd8f73
commit f0f555e8bf
No known key found for this signature in database
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -11,7 +11,7 @@ Shortcodes to add [tabler icons](https://tabler-icons.io) to your [Eleventy](htt
Install the package: Install the package:
```sh ```sh
npm i -D @cdransf/eleventy-plugin-tablericons npm i -D @cdransf/eleventy-plugin-tabler-icons
``` ```
Then add the plugin to your `.eleventy.js` file: Then add the plugin to your `.eleventy.js` file:
@ -19,7 +19,7 @@ Then add the plugin to your `.eleventy.js` file:
```js ```js
// .eleventy.js // .eleventy.js
module.exports = eleventyConfig => { module.exports = eleventyConfig => {
eleventyConfig.addPlugin(require('@cdransf/eleventy-plugin-tablericons')); eleventyConfig.addPlugin(require('@cdransf/eleventy-plugin-tabler-icons'));
} }
``` ```
@ -40,7 +40,7 @@ Args: `name: string`, `alt?: string`
## Configuration ## Configuration
`eleventy-plugin-tablericons` offers a few options on a configuration object passed to Eleventy's `addPlugin()`: `@cdransf/eleventy-plugin-tabler-icons` offers a few options on a configuration object passed to Eleventy's `addPlugin()`:
- `className?: string` Adds a class to all tabler icons - `className?: string` Adds a class to all tabler icons
- `errorOnMissing: boolean` (default: `false`) Throw an error when passed an invalid style/name or invalid attribute - `errorOnMissing: boolean` (default: `false`) Throw an error when passed an invalid style/name or invalid attribute
@ -50,7 +50,7 @@ Pass the configuration object when adding the plugin:
```js ```js
// .eleventy.js // .eleventy.js
module.exports = eleventyConfig => { module.exports = eleventyConfig => {
eleventyConfig.addPlugin(require('@cdransf/eleventy-plugin-tablericons'), { eleventyConfig.addPlugin(require('@cdransf/eleventy-plugin-tabler-icons'), {
className: 'icon', className: 'icon',
errorOnMissing: true errorOnMissing: true
}); });

4
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "@cdransf/eleventy-plugin-tablericons", "name": "@cdransf/eleventy-plugin-tabler-icons",
"version": "1.0.1", "version": "1.0.0",
"description": "Shortcodes to add Tabler icons to your Eleventy projects", "description": "Shortcodes to add Tabler icons to your Eleventy projects",
"main": "tablericons.js", "main": "tablericons.js",
"files": [ "files": [