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

Update readme

Browse Source
This commit is contained in:
Bradley Goode
2023-06-27 11:41:57 +01:00
parent 1d91b50c32
commit c1ac0faf78
1 changed files with 7 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -33,11 +33,12 @@ pcm_icon:
fill-group-hover: 'group-hover:fill-red-800' fill-group-hover: 'group-hover:fill-red-800'
stroke-group-hover: 'group-hover:stroke-red-800' stroke-group-hover: 'group-hover:stroke-red-800'
``` ```
# @TODO default options
`default` - Override the default options provided to the bundle.
`directories` - Which directories to look in for icons. `directories` - Which directories to look in for icons.
`colours` - Custom colours to use when colouring icons. Because this extension relies on Tailwind classes for colouring we must specify all the classes. This is a bit awkward, but you can just copy this template replacing COLOUR as appropriate: `colours` - Custom colours to use when colouring icons. Because this extension relies on Tailwind classes for colouring we **must** explicitly list all the classes required for Tailwind to render them properly. You can just copy this template replacing COLOUR as appropriate:
```yaml ```yaml
COLOUR: COLOUR:
@@ -51,22 +52,13 @@ COLOUR:
## Options ## Options
`icon (string)` **(REQUIRED)** Icon to use, without the `.svg` extension `icon (string)` **(REQUIRED)** Icon to use, without the `.svg` extension.
`title (string)` Optional text to show on hover `title (string)` Optional text to show on hover. This can be null, but not an empty string.
`size (int)` Size of the icon in pixels `size (int)` Size of the icon in pixels.
`colour (string)` Name of the colour to use. Defaults to `primary` as it assumes you have a Tailwind colour set up called `primary`. 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 colour uses. EG: `colour (string)` Name of the colour to use. Defaults to `primary` as it assumes you have a Tailwind colour set up called `primary`. If you are not using `primary` to set a Tailwind primary colour in your project you can change the default colour in the `pcm_icon.yaml` file.
```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 to use when the icon is hovered over `hover (string)` Name of the colour to use when the icon is hovered over