Sidebar
A calm navigation rail for sections, workspaces, and active state.
Live preview
Adjust a setting to update the preview and usage code together.
Usage & source
"use client";
import type { CSSProperties } from "react";
import { Sidebar } from "./components/stepkit/Sidebar";
import "./components/stepkit/styles.css";
const themeStyle = {"--stepkit-bg":"#f7f7f8","--stepkit-surface":"#ffffff","--stepkit-surface-muted":"#f0f0f3","--stepkit-fg":"#17181c","--stepkit-muted":"#626572","--stepkit-border":"#e3e4e9","--stepkit-border-strong":"#c8cad3","--stepkit-code":"#f1f1f4","--stepkit-shadow":"0 20px 60px rgba(31, 26, 64, .10)","--stepkit-accent":"#6950df","--stepkit-accent-strong":"#5137c7","--stepkit-accent-soft":"#eeeafd","--stepkit-accent-on-soft":"#5137c7","--stepkit-accent-text":"#ffffff","--stepkit-error":"#b43145","--stepkit-placeholder":"#626572","--stepkit-radius":"16px","--stepkit-space":"16px","--stepkit-control-height":"44px","--stepkit-font-sans":"Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif"} as CSSProperties;
const items = [{ id: "overview", label: "Overview" }, { id: "components", label: "Components" }];
export default function Example() {
return (
<div className="stepkit-theme" data-stepkit-preset="modern" style={themeStyle}>
<Sidebar
items={items}
title={"Workspace"}
/>
</div>
);
}Dependencies
[email protected] [email protected]
/*
* Stepkit 0.2.0
* Copyright (c) 2026 Vladislav Stepanov
*
* Original Stepkit portions in this release are licensed under the MIT License. Adapted portions identify their upstream licence and copyright in the copied source and in `NOTICE-MAGICUI.md` where applicable.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
"use client";
import { useState, type ReactNode } from "react";
import "./styles.css";
export interface SidebarItem { id: string; label: string; icon?: ReactNode; disabled?: boolean; }
export interface SidebarProps { title?: string; items: SidebarItem[]; activeId?: string; defaultActiveId?: string; onSelect?: (id: string) => void; footer?: ReactNode; className?: string; }
export function Sidebar({ title = "Workspace", items, activeId, defaultActiveId, onSelect, footer, className = "" }: SidebarProps) {
const [uncontrolledSelected, setUncontrolledSelected] = useState(defaultActiveId);
const selected = activeId ?? uncontrolledSelected;
return <aside className={`stepkit stepkit-sidebar${className ? ` ${className}` : ""}`} aria-label={title}>
<div className="stepkit-sidebar__title">{title}</div>
<div className="stepkit-sidebar__items">
{items.map((item) => <button className="stepkit-sidebar__item" key={item.id} type="button" aria-current={item.id === selected ? "page" : undefined} disabled={item.disabled} onClick={() => { if (activeId === undefined) setUncontrolledSelected(item.id); onSelect?.(item.id); }}>{item.icon ? <span aria-hidden="true">{item.icon}</span> : null}<span>{item.label}</span></button>)}
</div>
{footer ? <div className="stepkit-sidebar__footer">{footer}</div> : null}
</aside>;
}
export default Sidebar;
components/Sidebar.tsxcomponents/styles.cssInstall
Use the released registry entry or download the complete archive.
npx [email protected] add https://vstepanov.com/stepkit/r/sidebar.jsonIntegration prompt
Install Stepkit Sidebar 0.2.0 from the registry and preserve the included MIT notice. npx [email protected] add https://vstepanov.com/stepkit/v0.2.0/r/sidebar.json Install the tested runtime dependencies exactly: npm install [email protected] [email protected] Keep the component source, shared styles, NOTICE.md, and provenance files together. Apply the theme tokens on a wrapper rather than passing theme keys as component props. Usage: ```tsx "use client"; import type { CSSProperties } from "react"; import { Sidebar } from "./components/stepkit/Sidebar"; import "./components/stepkit/styles.css"; const themeStyle = {"--stepkit-bg":"#f7f7f8","--stepkit-surface":"#ffffff","--stepkit-surface-muted":"#f0f0f3","--stepkit-fg":"#17181c","--stepkit-muted":"#626572","--stepkit-border":"#e3e4e9","--stepkit-border-strong":"#c8cad3","--stepkit-code":"#f1f1f4","--stepkit-shadow":"0 20px 60px rgba(31, 26, 64, .10)","--stepkit-accent":"#6950df","--stepkit-accent-strong":"#5137c7","--stepkit-accent-soft":"#eeeafd","--stepkit-accent-on-soft":"#5137c7","--stepkit-accent-text":"#ffffff","--stepkit-error":"#b43145","--stepkit-placeholder":"#626572","--stepkit-radius":"16px","--stepkit-space":"16px","--stepkit-control-height":"44px","--stepkit-font-sans":"Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif"} as CSSProperties; const items = [{ id: "overview", label: "Overview" }, { id: "components", label: "Components" }]; export default function Example() { return ( <div className="stepkit-theme" data-stepkit-preset="modern" style={themeStyle}> <Sidebar items={items} title={"Workspace"} /> </div> ); } ``` Selected bounded settings: {"title":"Workspace"}. Selected theme: {"mode":"light","accent":"violet","radius":"soft","density":"comfortable","preset":"modern"}.
Props
| Name | Type | Default | Description |
|---|---|---|---|
items | SidebarItem[] | required | Navigation items. |
activeId | string | undefined | Controlled selected item. |
onSelect | (id: string) => void | undefined | Called after selection. |
Accessibility & limits
- Uses an aside landmark labelled by its title.
- Active navigation is exposed with aria-current.
Limitations
- It does not own route changes.
Provenance
Original source under the MIT licence.
Original Stepkit implementation.
Required notices: NOTICE.md, PROVENANCE-stepkit-sidebar.md
- 2 source files in the release
- Version 0.2.0