@sandurtech/sandui 0.0.1 → 0.0.2

package/README.md

@@ -1,64 +1,102 @@
 # SandUI
 
-SandUI is the SandurTech React component library. This release resets the package for a clean-slate `0.0.1` publish using Vite library mode, TypeScript declaration output, and bundled SCSS.
+<div align="center">
+  <img src="public/SandurTech-Logo-SVG.svg" alt="SandUI Logo" width="120" />
+  <p><strong>A high-performance, accessible React component library and Design System for SandurTech — featuring WAI-ARIA compliance, native dark mode, and TypeScript-first components.</strong></p>
 
-## Installation
+  [![npm version](https://img.shields.io/npm/v/@sandurtech/sandui.svg?style=flat-classic)](https://www.npmjs.com/package/@sandurtech/sandui)
+  [![License](https://img.shields.io/npm/l/@sandurtech/sandui.svg?style=flat-classic)](LICENSE)
+  [![Types](https://img.shields.io/npm/types/@sandurtech/sandui?style=flat-classic)](https://www.typescriptlang.org/)
+  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg?style=flat-classic)](https://github.com/sandurtech/sandui/pulls)
+</div>
+
+---
+
+## ✨ Features
+
+- ♿ **WAI-ARIA Compliant**: Built with accessibility as a first-class citizen.
+- 🌓 **Native Dark Mode**: Seamless theme switching with strictly derived design tokens.
+- ⚡ **Zero Lucide Dependency**: Utilizes Google Material Symbols (Rounded) for a lean bundle.
+- 📘 **TypeScript First**: Full IntelliSense support with comprehensive JSDoc documentation.
+- 🎨 **Modern Aesthetics**: Premium, high-performance UI primitives tailored for SaaS and dashboards.
+- 📱 **Fully Responsive**: Mobile-optimized layouts and documentation.
+
+## 🚀 Quick Start
+
+### Installation
 
 ```bash
 npm install @sandurtech/sandui
 ```
 
-Peer dependencies:
+### Usage
 
-- `react >=18`
-- `react-dom >=18`
-
-## Usage
+1. **Wrap your app** with the `SandThemeProvider` to enable styling and tokens.
+2. **Import the global CSS** file in your entry point (e.g., `main.tsx`).
 
 ```tsx
-import { SandButton, SandCard, SandInputGroup } from '@sandurtech/sandui';
+import React from 'react';
+import { SandThemeProvider, SandButton, SandCard } from '@sandurtech/sandui';
 import '@sandurtech/sandui/style.css';
 
-export function Example() {
+export function App() {
   return (
-    <SandCard header="Launch">
-      <SandInputGroup label="Project name" />
-      <SandButton>Deploy</SandButton>
-    </SandCard>
+    <SandThemeProvider defaultTheme="system">
+      <SandCard header={<h3>Getting Started</h3>}>
+        <p>Start building your next microservice with SandUI primitives.</p>
+        <SandButton variant="primary">
+          Launch Console
+        </SandButton>
+      </SandCard>
+    </SandThemeProvider>
   );
 }
 ```
 
-## Development
+## 🛠 Component Surface
 
-```bash
-npm ci
-npm run test
-npm run build
-```
+SandUI provides a growing set of modular components categorized for efficiency:
 
-## Build Output
+| Category | Primitives |
+| :--- | :--- |
+| **Foundation** | `SandThemeProvider`, `SandBox`, `SandStack`, `SandGrid` |
+| **Typography** | `SandTitle`, `SandText`, `SandCode`, `SandKBD` |
+| **Form Controls** | `SandInput`, `SandInputGroup`, `SandCheckbox`, `SandRadio`, `SandSwitch` |
+| **Data Display** | `SandTable`, `SandTabs`, `SandAccordion`, `SandCard`, `SandBadge` |
+| **Feedback** | `SandAlert`, `SandToast`, `SandSnackbar`, `SandLoader`, `SandProgress` |
+| **Navigation** | `SandNavbar`, `SandDrawer`, `SandBreadcrumbs`, `SandPagination` |
+| **Overlays** | `SandModal`, `SandTooltip`, `SandIcon` |
 
-The package publishes:
+## 📖 Documentation
 
-- ESM bundle: `dist/sandui.js`
-- UMD bundle: `dist/sandui.umd.js`
-- Types: `dist/index.d.ts`
-- Styles: `dist/style.css`
+Explore interactive examples, API references, and design guidelines:
 
-## V2 Migration
+👉 [**View Live Documentation**](https://sandurtech.github.io/SandUI/)
 
-The previous SandUI package line published `0.1.x` APIs before this reset. The new `0.0.1` line keeps the scoped package name but treats the component surface as a clean restart.
+## 🧪 Development
 
-Breaking changes discovered while comparing to the earlier package setup:
+Contributions are welcome! To get started locally:
 
-- Unprefixed exports such as `Button`, `Card`, and `ButtonProps` were replaced by `SandButton`, `SandCard`, and `SandButtonProps`.
-- The public barrel is now explicit and only exposes `Sand*` components and `Sand*` types from the root package entry.
-- The build output changed from app/docs-oriented assets to library artifacts plus a single bundled stylesheet.
-- React and React DOM are now peer dependencies instead of bundled runtime dependencies.
+```bash
+# Install dependencies
+npm install
 
-If you need to mark the old package line as deprecated, use:
+# Start documentation app with Hot Module Replacement (HMR)
+npm run dev
 
-```bash
-npm deprecate @sandurtech/sandui@0.1.0 "This version is deprecated. Please use 0.0.1 or higher."
+# Run unit tests with Vitest
+npm run test
+
+# Build production library artifacts
+npm run build
 ```
+
+## 📄 License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+---
+
+<div align="center">
+  Built with ❤️ by <strong>Amogha Raj Sandur</strong> & <strong>SandurTech (Sandur Technologies)</strong>
+</div>

package/dist/index.d.ts

@@ -1,5 +1,12 @@
+import { SandAccordion } from './components/Accordion/Accordion';
+import { SandAccordionItem } from './components/Accordion/Accordion';
+import { SandAccordionProps } from './components/Accordion/Accordion';
+import { SandAlert } from './components/Alert/Alert';
+import { SandAlertProps } from './components/Alert/Alert';
 import { SandBadge } from './components/Badge/Badge';
 import { SandBadgeProps } from './components/Badge/Badge';
+import { SandBox } from './components/Box/Box';
+import { SandBoxOwnProps as SandBoxProps } from './components/Box/Box';
 import { SandBreadcrumbItem } from './components/Breadcrumbs/Breadcrumbs';
 import { SandBreadcrumbs } from './components/Breadcrumbs/Breadcrumbs';
 import { SandBreadcrumbsProps } from './components/Breadcrumbs/Breadcrumbs';
@@ -11,27 +18,36 @@ import { SandCheckbox } from './components/Selection/Selection';
 import { SandChoiceBaseProps } from './components/Selection/Selection';
 import { SandChoiceGroup } from './components/Selection/Selection';
 import { SandChoiceGroupProps } from './components/Selection/Selection';
+import { SandCode } from './components/Typography/Typography';
 import { SandCodeBlock } from './components/CodeBlock/CodeBlock';
 import { SandCodeBlockProps } from './components/CodeBlock/CodeBlock';
+import { SandCodeOwnProps as SandCodeProps } from './components/Typography/Typography';
 import { SandCodeTabs } from './components/CodeBlock/CodeBlock';
 import { SandCodeTabsProps } from './components/CodeBlock/CodeBlock';
 import { SandContainer } from './components/Layout/Layout';
 import { SandContainerProps } from './components/Layout/Layout';
 import { SandDivider } from './components/Divider/Divider';
 import { SandDividerProps } from './components/Divider/Divider';
+import { SandDrawer } from './components/Navbar/Navbar';
+import { SandDrawerProps } from './components/Navbar/Navbar';
 import { SandFeedbackProps } from './components/Feedback/Feedback';
 import { SandFormGroup } from './components/Input/Input';
 import { SandFormGroupProps } from './components/Input/Input';
+import { SandGrid } from './components/Grid';
+import { SandGridItemProps } from './components/Grid';
+import { SandGridProps } from './components/Grid';
 import { SandHeader } from './components/Layout/Layout';
 import { SandHeaderProps } from './components/Layout/Layout';
+import { SandIcon } from './components/Icon/Icon';
+import { SandIconProps } from './components/Icon/Icon';
 import { SandInput } from './components/Input/Input';
 import { SandInputGroup } from './components/Input/Input';
 import { SandInputGroupProps } from './components/Input/Input';
 import { SandInputProps } from './components/Input/Input';
 import { SandKBD } from './components/Kbd/Kbd';
 import { SandKBDProps } from './components/Kbd/Kbd';
-import { SandMicroserviceLayout } from './components/Layout/Layout';
-import { SandMicroserviceLayoutProps } from './components/Layout/Layout';
+import { SandLoader } from './components/Loader/Loader';
+import { SandLoaderProps } from './components/Loader/Loader';
 import { SandModal } from './components/Modal/Modal';
 import { SandModalBodyProps } from './components/Modal/Modal';
 import { SandModalDescriptionProps } from './components/Modal/Modal';
@@ -39,23 +55,62 @@ import { SandModalFooterProps } from './components/Modal/Modal';
 import { SandModalHeaderProps } from './components/Modal/Modal';
 import { SandModalProps } from './components/Modal/Modal';
 import { SandModalTitleProps } from './components/Modal/Modal';
+import { SandNavbar } from './components/Navbar/Navbar';
+import { SandNavbarItem } from './components/Navbar/Navbar';
+import { SandNavbarProps } from './components/Navbar/Navbar';
 import { SandPagination } from './components/Pagination/Pagination';
 import { SandPaginationProps } from './components/Pagination/Pagination';
+import { SandProgress } from './components/Progress/Progress';
+import { SandProgressProps } from './components/Progress/Progress';
 import { SandRadio } from './components/Selection/Selection';
 import { SandResultPanel } from './components/Layout/Layout';
 import { SandResultPanelProps } from './components/Layout/Layout';
+import { SandSkeleton } from './components/Loader/Loader';
+import { SandSkeletonProps } from './components/Loader/Loader';
 import { SandSnackbar } from './components/Feedback/Feedback';
+import { SandStack } from './components/Stack/Stack';
+import { SandStackOwnProps as SandStackProps } from './components/Stack/Stack';
 import { SandSwitch } from './components/Selection/Selection';
+import { SandTabItem } from './components/Tabs/Tabs';
+import { SandTable } from './components/Table/Table';
+import { SandTableProps } from './components/Table/Table';
+import { SandTabs } from './components/Tabs/Tabs';
+import { SandTabsProps } from './components/Tabs/Tabs';
+import { SandText } from './components/Typography/Typography';
+import { SandTextOwnProps as SandTextProps } from './components/Typography/Typography';
+import { SandThemeContextValue } from './components/ThemeProvider/ThemeProvider';
+import { SandThemeProvider } from './components/ThemeProvider/ThemeProvider';
+import { SandThemeProviderProps } from './components/ThemeProvider/ThemeProvider';
+import { SandThemeTokens } from './components/ThemeProvider/ThemeProvider';
+import { SandTitle } from './components/Typography/Typography';
+import { SandTitleOwnProps as SandTitleProps } from './components/Typography/Typography';
 import { SandToast } from './components/Feedback/Feedback';
 import { SandToolLayout } from './components/Layout/Layout';
 import { SandToolLayoutProps } from './components/Layout/Layout';
 import { SandToolPanel } from './components/Layout/Layout';
 import { SandToolPanelProps } from './components/Layout/Layout';
+import { SandTooltip } from './components/Tooltip/Tooltip';
+import { SandTooltipProps } from './components/Tooltip/Tooltip';
+import { useSandTheme } from './components/ThemeProvider/ThemeProvider';
+
+export { SandAccordion }
+
+export { SandAccordionItem }
+
+export { SandAccordionProps }
+
+export { SandAlert }
+
+export { SandAlertProps }
 
 export { SandBadge }
 
 export { SandBadgeProps }
 
+export { SandBox }
+
+export { SandBoxProps }
+
 export { SandBreadcrumbItem }
 
 export { SandBreadcrumbs }
@@ -78,10 +133,14 @@ export { SandChoiceGroup }
 
 export { SandChoiceGroupProps }
 
+export { SandCode }
+
 export { SandCodeBlock }
 
 export { SandCodeBlockProps }
 
+export { SandCodeProps }
+
 export { SandCodeTabs }
 
 export { SandCodeTabsProps }
@@ -94,16 +153,30 @@ export { SandDivider }
 
 export { SandDividerProps }
 
+export { SandDrawer }
+
+export { SandDrawerProps }
+
 export { SandFeedbackProps }
 
 export { SandFormGroup }
 
 export { SandFormGroupProps }
 
+export { SandGrid }
+
+export { SandGridItemProps }
+
+export { SandGridProps }
+
 export { SandHeader }
 
 export { SandHeaderProps }
 
+export { SandIcon }
+
+export { SandIconProps }
+
 export { SandInput }
 
 export { SandInputGroup }
@@ -116,9 +189,9 @@ export { SandKBD }
 
 export { SandKBDProps }
 
-export { SandMicroserviceLayout }
+export { SandLoader }
 
-export { SandMicroserviceLayoutProps }
+export { SandLoaderProps }
 
 export { SandModal }
 
@@ -134,20 +207,64 @@ export { SandModalProps }
 
 export { SandModalTitleProps }
 
+export { SandNavbar }
+
+export { SandNavbarItem }
+
+export { SandNavbarProps }
+
 export { SandPagination }
 
 export { SandPaginationProps }
 
+export { SandProgress }
+
+export { SandProgressProps }
+
 export { SandRadio }
 
 export { SandResultPanel }
 
 export { SandResultPanelProps }
 
+export { SandSkeleton }
+
+export { SandSkeletonProps }
+
 export { SandSnackbar }
 
+export { SandStack }
+
+export { SandStackProps }
+
 export { SandSwitch }
 
+export { SandTabItem }
+
+export { SandTable }
+
+export { SandTableProps }
+
+export { SandTabs }
+
+export { SandTabsProps }
+
+export { SandText }
+
+export { SandTextProps }
+
+export { SandThemeContextValue }
+
+export { SandThemeProvider }
+
+export { SandThemeProviderProps }
+
+export { SandThemeTokens }
+
+export { SandTitle }
+
+export { SandTitleProps }
+
 export { SandToast }
 
 export { SandToolLayout }
@@ -158,4 +275,10 @@ export { SandToolPanel }
 
 export { SandToolPanelProps }
 
+export { SandTooltip }
+
+export { SandTooltipProps }
+
+export { useSandTheme }
+
 export { }