pcm-libraries/pcm-icon-bundle
Public Access
3
0
Fork 0
Code Issues 5 Packages Releases Activity

Add to readme

Browse Source
This commit is contained in:
Brabli
2022-12-05 12:44:28 +00:00
parent b2f6e07d97
commit d5278f3473
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,6 +1,7 @@
# PCM Icon Bundle # PCM Icon Bundle
Use icons inside of Twig templates with ease! Use icons inside of Twig templates with ease! Project must be using Tailwind for the colours to work properly.
```php ```php
{{ icon({ icon: 'person' }) }} {{ icon({ icon: 'person' }) }}
@@ -52,9 +53,18 @@ PALLETE_NAME:
`size (int)` Size of the icon in pixels `size (int)` Size of the icon in pixels
`colour (string)` Name of the main colour pallete to use. Defaults to `"primary"`, assuming that a pallete with the project's primary colour will exist `colour (string)` Name of the main colour pallete to use. Defaults to `"primary"`, which is a pallete that uses the project's primary colour. If however you are not using `primary` to set a Tailwind primary colour in your project, you can instead set the default colour of the icon by changing what colour classes the primary pallete uses. EG:
```yaml
primary:
fill: 'fill-purple-700'
stroke: 'stroke-purple-700'
fill-hover: 'hover:fill-purple-700'
stroke-hover: 'hover:stroke-purple-700'
fill-group-hover: 'group-hover:fill-purple-700'
stroke-group-hover: 'group-hover:stroke-purple-700'
```
`hover (string)` Name of the colour pallete to use when the icon is hovered over `hover (string)` Name of the colour pallete to use when the icon is hovered over
## Reminders ## Reminders
Remember to add `./config/packages/*.yaml` as a value in your Tailwind config content array if it does not already exist. Remember to add `./config/packages/*.yaml` as a value in your Tailwind config content array if it does not already exist. This will ensure Tailwind classes inside of the config file get compiled.