NYPL SVG Icons


SVG icons used at NYPL Digital as React Components.
Version 0.3.12

This project uses Styleguidist to generate a page with all the available icons and their properties here: https://nypl.github.io/dgx-svg-icons/

$3

npm i --save @nypl/dgx-svg-icons

$3

* npm install
* npm start
* Go to localhost:3000

$3

All the icons are exported individually so you can choose which ones you want to import.

``javascript
import React from 'react';
import { render } from 'react-dom';

import {
LionLogoIcon,
BookIcon,
} from 'dgx-svg-icons';


render(
,
document.getElementById('LionLogoIcon')
);

`

$3


* Create a feature branch from development
* From the command line rebuild the /dist directory with npm run build.
* Optional but useful: rebuild the /docs styleguide with npm run styleguide:build.
* Add & commit the new /dist and /docs folders and make the pull request
with development as the base.
* Changes must be approved by a peer reviewer
* Merge changes upon approval
* Merge development into master
* Create a tag for use by npmjs.com

$3

There are props that all components use:

prop | type
--- | ---
ariaHidden | boolean
className | string
height | string
iconId | string
preserveAspectRatio | string
svgRole | string
title | string
width | string
viewBox | string

By default, the defaultProps generate:

* viewBox
* title
* className
* preserveAspectRatio
* svgRole

There are also props such as fill, style, and size for only a few components.

$3

There are certain icons that will appear multiple times and have presentational value, but not necessarily semantic or have value with respect to accessibility, and others where there should only be one instance.

In the case of multiple rendering of an icon, such as the three-dotted "more" icon a unique ID is not required and should not be set (unless your application requires it to be set), but it should have the ariaHidden attribute set (if not already set by default in the icon.jsx file).

Example:
`javascript

render();

`

In the case where a unique id should be set for each instance and in the case of it appearing multiple times. The iconId property will set id="{iconId}" on the svg's title attribute, this will also set aria-labelledby attribute on the tag. icon.jsx files that should have an id will throw a console error if it is missing, but the .jsx file itself will not set one by default, you must explicitly set it.

Example:
`javascript

render();

`

$3

We are using Styleguidist as an interactive styleguide for our icon components. To run the styleguide locally, run

`
$ npm run styleguide
`

Alternatively, you can build the styleguide and start a local server in the generated /docs folder. To do so, run

`
$ npm run styleguide:build
`

then run

`
$ cd docs && python -m SimpleHTTPServer 4000
`

then go to localhost:4000 to see the styleguide. Doing this will serve the same styleguide that Github Pages will serve up... like a hot-fudge sunday.

$3

Component Name | Component Markup
--- | ---
ApplyIcon |
AudioDiscIcon |
AudioHeadphoneIcon |
BookIcon |
CarouselCircleIcon |
CheckSoloIcon |
CircleDashIcon |
DivideLineIcon |
DotsIcon |
DownLoadIcon |
DownWedgeIcon |
DvdDiscIcon |
EReaderIcon |
EnvelopeIcon |
FaceBookIcon |
FilterIcon |
FilterCancelIcon |
GridIcon |
LargePrintIcon |
LeftWedgeIcon |
LionLogoIcon |
LionLogoWithText |
LionLogoWithTextInverse |
ListIcon |
LibraryCardIcon |
LocatorIcon |
LoginIcon |
LoginIconSolid |
LogoutIcon |
MediaBluRayIcon |
MenuIcon |
NYPLTextLogo |
RadioActiveIcon |
RadioInactiveIcon |
ResetIcon |
RightWedgeIcon |
SearchIcon |
SmallDotClosedIcon |
SmallDotOpenIcon |
TagIcon |
TwitterIcon |
XIcon |
xCloseIcon |
BuildingIcon |
GenericWedgeIcon |
LeftArrowIcon |
RightArrowIcon | `