@orbis-cascade/primo-explore-resource-icons
v1.1.0
Published
adds custom resource icons from the Noun Project to primo search results.
Downloads
4
Readme
primo-explore-resource-icons
installation
setting up the dev environment
if you don't have a package.json
as part of your view code, go to your package directory (e.g. /primo-explore/custom/LCC_NEWUI
) and run:
npm init
follow the prompts and fill out basic information for your package.
installing the icons
from inside your package directory (e.g. /primo-explore/custom/LCC_NEWUI
), run:
npm install primo-explore-resource-icons
the icons used are from The Noun Project under a Creative Commons Attribution (CC BY) license, so you need to credit them in a credits page on your site.
one way to do this is by adding the below code to your home_en_US.html
:
<a href="https://github.com/Alliance-PCJWG/primo-explore-resource-icons/blob/master/html/iconcredits.md" title="Icon Credits" target="_blank">Icon Credits</a>
alternatively, you can host the html located in anywhere (e.g. libguides) and provide a link to it yourself.
you can learn more about the license here.
uninstalling the icons
from inside your package directory (e.g. /primo-explore/custom/LCC_NEWUI
), run:
npm uninstall primo-explore-resource-icons