Skip to content

chore: add helper for react-icons #8147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcoker merged 6 commits into from
Feb 18, 2026
Merged

chore: add helper for react-icons #8147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
65cc0f7
chore: add helper for react-icons
mcoker Feb 17, 2026
90f98dc
chore: coderabbit path traversal
mcoker Feb 17, 2026
787e55b
chore: dynamically read package dir
mcoker Feb 17, 2026
a7caabf
chore: indentation
mcoker Feb 17, 2026
336927b
chore: indentation
mcoker Feb 17, 2026
face56c
chore: codewabbit iconName in SafeString change
mcoker Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions scripts/helpers.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { patternflyNamespace, patternflyVersion } from './init.mjs';
import fs from 'fs';
import path from 'path';
import Handlebars from 'handlebars';
import { createRequire } from 'module';

// TODO: TODO: update ternary to not escape chars

Expand Down Expand Up @@ -359,3 +363,32 @@ export const pfv = (type) => {
export const prefix = function (term) {
return pfv('c') + term;
}

// ======================================================================================
// pfIcon: a helper function to use svg's from @patternfly/react-icons
// ======================================================================================
//
// Usage:
// {{pfIcon 'arrow-right'}}
//
// ======================================================================================
export const pfIcon = function (iconName) {
try {
if (!iconName || typeof iconName !== 'string') {
console.error(`\x1b[31mInvalid icon name: ${iconName}\x1b[0m`);
return new Handlebars.SafeString(`<!-- Invalid icon name -->`);
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
const baseName = path.basename(iconName);
const require = createRequire(import.meta.url);

@coderabbitai coderabbitai Bot Feb 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick | 🔵 Trivial

Consider hoisting createRequire outside the function to avoid repeated calls.

createRequire(import.meta.url) is called on every pfIcon invocation. Since import.meta.url is constant for the module, the require function can be created once at module scope.

♻️ Proposed refactor

At the top of the file (after the existing imports):

 import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);

Inside pfIcon:

     const baseName = path.basename(iconName);
-    const require = createRequire(import.meta.url);
     const packageJsonPath = require.resolve('@patternfly/react-icons/package.json');
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const require = createRequire(import.meta.url);
const baseName = path.basename(iconName);
const packageJsonPath = require.resolve('@patternfly/react-icons/package.json');
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@scripts/helpers.mjs` at line 382, Hoist the createRequire(import.meta.url)
call to module scope and reuse its result instead of calling it inside pfIcon:
create a top-level const require = createRequire(import.meta.url) (near the
other imports), then remove the local declaration of require inside the pfIcon
function so pfIcon uses the module-scoped require; this avoids repeated
createRequire invocations while preserving behavior.

const packageJsonPath = require.resolve('@patternfly/react-icons/package.json');
const packageDir = path.dirname(packageJsonPath);
const iconDir = path.join(packageDir, 'dist/static');
const iconPath = path.join(iconDir, `${baseName}.svg`);
const svgContent = fs.readFileSync(iconPath, 'utf8');
return new Handlebars.SafeString(svgContent);
} catch (error) {
const safeName = (iconName && typeof iconName === 'string') ? path.basename(iconName) : 'unknown';
console.error(`\x1b[31mError loading icon "${safeName}": ${error.message}\x1b[0m`);
return new Handlebars.SafeString(`<!-- Icon "${safeName}" not found -->`);
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
103 changes: 3 additions & 100 deletions src/patternfly/demos/Compass/compass--card-view.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,84 +1,7 @@
{{#> compass--demo-context}}
{{#> compass}}
{{#> compass-header}}
{{#> compass-logo}}
{{> compass--icons compass--icons--redhat=true}}
{{/compass-logo}}
{{#> compass-nav}}
{{#> compass-panel compass-panel--HasNoPadding=false compass-panel--IsPill=true}}
{{#> compass-nav-content}}
{{#> compass-nav-home}}
{{#> button button--IsPlain=true button--aria-label="Home" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--home=true}}
{{/button}}
{{/compass-nav-home}}
{{#> compass-nav-main}}
{{#> tabs tabs--id="primary-nav" tabs--type="nav" tabs--IsNav=true tabs--aria-label="Compass primary" tabs-link--isLink="true"}}
{{> __tabs-list}}
{{/tabs}}
{{/compass-nav-main}}
{{#> compass-nav-search}}
{{#> button button--IsPlain=true button--aria-label="Search" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--search=true}}
{{/button}}
{{/compass-nav-search}}
{{/compass-nav-content}}
{{/compass-panel}}
{{#> compass-panel compass-panel--HasNoPadding=false compass-panel--IsPill=true}}
{{#> compass-nav-content}}
{{#> compass-nav-main}}
{{#> tabs tabs--id="secondary-nav" tabs--type="nav" tabs--IsNav=true tabs--aria-label="Compass secondary" tabs-link--isLink="true" tabs--modifier="pf-m-subtab"}}
{{> __tabs-list-secondary __tabs-list--IsDisabled="true"}}
{{/tabs}}
{{/compass-nav-main}}
{{/compass-nav-content}}
{{/compass-panel}}
{{/compass-nav}}
{{#> compass-profile}}
{{#> menu-toggle menu-toggle--IsPlain=true menu-toggle--IsText=true menu-toggle--IsCircle=true}}
{{#> menu-toggle-icon}}
{{> avatar avatar--modifier="pf-m-md"}}
{{/menu-toggle-icon}}
{{#> menu-toggle-text}}
Ned Username
{{/menu-toggle-text}}
{{#> menu-toggle-controls}}
{{> menu-toggle-toggle-icon}}
{{/menu-toggle-controls}}
{{/menu-toggle}}
{{/compass-profile}}
{{/compass-header}}
{{#> compass-sidebar compass-sidebar--IsStart=true}}
{{#> compass-panel compass-panel--IsPill=true}}
{{#> action-list action-list--modifier="pf-m-icons" action-list--IsVertical=true}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Add" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--square-plus=true}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Help" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--question-circle=true}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--modifier=(concat (pfv "unset-prefix") "m-ai-indicator") button--IsPlain=true button--aria-label="AI assistant" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--sparkle=true}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="User profile" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--user=true}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Send" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--paper-plane=true}}
{{/button}}
{{/action-list-item}}
{{/action-list}}
{{/compass-panel}}
{{/compass-sidebar}}
{{> compass--header}}
{{> compass--sidebar--start}}
{{#> compass-main}}
{{#> compass-main-header}}
{{#> compass-panel}}
Expand Down Expand Up @@ -129,26 +52,6 @@
{{/compass-message-bar}}
{{/compass-main-footer}}
{{/compass-main}}
{{#> compass-sidebar compass-sidebar--IsEnd=true}}
{{#> compass-panel compass-panel--IsPill=true}}
{{#> action-list action-list--modifier="pf-m-icons" action-list--IsVertical=true}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Help" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--question-circle=true}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="User profile" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--user=true}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Send" button--IsCircle=true button--IsIcon=true}}
{{> compass--icons compass--icons--paper-plane=true}}
{{/button}}
{{/action-list-item}}
{{/action-list}}
{{/compass-panel}}
{{/compass-sidebar}}
{{> compass--sidebar--end}}
{{/compass}}
{{/compass--demo-context}}
48 changes: 48 additions & 0 deletions src/patternfly/demos/Compass/compass--header.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{{#> compass-header}}
{{#> compass-logo}}
{{> compass--icons compass--icons--redhat=true}}
{{/compass-logo}}
{{#> compass-nav}}
{{#> compass-panel compass-panel--HasNoPadding=false compass-panel--IsPill=true}}
{{#> compass-nav-content}}
{{#> compass-nav-home}}
{{#> button button--IsPlain=true button--aria-label="Home" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-home"}}
{{/button}}
{{/compass-nav-home}}
{{#> compass-nav-main}}
{{#> tabs tabs--id="primary-nav" tabs--type="nav" tabs--IsNav=true tabs--aria-label="Compass primary" tabs-link--isLink="true"}}
{{> __tabs-list}}
{{/tabs}}
{{/compass-nav-main}}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
{{#> compass-nav-search}}
{{#> button button--IsPlain=true button--aria-label="Search" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-search"}}
{{/button}}
{{/compass-nav-search}}
{{/compass-nav-content}}
{{/compass-panel}}
{{#> compass-panel compass-panel--HasNoPadding=false compass-panel--IsPill=true}}
{{#> compass-nav-content}}
{{#> compass-nav-main}}
{{#> tabs tabs--id="secondary-nav" tabs--type="nav" tabs--IsNav=true tabs--aria-label="Compass secondary" tabs-link--isLink="true" tabs--modifier="pf-m-subtab"}}
{{> __tabs-list-secondary __tabs-list--IsDisabled="true"}}
{{/tabs}}
{{/compass-nav-main}}
{{/compass-nav-content}}
{{/compass-panel}}
{{/compass-nav}}
{{#> compass-profile}}
{{#> menu-toggle menu-toggle--IsPlain=true menu-toggle--IsText=true menu-toggle--IsCircle=true}}
{{#> menu-toggle-icon}}
{{> avatar avatar--modifier="pf-m-md"}}
{{/menu-toggle-icon}}
{{#> menu-toggle-text}}
Ned Username
{{/menu-toggle-text}}
{{#> menu-toggle-controls}}
{{> menu-toggle-toggle-icon}}
{{/menu-toggle-controls}}
{{/menu-toggle}}
{{/compass-profile}}
{{/compass-header}}
31 changes: 31 additions & 0 deletions src/patternfly/demos/Compass/compass--sidebar--end.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{{#> compass-sidebar compass-sidebar--IsEnd=true}}
{{#> compass-panel compass-panel--IsPill=true}}
{{#> action-list action-list--modifier="pf-m-icons" action-list--IsVertical=true}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Notifications" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-notification"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="List" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-list"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Zap" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-electricity"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Download" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-download"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Help" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-question-mark-circle"}}
{{/button}}
{{/action-list-item}}
{{/action-list}}
{{/compass-panel}}
{{/compass-sidebar}}
31 changes: 31 additions & 0 deletions src/patternfly/demos/Compass/compass--sidebar--start.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{{#> compass-sidebar compass-sidebar--IsStart=true}}
{{#> compass-panel compass-panel--IsPill=true}}
{{#> action-list action-list--modifier="pf-m-icons" action-list--IsVertical=true}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Add" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-add-square"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Collections" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-collection"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--modifier=(concat (pfv "unset-prefix") "m-ai-indicator") button--IsPlain=true button--aria-label="AI assistant" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-ai-experience-fill"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Volume" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-volume-up"}}
{{/button}}
{{/action-list-item}}
{{#> action-list-item}}
{{#> button button--IsPlain=true button--aria-label="Use microphone" button--IsCircle=true button--IsIcon=true}}
{{pfIcon "rh-ui-microphone"}}
{{/button}}
{{/action-list-item}}
{{/action-list}}
{{/compass-panel}}
{{/compass-sidebar}}
Loading