@royalnavy/icon-library
v4.26.0
Published
A collection of SVG icons for use in Royal Navy web application development.
Downloads
2,976
Readme
Icon Library
A collection of SVG icons for use in Royal Navy web application development.
Browse Icons & Silhouettes
The icon library uses the Google Material icon set as a baseline.
It has been extended and supplemented with domain specific icons and silhouettes.
Installation
The Royal Navy Icon Library is available as an NPM package.
// npm
npm install @royalnavy/icon-library
// pnpm
pnpm add @royalnavy/icon-library
Usage
import { IconHome } from '@royalnavy/icon-library'
import { SilhouetteAircraftCarrier } from '@royalnavy/icon-library'
// <IconHome size={16} />
// <SilhouetteAircraftCarrier size={128} />
Sizing
The size
prop sets the width
and height
attribute values of the wrapped SVG.
Contributing
Add an SVG icon to src/assets/**/
and run pnpm run build
to generate the consumable artefacts.
The contributing guide resource presents information about our development process.
Questions
The Design System is maintained by a team at the Royal Navy. If you want to know more about the Royal Navy Design System, please email the Design System Team.
Documentation
The documentation website contains all the information you need to build your application using the Royal Navy Design System.
Changelog
If you have recently updated then read the release notes
Roadmap
The Design System Roadmap Board contains the work that has been prioritised for the next 12 months.
License
The Royal Navy Design System is licensed under the Apache License 2.0.