tabs component #1557
Open
tabs component #1557
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughA new tabbed interface component has been introduced to the frontend application. The implementation includes a React component ( Changes
Sequence DiagramsequenceDiagram
participant User
participant TabComponent
participant TabItem
User->>TabComponent: Click/Navigate Tab
TabComponent->>TabComponent: Update activeIndex
TabComponent->>TabItem: Trigger onClick handler
TabItem-->>User: Render/Respond
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (2)
frontend/app/element/tabs.stories.tsx (1)
17-31: Consider improving the story implementation.A few suggestions to enhance the story:
- Replace console.log with more meaningful action handlers for demonstration purposes
- Move the styling to a dedicated style file or story decorator instead of inline styles
export const DefaultTabs: Story = { render: () => { const tabs = [ - { label: "Node 1", onClick: () => console.log("Node 1 Clicked") }, - { label: "Node 2", onClick: () => console.log("Node 2 Clicked") }, - { label: "Node 3", onClick: () => console.log("Node 3 Clicked") }, + { label: "Node 1", onClick: () => { /* Add meaningful demo action */ } }, + { label: "Node 2", onClick: () => { /* Add meaningful demo action */ } }, + { label: "Node 3", onClick: () => { /* Add meaningful demo action */ } }, ]; return ( - <div style={{ padding: "20px", backgroundColor: "#000", color: "#fff" }}> + <div className="story-container"> <Tabs tabs={tabs} /> </div> ); }, };frontend/app/element/tabs.tsx (1)
16-18: Consider implementing controlled/uncontrolled pattern.The component could benefit from:
- Supporting both controlled and uncontrolled modes
- Validating the active index
const Tabs: React.FC<TabsProps> = ({ tabs, + activeIndex: controlledIndex, + defaultActiveIndex = 0, + onChange, }) => { - const [activeIndex, setActiveIndex] = useState(0); + const [internalIndex, setInternalIndex] = useState(defaultActiveIndex); + const activeIndex = controlledIndex ?? internalIndex; + + const setActiveIndex = (index: number) => { + if (index < 0 || index >= tabs.length) return; + setInternalIndex(index); + onChange?.(index); + };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
frontend/app/element/tabs.scss(1 hunks)frontend/app/element/tabs.stories.tsx(1 hunks)frontend/app/element/tabs.tsx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- frontend/app/element/tabs.scss
🔇 Additional comments (1)
frontend/app/element/tabs.stories.tsx (1)
1-15: LGTM!
The metadata setup and imports are properly structured.
Comment on lines
+33
to
+47
| export const TabsWithAlerts: Story = { | ||
| render: () => { | ||
| const tabs = [ | ||
| { label: "Node 1", onClick: () => alert("Node 1 Clicked") }, | ||
| { label: "Node 2", onClick: () => alert("Node 2 Clicked") }, | ||
| { label: "Node 3", onClick: () => alert("Node 3 Clicked") }, | ||
| ]; | ||
|
|
||
| return ( | ||
| <div style={{ padding: "20px", backgroundColor: "#000", color: "#fff" }}> | ||
| <Tabs tabs={tabs} /> | ||
| </div> | ||
| ); | ||
| }, | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace alert() with a more user-friendly notification system.
Using alert() is not recommended as it:
- Blocks the UI
- Provides a poor user experience
- Doesn't represent real-world usage
Consider using a toast notification or a more elegant feedback mechanism.
export const TabsWithAlerts: Story = {
render: () => {
const tabs = [
- { label: "Node 1", onClick: () => alert("Node 1 Clicked") },
- { label: "Node 2", onClick: () => alert("Node 2 Clicked") },
- { label: "Node 3", onClick: () => alert("Node 3 Clicked") },
+ {
+ label: "Node 1",
+ onClick: () => {
+ // Use a toast notification or custom feedback component
+ }
+ },
// Similar changes for other tabs
];
return (
- <div style={{ padding: "20px", backgroundColor: "#000", color: "#fff" }}>
+ <div className="story-container">
<Tabs tabs={tabs} />
</div>
);
},
};Committable suggestion skipped: line range outside the PR's diff.
Comment on lines
+7
to
+14
| type Tab = { | ||
| label: string; | ||
| onClick: () => void; | ||
| }; | ||
|
|
||
| type TabsProps = { | ||
| tabs: Tab[]; | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance type definitions for better accessibility and flexibility.
The current type definitions could be improved to support:
- ARIA labels for better accessibility
- Optional IDs for tabs
- Disabled state for tabs
type Tab = {
label: string;
+ id?: string;
+ ariaLabel?: string;
+ disabled?: boolean;
onClick: () => void;
};
type TabsProps = {
tabs: Tab[];
+ ariaLabel?: string;
+ defaultActiveIndex?: number;
};📝 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
| type Tab = { | |
| label: string; | |
| onClick: () => void; | |
| }; | |
| type TabsProps = { | |
| tabs: Tab[]; | |
| }; | |
| type Tab = { | |
| label: string; | |
| id?: string; | |
| ariaLabel?: string; | |
| disabled?: boolean; | |
| onClick: () => void; | |
| }; | |
| type TabsProps = { | |
| tabs: Tab[]; | |
| ariaLabel?: string; | |
| defaultActiveIndex?: number; | |
| }; |
Comment on lines
+31
to
+53
| return ( | ||
| <div className="tabs-container"> | ||
| <div className="tabs-list" role="tablist"> | ||
| {tabs.map((tab, index) => ( | ||
| <div | ||
| key={index} | ||
| role="tab" | ||
| tabIndex={activeIndex === index ? 0 : -1} | ||
| aria-selected={activeIndex === index} | ||
| className={`tab-item ${activeIndex === index ? "active" : ""}`} | ||
| onClick={() => { | ||
| tab.onClick(); | ||
| setActiveIndex(index); | ||
| }} | ||
| onKeyDown={(e) => handleKeyDown(e, index)} | ||
| > | ||
| {tab.label} | ||
| </div> | ||
| ))} | ||
| </div> | ||
| </div> | ||
| ); | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance accessibility and semantic markup.
The render method should:
- Use
<button>elements for better semantics - Add additional ARIA attributes
- Support disabled state styling
return (
- <div className="tabs-container">
+ <div
+ className="tabs-container"
+ aria-label={ariaLabel}
+ >
<div className="tabs-list" role="tablist">
{tabs.map((tab, index) => (
- <div
+ <button
key={index}
+ id={tab.id}
role="tab"
tabIndex={activeIndex === index ? 0 : -1}
aria-selected={activeIndex === index}
+ aria-label={tab.ariaLabel}
+ aria-controls={`${tab.id}-panel`}
+ disabled={tab.disabled}
className={`tab-item ${
activeIndex === index ? "active" : ""
+ tab.disabled ? "disabled" : ""
}`}
onClick={() => {
+ if (tab.disabled) return;
tab.onClick();
setActiveIndex(index);
}}
onKeyDown={(e) => handleKeyDown(e, index)}
>
{tab.label}
- </div>
+ </button>
))}
</div>
</div>
);Committable suggestion skipped: line range outside the PR's diff.
Comment on lines
+19
to
+29
| const handleKeyDown = (event: React.KeyboardEvent<HTMLDivElement>, index: number) => { | ||
| if (event.key === "ArrowRight") { | ||
| setActiveIndex((prevIndex) => (prevIndex + 1) % tabs.length); | ||
| } else if (event.key === "ArrowLeft") { | ||
| setActiveIndex((prevIndex) => (prevIndex - 1 + tabs.length) % tabs.length); | ||
| } else if (event.key === "Enter" || event.key === " ") { | ||
| event.preventDefault(); | ||
| tabs[index].onClick(); | ||
| setActiveIndex(index); | ||
| } | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance keyboard navigation support.
The keyboard handler should:
- Support Home/End keys for first/last tab navigation
- Prevent default on arrow keys to avoid page scrolling
- Skip disabled tabs if implemented
const handleKeyDown = (event: React.KeyboardEvent<HTMLDivElement>, index: number) => {
+ const { key } = event;
+ let newIndex = index;
- if (event.key === "ArrowRight") {
+ if (key === "ArrowRight" || key === "ArrowLeft") {
event.preventDefault();
- setActiveIndex((prevIndex) => (prevIndex + 1) % tabs.length);
+ newIndex = key === "ArrowRight"
+ ? (index + 1) % tabs.length
+ : (index - 1 + tabs.length) % tabs.length;
- } else if (event.key === "ArrowLeft") {
- setActiveIndex((prevIndex) => (prevIndex - 1 + tabs.length) % tabs.length);
- } else if (event.key === "Enter" || event.key === " ") {
+ } else if (key === "Home" || key === "End") {
+ event.preventDefault();
+ newIndex = key === "Home" ? 0 : tabs.length - 1;
+ } else if (key === "Enter" || key === " ") {
event.preventDefault();
- tabs[index].onClick();
- setActiveIndex(index);
+ if (!tabs[index].disabled) {
+ tabs[index].onClick();
+ setActiveIndex(index);
+ }
+ return;
}
+
+ // Find next non-disabled tab
+ while (tabs[newIndex]?.disabled) {
+ newIndex = key === "ArrowRight" || key === "Home"
+ ? (newIndex + 1) % tabs.length
+ : (newIndex - 1 + tabs.length) % tabs.length;
+ }
+
+ setActiveIndex(newIndex);
};Committable suggestion skipped: line range outside the PR's diff.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Tabscomponent in Storybook:DefaultTabsandTabsWithAlerts.Style
Documentation
Tabscomponent and its variations.