feat(bulk-import): add configurable instructions section for bulk import #1989
Conversation
lokanandaprabhu
requested review from
a team,
debsmita1,
its-mitesh-kumar and
rm3l
as code owners
|
Important This PR includes changes that affect public-facing API. Please ensure you are adding/updating documentation for new features or behavior. Changed Packages
|
HusneShabbir
left a comment
HusneShabbir
left a comment
There was a problem hiding this comment.
works as expected
/lgtm
debsmita1
left a comment
debsmita1
left a comment
There was a problem hiding this comment.
Tested this locally
bulkImport:
instructionsEnabled: true
instructionsDefaultExpanded: true
instructionsSteps:
- id: 'step1'
text: 'Choose your source control platform'
icon:
type: 'builtin'
source: 'approval-tool' # icon name or URL
- id: 'step2'
text: 'Step 2'
icon:
type: 'url'
source: 'https://unpkg.com/[email protected]/24/outline/chat-bubble-left-right.svg' # icon name or URL
| * Icon configuration | ||
| * @visibility frontend | ||
| */ | ||
| icon?: { |
There was a problem hiding this comment.
As of today, we have a way to configure icons https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/global-floating-action-button/plugins/global-floating-action-button/src/components/FabIcon.tsx . Could you check if you could use the same logic ? then, it will allow users to use svg and backstage icons as well
.../bulk-import/plugins/bulk-import/src/components/AddRepositories/ConfigurableInstructions.tsx
Outdated
Show resolved
Hide resolved
.../bulk-import/plugins/bulk-import/src/components/AddRepositories/ConfigurableInstructions.tsx
Outdated
Show resolved
Hide resolved
lokanandaprabhu
force-pushed
the
feature/configurable-instructions-section
branch
from
b630b73 to
055d47a
Compare
|
3 participants
Hey, I just made a Pull Request!
This PR introduces a fully configurable "How does it work" instructions section for the Bulk Import plugin, allowing administrators to customize workflow steps through app-config.yaml configuration.
Key Features:
Configurable Steps: Define custom workflow steps with personalized text and icons
Icon Support: Built-in theme-aware icons + custom URL-based icons
Dynamic Layout: Responsive design with horizontal scrolling for many steps (≤6 steps fill width, >6 enable scrolling)
User Preferences: Collapsed/expanded state persisted in localStorage per user
Screenshots
------When 3 steps are configured----
------When 5 steps are configured----
------When 6 steps are configured----
------When icon is not configured----
-------When no steps are configured
-----Save user preference
Screen.Recording.2025-12-31.at.11.52.39.AM.mov
✔️ Checklist