Toggle
Use Toggle to build consistent, accessible interfaces aligned with the shared design system.
Installation
1. Copy the source code:
- Source in this monorepo:
packages/ui/src/components/toggle.tsx - Place in your project:
components/ui/toggle.tsx - Required utility:
lib/utils.ts(forcnhelper)
2. Update the import paths to match your project structure.
Usage
import { Toggle } from "@hoag/ui/components/toggle";
export default function Demo() {
return <Toggle aria-label="Toggle italic">Italic</Toggle>;
}Import
import { Toggle, toggleVariants } from "@hoag/ui/components/toggle";Basic Example
import { Toggle } from "@hoag/ui/components/toggle";
export function ToggleBasicExample() {
return <Toggle aria-label="Toggle italic">Italic</Toggle>;
}Composition Pattern
import { Toggle } from "@hoag/ui/components/toggle";
export function ToggleSection() {
return (
<div className="flex items-center gap-2">
<Toggle aria-label="Toggle bold">Bold</Toggle>
<Toggle aria-label="Toggle italic">Italic</Toggle>
</div>
);
}Accessibility Checklist
- Verify semantic roles and ARIA attributes for interactive behavior.
- Keep keyboard navigation and focus visibility consistent in all states.
- Ensure color contrast meets accessibility requirements in light and dark themes.
- Provide screen reader context for dynamic state or content changes.
Testing Checklist
- Add render tests for default and key variant states.
- Add interaction tests for callbacks and state transitions.
- Add visual regression checks for responsive and theme variations.
- Cover edge states such as loading, empty, disabled, and error.
Production Tips
- Wrap component logic in feature-level abstractions for domain behavior.
- Keep visual variants centralized to avoid style drift across screens.
- Reuse a single import path strategy for simpler refactors.
- Mirror documented states in Storybook and QA checklists.
Named Exports
ToggletoggleVariants
API Reference
For authoritative prop signatures and implementation details, inspect:
packages/ui/src/components/toggle.tsx