Skip to content

Commit cad809f

Browse files
committed
refinement icons
1 parent 6f5208a commit cad809f

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

icons.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@
66

77
## Bootstrap Icons
88

9-
Bootstrap is the default CSS Framework in Plone 6. We decided to use it's icons as well. Check out all available Icons:
9+
Bootstrap is the default CSS Framework in Plone 6.
10+
We decided to use it's icons as well.
11+
Check out all available Icons at [icons.getbootstrap.com](https://icons.getbootstrap.com/).
1012

11-
https://icons.getbootstrap.com/
12-
13-
Icons are shipped via plone.staticresources. Check out the [package.json](https://github.com/plone/plone.staticresources/blob/master/package.json) of the package to get the actual version of the icons in Plone.
13+
Icons are shipped via plone.staticresources.
14+
Check out the [package.json](https://github.com/plone/plone.staticresources/blob/master/package.json) of the package to get the actual version of the icons in Plone.
1415

1516
## Registration
1617

@@ -32,7 +33,7 @@ We definde contextual icons. If you don't like e.g. the share icon - override it
3233

3334
## Icon expression
3435

35-
- icon_expression field is used again to define icons (e.g. for actions, contenttypes)
36+
- `icon_expression` field is used again to define icons (e.g. for actions, contenttypes)
3637
- Use icon name for icon expressions
3738

3839
## Customization
@@ -53,30 +54,28 @@ We definde contextual icons. If you don't like e.g. the share icon - override it
5354

5455
URL method of @@icons view returns the actual URL to the SVG icon. This can be used e.g. in an img tag.
5556

56-
```
57+
```HTML
5758
<img src="" tal:attributes="src python:icons.url('alarm')" class="custom-class" alt="foo" />
5859
```
5960

6061
### Get Icon Tag
6162

62-
Tag method is used with tal:replace and returns an entire inline SVG image. Inline icons can be styled via CSS. tag_class and tag_alt is used to pass in custom classes and an alt text.
63+
Tag method is used with `tal:replace` and returns an entire inline SVG image.
64+
Inline icons can be styled via CSS.
65+
`tag_class` and `tag_alt` is used to pass in custom classes and an alt text.
6366

64-
```
67+
```HTML
6568
<tal:icon tal:replace="structure python:icons.tag('archive', tag_class='custom-class', tag_alt='foobar')" />
6669
```
6770

6871
### Resource Path
6972

70-
SVG Files are avaiblae as resource.
71-
72-
```
73-
++plone++bootstrap-icons/lightning.svg
74-
```
73+
SVG Files are avaiblae as resource: `++plone++bootstrap-icons/lightning.svg`
7574

7675
### Fallback
7776

7877
- There is a Plone icon defined as fallback if icon name is not found
7978
- There are fallback groups e.g. for [mimetype icons](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_mimetype.xml)
80-
- JPEG icon is e.g. mimetype-image/jpeg
79+
- JPEG icon is e.g. `mimetype-image/jpeg`
8180
- You can register specific icons
82-
- If there is no specific icon mmimetype-image is used as fallback
81+
- If there is no specific icon mimetype-image is used as fallback

0 commit comments

Comments
 (0)