@amafjarkasi/hd-eui-core
v1.0.1
Published
๐ HD-EUI Core: An elite-tier, TypeScript-native React component library engineered for high-stakes enterprise environments. Built on the principles of Hyper-Density, Structured Boundaries, and Micro-Typography, it provides a data-rich experience inspired
Downloads
211
Maintainers
Readme
๐ HD-EUI Core: The High-Density Enterprise UI Framework
HD-EUI Core is an elite-tier, TypeScript-native React component library engineered for high-stakes enterprise environments. While modern design trends favor excessive whitespace, HD-EUI Core is built for the Power Userโproviding a hyper-dense, data-rich experience inspired by the Zendesk Compact Utilitarian design system.
Explore the Interactive Documentation (Storybook) โ
๐ The Philosophy of Hyper-Density
In complex B2B applications, admin panels, and real-time monitoring systems, "white space" is often wasted space. HD-EUI Core optimizes every pixel to maximize information throughput without compromising cognitive clarity.
The Three Pillars:
- Hyper-Density: Standardized micro-spacing (
2px-4pxgaps) and tight padding (p-1) to maximize screen real estate. - Structured Boundaries: Hard
1pxborders (#d8dcde) replace soft shadows, providing immediate visual sectioning for complex data sets. - Micro-Typography: A precision-tuned typographic scale (
8pxto11px) designed for readability at small sizes.
โจ Key Features
- ๐ 33+ Production-Ready Components: A comprehensive suite covering Layout, Forms, Data Display, and Navigation.
- ๐จ Tailwind CSS Native: Fully integrated with Tailwind's utility-first engine for zero-overhead styling.
- ๐ก๏ธ Strict TypeScript Excellence: 100% type-safe with exported interfaces for every component, prop, and event handler.
- โฟ Enterprise Accessibility: Built-in ARIA support, keyboard navigation, and high-contrast focus states.
- ๐ฆ Ultra-Lightweight: ~20KB gzipped bundle size with full tree-shaking support.
- ๐ Professional Monochrome Palette: A sophisticated slate-and-azure palette designed for long-duration focus.
๐จ Design System Specifications
Color Palette (Strict Hex Codes)
| Token | Hex | Usage |
| :--- | :--- | :--- |
| Primary Text/Actions | #2f3941 | Main text, primary buttons, active states. |
| Hover State | #1f252a | Hover backgrounds for primary actions. |
| Borders/Dividers | #d8dcde | Hard 1px borders for sectioning. |
| Brand/Focus/Active | #1f73b7 | Focus rings, links, brand accents. |
| Muted/Secondary | #87929d | Secondary text, disabled states, icons. |
| Background (Light) | #ffffff | Main workspace background. |
| Background (Dark) | #f8f9fa | Sidebar and header backgrounds. |
Typographic Scale
| Level | Size | Weight | Line Height |
| :--- | :--- | :--- | :--- |
| Header | 11px | Bold (700) | 1.2 |
| Body | 10px | Regular (400) | 1.3 |
| Muted | 9px | Regular (400) | 1.2 |
| Micro | 8px | Regular (400) | 1.1 |
| Mono | 10px | Monospace | 1.2 |
Spacing System
| Token | Value | Usage |
| :--- | :--- | :--- |
| Micro | 1px | Hairline separators. |
| Tight | 2px | Internal component padding. |
| Ultra | 4px | Gaps between related elements. |
| Normal | 8px | Section padding. |
๐ฆ Installation
npm install @amafjarkasi/hd-eui-corePeer Dependencies
Ensure your project has the following installed:
npm install react react-dom tailwindcss lucide-react clsx๐ ๏ธ Configuration
To unlock the full power of the HD-EUI design system, update your tailwind.config.js:
/** @type {import('tailwindcss').Config} */
module.exports = {
content: [
"./src/**/*.{js,ts,jsx,tsx}",
"./node_modules/@amafjarkasi/hd-eui-core/dist/**/*.{js,ts,jsx,tsx}",
],
theme: {
extend: {
colors: {
hd: {
primary: "#2f3941",
"primary-hover": "#1f252a",
border: "#d8dcde",
focus: "#1f73b7",
muted: "#87929d",
"bg-light": "#ffffff",
"bg-dark": "#f8f9fa",
},
},
fontSize: {
header: ["11px", { lineHeight: "1.2", fontWeight: "700" }],
body: ["10px", { lineHeight: "1.3" }],
muted: ["9px", { lineHeight: "1.2" }],
micro: ["8px", { lineHeight: "1.1" }],
mono: ["10px", { fontFamily: "monospace", lineHeight: "1.2" }],
},
spacing: {
tight: "2px",
ultra: "4px",
micro: "1px",
},
},
},
plugins: [],
};๐ Quick Start
1. Basic Component Usage
import { Button, Card, Badge } from '@amafjarkasi/hd-eui-core';
const App = () => (
<Card title="System Status" footer="v1.0.4">
<div className="flex items-center gap-ultra">
<Badge variant="success">Online</Badge>
<span className="text-body text-hd-primary">Core Engine Active</span>
</div>
<Button variant="primary" size="sm" className="mt-2">Reboot</Button>
</Card>
);2. Data-Dense Table with Sorting
import { Table, Badge } from '@amafjarkasi/hd-eui-core';
const columns = [
{ key: 'id', header: 'ID', width: '60px' },
{ key: 'user', header: 'User', sortable: true },
{ key: 'role', header: 'Role', render: (val) => <Badge>{val}</Badge> }
];
const data = [
{ id: '001', user: 'Amaf J.', role: 'Admin' },
{ id: '002', user: 'John D.', role: 'Editor' }
];
<Table
data={data}
columns={columns}
striped
onSort={(key, dir) => console.log(`Sorting ${key} by ${dir}`)}
/>๐ Component Catalog
| Category | Components | Description |
| :--- | :--- | :--- |
| Layout | Card, CardGrid, Modal, Sidebar, Accordion, Tabs | Structural components for organizing complex views. |
| Form | Button, Input, Form, Select, Checkbox, Radio, Slider, Dropdown | High-density input controls with validation support. |
| Data Display | Table, Tree, Badge, Avatar, List, CodeEditor, Calendar | Optimized for high-throughput information visualization. |
| Feedback | Alert, AlertDialog, Toast, Notification, Spinner, ProgressBar, Skeleton, Tooltip, Popover | Contextual messaging and loading states. |
| Navigation | Breadcrumb, Pagination, Stepper, Navbar | Compact wayfinding for deep application hierarchies. |
๐จ Theming & Customization
HD-EUI Core is built on design tokens. You can import these tokens directly into your own custom components to maintain visual consistency across your entire application:
import { colors, spacing, fontSize } from '@amafjarkasi/hd-eui-core';
const CustomPanel = () => (
<div style={{
backgroundColor: colors["bg-dark"],
padding: spacing.tight,
border: `1px solid ${colors.border}`
}}>
<h1 style={{ fontSize: fontSize.header }}>Custom Header</h1>
<p style={{ fontSize: fontSize.body }}>Integrated with HD-EUI tokens.</p>
</div>
);๐งช Development Workflow
If you wish to contribute or modify the library:
# Clone the repository
git clone https://github.com/amafjarkasi/hd-eui-core.git
# Install dependencies
npm install
# Start Storybook for interactive development
npm run storybook
# Build the library for production
npm run build
# Run unit tests with Jest
npm test๐ค Contributing
We are building the future of high-density UI. We welcome all contributions!
- Fork the repository.
- Create a feature branch (
git checkout -b feature/amazing-component). - Commit your changes (
git commit -m 'Add some amazing component'). - Push to the branch (
git push origin feature/amazing-component). - Open a Pull Request.
Please see CONTRIBUTING.md for more details.
๐ License
Distributed under the MIT License. See LICENSE for more information.
๐ง Support & Community
- Issues: GitHub Issue Tracker
- Discussions: GitHub Discussions
- Security: See SECURITY.md for reporting vulnerabilities.
Built with โค๏ธ by amafjarkasi. If you find this library useful, please give it a โญ on GitHub!
