Manual:Extension/ContentDroplets/Icon: Difference between revisions

Created page with "==<span class="mw-headline" id="Using_the_template">Using the template</span>== === Bootstrap icons === {{Messagebox|boxtype=important|icon=|Note text=BlueSpice does not always include the latest version of bootstrap icons. [https://en.wiki.bluespice.com/w/skins/BlueSpiceDiscovery/resources/bootstrap/icons/index.html See the list of currently supported icons.]|bgcolor=}} #'''Find''' a bootstrap icon from the Bootstrap website at https://icons.getbootstrap.com/<nowiki/>'..."
 
No edit summary
Tag: 2017 source edit
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
==<span class="mw-headline" id="Using_the_template">Using the template</span>==
==About icons==
The '''Icon''' Content droplet allows you to insert icons from the Bootstrap and FontAwesome libraries onto a page.
 
* Bootstrap: https://icons.getbootstrap.com/
* FontAwesome: https://fontawesome.com/search?ic=free-collection
 
* View the icon selection from both libraries [[Manual:Extension/ContentDroplets/Icon#Icon selection|at the end of this page]].
{{Textbox|boxtype=note|header=Compatibility|text=The official icon websites always display all icons from the most recent versions of these libraries. If there is a version discrepancy between the library included in BlueSpice and the official version, it is possible that not all icons will be available for display within BlueSpice.|icon=yes}}


=== Bootstrap icons ===
=== Bootstrap icons ===
{{Messagebox|boxtype=important|icon=|Note text=BlueSpice does not always include the latest version of bootstrap icons. [https://en.wiki.bluespice.com/w/skins/BlueSpiceDiscovery/resources/bootstrap/icons/index.html See the list of currently supported icons.]|bgcolor=}}
#'''Find''' a Bootstrap or FontAwesome icon.
#'''Find''' a bootstrap icon from the Bootstrap website at https://icons.getbootstrap.com/<nowiki/>'''Click''' on the icon you would like to use. The icon page shows you the class-name of the icon on the right side of the page:[[File:bootstrap-award-icon.png|alt=Bootstrap icon css-class|center|thumb|650x650px|Bootstrap icon css-class]]
#'''Highlight''' the <nowiki/>class name (it has the format ''bi bi-myicon'') and '''copy''' it to your clipb<nowiki/>oard (ctrl+c) (or remember the class name).
#'''Highlight''' the class name (it has the format ''bi bi-myicon'') and '''copy''' it to your clipboard (ctrl+c).
#'''Go back''' to your wiki page.
#'''Go back''' to your wiki page.
#'''Enter''' <code><nowiki>{{</nowiki></code> in visual editing mode at the cursor position where you want to insert the icon. The template editor opens.
#'''Open''' the Droplets dialog in VisualEditor:
#'''Copy''' the icon class from your clipboard:[[File:template-editor-icon.png|alt=Template editor|center|thumb|450x450px|Template editor]]
#'''Select''' the Icon-droplet:[[File:icon-droplet.png|alt=screenshot showing the 3 steps to select the icon-droplet|center|thumb|450x450px|Selecting the icon droplet]]
##'''Search''' for the droplet "Icon"
##'''Click''' on the Icon-card
##'''Click''' the ''Insert'' button
# '''Copy''' the icon class from your clipboard (or enter it manually):[[File:template-editor-icon.png|alt=Template editor|center|thumb|450x450px|Template editor]]
#'''Change''' the font size (optional) if you want the size to be different from the text surrounding it (e.g., from the size of a heading if the icon is placed in the heading or of the paragraph text if the icon is placed in the flow-text.  Smaller than text icons are usually sized no smaller than 0.85em and larger icons up to 2.5em.
#'''Change''' the font size (optional) if you want the size to be different from the text surrounding it (e.g., from the size of a heading if the icon is placed in the heading or of the paragraph text if the icon is placed in the flow-text.  Smaller than text icons are usually sized no smaller than 0.85em and larger icons up to 2.5em.
#'''Color:''' If you want the color to be different from the surrounding text, you can specify any web color (e.g., a color name like blue or a hex-valuesuch as #0059b3 for a more specific blue). A list of web colors can be found at https://www.w3schools.com/colors/colors_picker.asp
#'''Color:''' If you want the color to be different from the surrounding text, you can specify any web color (e.g., a color name like blue or a hex-valuesuch as #0059b3 for a more specific blue). A list of web colors can be found at https://www.w3schools.com/colors/colors_picker.asp
Line 16: Line 26:


[[File:bootstrap-icon-on page.png|alt=Inserted Bootstrap icon|center|thumb|450x450px|Inserted Bootstrap icon]]
[[File:bootstrap-icon-on page.png|alt=Inserted Bootstrap icon|center|thumb|450x450px|Inserted Bootstrap icon]]
== Icon selection ==
Here is a selection of supported icons and their class names.
=== Bootstrap icons ===
https://icons.getbootstrap.com/
These icons have the syntax  <code>bi bi-<iconname></code>.
<div style="display:flex; flex-wrap:wrap; gap:10px;">
<!-- Communication -->
{{IconCard|envelope}}
{{IconCard|chat-dots}}
{{IconCard|telephone}}
{{IconCard|megaphone}}
{{IconCard|headset}}
<!-- Buildings -->
{{IconCard|building}}
{{IconCard|bank}}
{{IconCard|shop}}
{{IconCard|hospital}}
{{IconCard|house-door}}
<!-- Commerce -->
{{IconCard|cart}}
{{IconCard|credit-card}}
{{IconCard|cash-coin}}
{{IconCard|receipt}}
{{IconCard|piggy-bank}}
{{IconCard|truck}}
{{IconCard|box-seam}}
<!-- Tools -->
{{IconCard|wrench}}
{{IconCard|hammer}}
{{IconCard|tools}}
{{IconCard|key}}
<!-- People -->
{{IconCard|person}}
{{IconCard|people}}
{{IconCard|person-badge}}
{{IconCard|briefcase}}
<!-- Business and general -->
{{IconCard|calendar}}
{{IconCard|clock}}
{{IconCard|lightbulb}}
{{IconCard|globe}}
{{IconCard|shield-check}}
<!-- Analytics and success -->
{{IconCard|graph-up}}
{{IconCard|pie-chart}}
{{IconCard|trophy}}
{{IconCard|award}}
<!-- Commerce -->
{{IconCard|bag}}
{{IconCard|gift}}
<!-- Office and devices -->
{{IconCard|printer}}
{{IconCard|camera}}
{{IconCard|laptop}}
{{IconCard|cpu}}
<!-- Documents and organization -->
{{IconCard|book}}
{{IconCard|folder}}
{{IconCard|clipboard-check}}
<!-- General -->
{{IconCard|geo-alt}}
{{IconCard|lock}}
</div>


=== FontAwesome icons ===
=== FontAwesome icons ===
The exension [[Reference:FontAwesome|FontAwesome]] is bundled starting at BlueSpice version 4.3. In one of our next patches, we will add the possibility to use them in the Icon droplet.  
https://fontawesome.com/search?ic=free-collection
 
 
 
These icons have the syntax  <code>fas-fa-<iconname></code>.
 
 
 
<div style="display:flex; flex-wrap:wrap; gap:10px;">
 
<!-- Communication -->
{{IconCardFA|envelope}}
{{IconCardFA|comments}}
{{IconCardFA|phone}}
{{IconCardFA|bullhorn}}
{{IconCardFA|headset}}
 
<!-- Buildings -->
{{IconCardFA|building}}
{{IconCardFA|university}}
{{IconCardFA|store}}
{{IconCardFA|hospital}}
{{IconCardFA|home}}
{{IconCardFA|industry}}
{{IconCardFA|warehouse}}
 
<!-- Commerce -->
{{IconCardFA|shopping-cart}}
{{IconCardFA|credit-card}}
{{IconCardFA|coins}}
{{IconCardFA|receipt}}
{{IconCardFA|piggy-bank}}
{{IconCardFA|truck}}
{{IconCardFA|box}}
{{IconCardFA|chart-line}}
 
<!-- Tools -->
{{IconCardFA|wrench}}
{{IconCardFA|hammer}}
{{IconCardFA|tools}}
{{IconCardFA|key}}
 
<!-- People -->
{{IconCardFA|user}}
{{IconCardFA|users}}
{{IconCardFA|id-badge}}
{{IconCardFA|briefcase}}
{{IconCardFA|handshake}}
 
<!-- General -->
{{IconCardFA|calendar-alt}}
{{IconCardFA|clock}}
{{IconCardFA|lightbulb}}
{{IconCardFA|globe}}
 
<!-- Analytics and success -->
{{IconCardFA|chart-pie}}
{{IconCardFA|trophy}}
{{IconCardFA|award}}
 
<!-- Commerce -->
{{IconCardFA|shopping-bag}}
{{IconCardFA|gift}}
 
<!-- Office and devices -->
{{IconCardFA|print}}
{{IconCardFA|camera}}
{{IconCardFA|laptop}}
{{IconCardFA|microchip}}
 
<!-- Documents and organization -->
{{IconCardFA|book}}
{{IconCardFA|folder}}
{{IconCardFA|clipboard-check}}
 
<!-- People and education -->
{{IconCardFA|graduation-cap}}
 
<!-- General -->
{{IconCardFA|map-marker-alt}}
{{IconCardFA|lock}}
</div>
__FORCETOC__
__FORCETOC__
[[de:Handbuch:Erweiterung/ContentDroplets/Symbol]]

Latest revision as of 15:24, 27 October 2026

PDF exclude - start
PDF exclude - end

About icons

The Icon Content droplet allows you to insert icons from the Bootstrap and FontAwesome libraries onto a page.

Compatibility The official icon websites always display all icons from the most recent versions of these libraries. If there is a version discrepancy between the library included in BlueSpice and the official version, it is possible that not all icons will be available for display within BlueSpice.


Bootstrap icons

  1. Find a Bootstrap or FontAwesome icon.
  2. Highlight the class name (it has the format bi bi-myicon) and copy it to your clipboard (ctrl+c) (or remember the class name).
  3. Go back to your wiki page.
  4. Open the Droplets dialog in VisualEditor:
  5. Select the Icon-droplet:
    screenshot showing the 3 steps to select the icon-droplet
    Selecting the icon droplet
    1. Search for the droplet "Icon"
    2. Click on the Icon-card
    3. Click the Insert button
  6. Copy the icon class from your clipboard (or enter it manually):
    Template editor
    Template editor
  7. Change the font size (optional) if you want the size to be different from the text surrounding it (e.g., from the size of a heading if the icon is placed in the heading or of the paragraph text if the icon is placed in the flow-text. Smaller than text icons are usually sized no smaller than 0.85em and larger icons up to 2.5em.
  8. Color: If you want the color to be different from the surrounding text, you can specify any web color (e.g., a color name like blue or a hex-valuesuch as #0059b3 for a more specific blue). A list of web colors can be found at https://www.w3schools.com/colors/colors_picker.asp
  9. Vertical alignment: It should not be necessary to provide an alignment value. The standard is set to text-top and usually works in headings and in flow-text. If it looks a little off, you can try other vertical-alignment values, such as text-bottom. For a full list of possible values, see https://www.w3schools.com/cssref/pr_pos_vertical-align.asp.
  10. Click Apply changes.

The icon is now displayed on the page.

Inserted Bootstrap icon
Inserted Bootstrap icon

Icon selection

Here is a selection of supported icons and their class names.

Bootstrap icons

https://icons.getbootstrap.com/

These icons have the syntax bi bi-<iconname>.


bi bi-envelope
bi bi-chat-dots
bi bi-telephone
bi bi-megaphone
bi bi-headset
bi bi-building
bi bi-bank
bi bi-shop
bi bi-hospital
bi bi-house-door
bi bi-cart
bi bi-credit-card
bi bi-cash-coin
bi bi-receipt
bi bi-piggy-bank
bi bi-truck
bi bi-box-seam
bi bi-wrench
bi bi-hammer
bi bi-tools
bi bi-key
bi bi-person
bi bi-people
bi bi-person-badge
bi bi-briefcase
bi bi-calendar
bi bi-clock
bi bi-lightbulb
bi bi-globe
bi bi-shield-check
bi bi-graph-up
bi bi-pie-chart
bi bi-trophy
bi bi-award
bi bi-bag
bi bi-gift
bi bi-printer
bi bi-camera
bi bi-laptop
bi bi-cpu
bi bi-book
bi bi-folder
bi bi-clipboard-check
bi bi-geo-alt
bi bi-lock

FontAwesome icons

https://fontawesome.com/search?ic=free-collection


These icons have the syntax fas-fa-<iconname>.


fas fa-envelope
fas fa-comments
fas fa-phone
fas fa-bullhorn
fas fa-headset
fas fa-building
fas fa-university
fas fa-store
fas fa-hospital
fas fa-home
fas fa-industry
fas fa-warehouse
fas fa-shopping-cart
fas fa-credit-card
fas fa-coins
fas fa-receipt
fas fa-piggy-bank
fas fa-truck
fas fa-box
fas fa-chart-line
fas fa-wrench
fas fa-hammer
fas fa-tools
fas fa-key
fas fa-user
fas fa-users
fas fa-id-badge
fas fa-briefcase
fas fa-handshake
fas fa-calendar-alt
fas fa-clock
fas fa-lightbulb
fas fa-globe
fas fa-chart-pie
fas fa-trophy
fas fa-award
fas fa-shopping-bag
fas fa-gift
fas fa-print
fas fa-camera
fas fa-laptop
fas fa-microchip
fas fa-book
fas fa-folder
fas fa-clipboard-check
fas fa-graduation-cap
fas fa-map-marker-alt
fas fa-lock



PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end