@phosphor-icons/webcomponents
Advanced tools
Phosphor is a flexible icon family for interfaces, diagrams, presentations — whatever, really. Explore all our icons at phosphoricons.com.
yarn add @phosphor-icons/webcomponents
or
npm install --save @phosphor-icons/webcomponents
Simply import the icons you need, and add them anywhere in your render method. Phosphor supports tree-shaking, so your bundle only includes code for the icons you use.
import {} from "@phosphor-icons/webcomponents";
<!DOCTYPE html>
<html>
<head>
<script async src="https://unpkg.com/@phosphor-icons/webcomponents"></script>
</head>
<body>
<ph-horse></ph-horse>
<ph-heart color="crimson" weight="fill"></ph-heart>
<ph-cube></ph-cube>
</body>
</html>
Icon components can be styled with the following attributes:
string – Icon stroke/fill color. Can be any CSS color string, including hex, rgb, rgba, hsl, hsla, named colors, or the special currentColor variable.number | string – Icon height & width. This can be a number (defaults to pixels), or a string with units in px, %, em, rem, pt, cm, mm, in."thin" | "light" | "regular" | "bold" | "fill" | "duotone" – Icon weight/style. Can also be used, for example, to "toggle" an icon's state: a rating component could use Stars with weight="regular" to denote an empty star, and weight="fill" to denote a filled star.boolean – Flip the icon horizontally. Can be useful in RTL languages where normal icon orientation is not appropriate.
Components can accept arbitrary SVG elements as children, so long as they are valid children of the <svg> element. This can be used to modify an icon with background layers or shapes, filters, animations and more. The children will be placed below the normal icon contents.
The following will cause the Cube icon to rotate and pulse:
<html>
<head>
<script async src="https://unpkg.com/phosphor-webcomponents"></script>
</head>
<body>
<ph-cube color="darkorchid" weight="duotone">
<animate
attributeName="opacity"
values="0;1;0"
dur="4s"
repeatCount="indefinite"
></animate>
<animateTransform
attributeName="transform"
attributeType="XML"
type="rotate"
dur="5s"
from="0 0 0"
to="360 0 0"
repeatCount="indefinite"
></animateTransform>
</ph-cube>
</body>
</html>
Note: The coordinate space of slotted elements is relative to the contents of the icon
viewBox, which is a 256x256 square. Only valid SVG elements will be rendered.
If you've made a port of Phosphor and you want to see it here, just open a PR here!
If you've made a port of Phosphor and you want to see it here, just open a PR here!
MIT © Phosphor Icons
FAQs
A flexible icon family for the web
The npm package @phosphor-icons/webcomponents receives a total of 699,160 weekly downloads. As such, @phosphor-icons/webcomponents popularity was classified as popular.
We found that @phosphor-icons/webcomponents demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.