strivui/README.md

Type-safe, composable React UI toolkit with accessible, theme-aware components, design tokens, and tree-shakable architecture for scalable, maintainable applications.

<p align="center">
  <img src="https://raw.githubusercontent.com/syedabdullahali/strivui/refs/heads/main/logo.png" width="200" alt="StrivUI Logo" />
</p>
<p align="center">
A hybrid, utility-first React component system inspired by React Native primitives.<br/>
TypeScript • Atomic CSS • Tree-shakable • Minimal runtime
</p>

---


## Overview

StrivUI provides a unified component model for building React applications with the
ergonomics of **React Native primitives** and the structure of **modern web layouts**.

It is designed to deliver:

- A consistent cross-platform mental model  
- Composable, atomic styling with zero configuration  
- Strict TypeScript support across all public APIs  
- Lightweight, tree-shakable bundles  

The library focuses on predictable composition, sensible defaults, and full
`className` extensibility rather than heavy theming abstractions.

---


## Installation

```bash
npm install strivui
````

---


## Usage

```tsx
import { Button } from "strivui";

export function App() {
  return (
    <Button className="bg-blue-500 text-white px-4 py-2 rounded">
      Click me
    </Button>
  );
}
```

---


## Component Architecture

**Primitives**
`View` · `Text` · `ScrollView` · `Pressable` · `FlatList` · `Image`

**Layout**
`Header` · `Section` · `Container` · `Card` · `Navigation`

**UI**
`Button` · `Input` · `Select` · `Modal` · `Dialog` · `Table`

Each layer is independently importable and optimized for tree-shaking.

---


## Styling Model

StrivUI uses an **atomic, utility-first CSS approach**:

* Single-purpose utility classes
* Deterministic composition
* No runtime style generation
* Seamless integration with existing design systems

---


## TypeScript

StrivUI is **TypeScript-first** and ships with complete declaration files for all
public exports, ensuring accurate IntelliSense and type safety.

---


## Roadmap

* Token-based theming (`striv.config.js`)
* Dark mode primitives
* Animation utilities
* CLI scaffolding
* SSR / RSC compatibility

---


## License

MIT © Syed Abdullah Ali