@optiaxiom/icons
v1.1.3
Published
Material Symbols kit for use with the Optimizely Design System.
Readme
Axiom Icons Library
Material Symbols kit for use with the Optimizely Design System.
Getting Started
npm install @optiaxiom/iconsimport { IconDelete } from "@optiaxiom/icons";
function App() {
return (
<>
<IconDelete />
<IconDelete size="md" />
<IconDelete filled />
</>
);
}Check out our Icons Guide to learn more and explore all available icons.
Contributing
Adding new icons
- Find the icon name on Material Symbols
- Add the icon name to
icons.json(use the snake_case name, e.g.arrow_back) - Run
npm run buildto fetch the SVGs and rebuild the package - Commit the updated
icons.json,src/index.ts, andsvg/*.svg.d.ts
How it works
Icons are fetched directly from Google Fonts as SVGs using the following parameters:
- Style: Rounded
- Weight: 300
- Grade: 200
- Optical size: 40px
The SVG files are committed to the svg/ directory. The icons.json file is the source of truth for which icons are included. At build time, a Rollup plugin converts each SVG into a React component.
See the main repository for general contribution guidelines.
License
Apache-2.0
