Gathering detailed insights and metrics for phosphor-react
Installations
npm install phosphor-reactDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=10
Score
98.2
Supply Chain
100
Quality
76
Maintenance
100
Vulnerability
100
License
Releases
13
Contributors
14
Unable to fetch Contributors
Languages
4
TypeScript
JavaScript
HTML
CSS
TypeScript (99.97%)
JavaScript (0.02%)
Developer
Download Statistics
Total Downloads
8,373,927
Last Day
7,911
Last Week
33,916
Last Month
149,761
Last Year
2,354,007
GitHub Statistics
1,229 Stars
217 Commits
60 Forks
9 Watching
5 Branches
14 Contributors
Bundle Size
3.96 MB
Minified
323.34 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.4.1
Package Id
phosphor-react@1.4.1
Unpacked Size
48.46 MB
Size
2.64 MB
File Count
4,221
Total Downloads
Cumulative downloads
Total Downloads
8,373,927
Last day
7.3%
7,911
Compared to previous day
Last week
-12%
33,916
Compared to previous week
Last month
-8.7%
149,761
Compared to previous month
Last year
-0.4%
2,354,007
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Versions
phosphor-react
Phosphor is a flexible icon family for interfaces, diagrams, presentations — whatever, really. Explore all our icons at phosphoricons.com.
Installation
1yarn add phosphor-react
or
1npm install --save phosphor-react
Usage
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.
1import React from "react"; 2import ReactDOM from "react-dom"; 3import { Horse, Heart, Cube } from "phosphor-react"; 4 5const App = () => { 6 return ( 7 <div> 8 <Horse /> 9 <Heart color="#AE2983" weight="fill" size={32} /> 10 <Cube color="teal" weight="duotone" /> 11 </div> 12 ); 13}; 14 15ReactDOM.render(<App />, document.getElementById("root"));
Props
Icon components accept all props that you can pass to a normal SVG element, including inline style objects, onClick handlers, and more. The main way of styling them will usually be with the following props:
- color?:
string– Icon stroke/fill color. Can be any CSS color string, includinghex,rgb,rgba,hsl,hsla, named colors, or the specialcurrentColorvariable. - size?:
number | string– Icon height & width. As with standard React elements, this can be a number, or a string with units inpx,%,em,rem,pt,cm,mm,in. - weight?:
"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 withweight="regular"to denote an empty star, andweight="fill"to denote a filled star. - mirrored?:
boolean– Flip the icon horizontally. Can be useful in RTL languages where normal icon orientation is not appropriate. - alt?:
string– Add accessible alt text to an icon.
Context
Phosphor takes advantage of React Context to make applying a default style to all icons simple. Create an IconContext.Provider at the root of the app (or anywhere above the icons in the tree) and pass in a configuration object with props to be applied by default to all icons:
1import React from "react"; 2import ReactDOM from "react-dom"; 3import { IconContext, Horse, Heart, Cube } from "phosphor-react"; 4 5const App = () => { 6 return ( 7 <IconContext.Provider 8 value={{ 9 color: "limegreen", 10 size: 32, 11 weight: "bold", 12 mirrored: false, 13 }} 14 > 15 <div> 16 <Horse /> {/* I'm lime-green, 32px, and bold! */} 17 <Heart /> {/* Me too! */} 18 <Cube /> {/* Me three :) */} 19 </div> 20 </IconContext.Provider> 21 ); 22}; 23 24ReactDOM.render(<App />, document.getElementById("root"));
You may create multiple Contexts for styling icons differently in separate regions of an application; icons use the nearest Context above them to determine their style.
Note: The context will also pass any provided SVG props down to icon instances, which can be useful E.G. in adding accessible
aria-labels,classNames, etc.
Composability
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:
1const RotatingCube = () => { 2 return ( 3 <Cube color="darkorchid" weight="duotone"> 4 <animate 5 attributeName="opacity" 6 values="0;1;0" 7 dur="4s" 8 repeatCount="indefinite" 9 ></animate> 10 <animateTransform 11 attributeName="transform" 12 attributeType="XML" 13 type="rotate" 14 dur="5s" 15 from="0 0 0" 16 to="360 0 0" 17 repeatCount="indefinite" 18 ></animateTransform> 19 </Cube> 20 ); 21};
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.
Imports
You may wish to import all icons at once for use in your project, though depending on your bundler this could prevent tree-shaking and make your app's bundle larger.
1import * as Icon from "phosphor-react"; 2... 3<Icon.Smiley /> 4<Icon.Folder weight="thin" /> 5<Icon.BatteryHalf size="24px" />
Our Related Projects
- phosphor-home ▲ Phosphor homepage and general info
- phosphor-vue ▲ Phosphor icon component library for Vue
- phosphor-icons ▲ Phosphor icons for Vanilla JS
- phosphor-flutter ▲ Phosphor IconData library for Flutter
- phosphor-webcomponents ▲ Phosphor icons as Web Components
- phosphor-figma ▲ Phosphor icons Figma plugin
- phosphor-sketch ▲ Phosphor icons Sketch plugin
Community Projects
- phosphor-react-native ▲ Phosphor icon component library for React Native
- phosphor-svelte ▲ Phosphor icons for Svelte apps
- phosphor-r ▲ Phosphor icon wrapper for R documents and applications
- blade-phosphor-icons ▲ Phosphor icons in your Laravel Blade views
If you've made a port of Phosphor and you want to see it here, just open a PR here!
License
MIT © Phosphor Icons
No vulnerabilities found.
No security vulnerabilities found.