Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@patternfly/react-icons
Advanced tools
Readme
PatternFly Icons as React Components.
import TimesIcon from '@patternfly/react-icons/dist/esm/icons/times-icon';
const closeIcon = <TimesIcon />;
For a list of the available icons please refer to the PatternFly react docs
All icons from @patternfly/react-icons have the HTML class pf-v5-svg applied and CSS styles applied via @patternfly/react-styles.
If not using @patternfly/react-icons in conjunction with @patternfly/react-styles, then the following generic styles will need to be applied to the icons: height="1em", style="vertical-align: -0.125em;" width="1em"
If using @patternfly/react-icons in conjunction with @patternfly/react-core, icons can be further styled by wrapping an icon from @patternfly/react-icons in a PatternFly icon component.
Icons for this package are generated from the @fortawesome/free-solid-svg-icons
package. To add more to what is generated, modify the icons.js file in the build folder.
If you have some custom icon defined by svg path the best way to add such icon to this repository is to add its path definition in pfIcons.js file in the build folder.
module.exports = {
pfIcons: {
// ... other icon defintions
bigPlus: {width: 1024, height: 1024, svgPathData: 'M2 1 h1 v1 h1 v1 h-1 v1 h-1 v-1 h-1 v-1 h1 z'}
}
}
Ensure optimization.sideEffects is set to true within your Webpack config:
optimization: {
sideEffects: true
}
Use ESM module imports to enable tree shaking with no additional setup required.
import TimesIcon from '@patternfly/react-icons/dist/esm/icons/times-icon';
To enable tree shaking with named imports for CJS modules, utilize babel-plugin-transform-imports and update a babel.config.js file to utilize the plugin:
module.exports = {
presets: ["@babel/preset-env", "@babel/preset-react"],
plugins: [
[
"transform-imports",
{
"@patternfly/react-icons": {
transform: (importName, matches) => `@patternfly/react-icons/dist/js/icons/${importName.split(/(?=[A-Z])/).join('-').toLowerCase()}`,
preventFullImport: true
}
}
]
]
}
FAQs
PatternFly 4 Icons as React Components
The npm package @patternfly/react-icons receives a total of 34,393 weekly downloads. As such, @patternfly/react-icons popularity was classified as popular.
We found that @patternfly/react-icons demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 15 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.