elseware-ui 3.0.11 → 3.0.12

package/README.md

@@ -1,289 +1,289 @@
-# elseware-ui
-
-A modern, customizable React component library for building web and desktop user interfaces.
-
-`elseware-ui` provides reusable, production-ready UI components designed to speed up application development while maintaining consistency, accessibility, scalability, and a clean developer experience.
-
-## Features
-
-- TypeScript-first component development
-- React-based component architecture
-- Tailwind CSS integration
-- Customizable themes, variants, shapes, and styles
-- Shared design tokens, enums, animations, and SVG utilities
-- Modular barrel exports
-- Tree-shakable ESM build
-- Storybook-powered component development
-- Linting, formatting, type checking, and build validation
-- Web and desktop application support
-- Developer-friendly APIs
-
-## Installation
-
-Install the package:
-
-```bash
-npm install elseware-ui
-```
-
-Install required peer dependencies if they are not already installed:
-
-```bash
-npm install react react-dom tailwindcss
-```
-
-## Package Exports
-
-The package exposes the main component API and compiled styles:
-
-```json
-{
-  ".": {
-    "types": "./dist/index.d.ts",
-    "import": "./dist/index.js",
-    "require": "./dist/index.cjs"
-  },
-  "./styles.css": "./dist/index.css"
-}
-```
-
-Recommended usage:
-
-```tsx
-import { Button } from "elseware-ui";
-import "elseware-ui/styles.css";
-```
-
-## Component Import Structure
-
-Use the following import ordering convention when creating or updating components:
-
-```ts
-// External
-
-// Internal
-
-// Data
-
-// Types
-```
-
-Example:
-
-```ts
-// External
-import React from "react";
-
-// Internal
-import { cn } from "../../../utils";
-
-// Data
-import { Shape, Variant } from "../../../data/enums";
-import { shapes, variants } from "../../../data/styles";
-
-// Types
-import type { BaseComponentProps } from "../../../interfaces";
-```
-
-## Development
-
-Install dependencies:
-
-```bash
-npm install
-```
-
-Start Storybook:
-
-```bash
-npm run dev
-```
-
-Build the component library:
-
-```bash
-npm run build
-```
-
-Build Storybook:
-
-```bash
-npm run build:storybook
-```
-
-## Code Quality
-
-Run TypeScript checks:
-
-```bash
-npm run typecheck
-```
-
-Run ESLint:
-
-```bash
-npm run lint
-```
-
-Fix lint issues:
-
-```bash
-npm run lint:fix
-```
-
-Format files with Prettier:
-
-```bash
-npm run format
-```
-
-Check formatting:
-
-```bash
-npm run format:check
-```
-
-Check unused files, exports, and dependencies:
-
-```bash
-npm run deadcode
-```
-
-Run the full validation pipeline:
-
-```bash
-npm run validate
-```
-
-Run automatic lint fixes, formatting, and validation:
-
-```bash
-npm run full
-```
-
-## Git Hooks
-
-Initialize Husky:
-
-```bash
-npm run prepare:husky
-```
-
-Recommended pre-commit hook:
-
-```bash
-npx lint-staged
-```
-
-## Publishing
-
-Before publishing, update the package version:
-
-```bash
-npm version patch
-```
-
-or:
-
-```bash
-npm version minor
-```
-
-or:
-
-```bash
-npm version major
-```
-
-Then publish:
-
-```bash
-npm run release
-```
-
-The `release` script validates the package before publishing.
-
-## Component Guidelines
-
-When building components:
-
-- Keep components modular and focused
-- Move reusable enums to `src/data/enums.ts`
-- Move reusable style maps to `src/data/styles.tsx`
-- Move reusable animation class maps to `src/data/animations.tsx`
-- Move generic SVG icons to `src/data/svgs.tsx`
-- Keep component-specific state logic in hooks when possible
-- Keep public types in each component's `types.ts`
-- Export each component through its local `index.ts`
-- Avoid unnecessary dependencies between unrelated component groups
-
-## Barrel Export Pattern
-
-Each component should expose a local barrel file:
-
-```ts
-export * from "./Button";
-export * from "./types";
-```
-
-Component groups should also expose barrel exports:
-
-```ts
-export * from "./avatar";
-export * from "./badge";
-export * from "./toast";
-```
-
-The root entry point should expose the public package API:
-
-```ts
-export * from "./components";
-export * from "./compositions";
-export * from "./hooks";
-export * from "./layouts";
-export * from "./providers";
-export * from "./routing";
-export * from "./utils";
-export * from "./interfaces";
-export * from "./types";
-```
-
-## Styling
-
-`elseware-ui` uses Tailwind CSS and shared design tokens.
-
-Consumers should import the compiled stylesheet once in their application entry:
-
-```tsx
-import "elseware-ui/styles.css";
-```
-
-## Documentation
-
-Interactive component documentation and examples are available through Storybook.
-
-Start Storybook locally:
-
-```bash
-npm run dev
-```
-
-## About elseware Technology
-
-elseware Technology builds tools, frameworks, and solutions for software engineering, cloud computing, game development, and developer productivity.
-
-## Contributing
-
-Contributions, issues, and feature requests are welcome.
-
-Before opening a pull request, run:
-
-```bash
-npm run validate
-```
-
-## License
-
-This project is licensed under the MIT License.
-
-Copyright © 2026 elseware Technology.
+# elseware-ui
+
+A modern, customizable React component library for building web and desktop user interfaces.
+
+`elseware-ui` provides reusable, production-ready UI components designed to speed up application development while maintaining consistency, accessibility, scalability, and a clean developer experience.
+
+## Features
+
+- TypeScript-first component development
+- React-based component architecture
+- Tailwind CSS integration
+- Customizable themes, variants, shapes, and styles
+- Shared design tokens, enums, animations, and SVG utilities
+- Modular barrel exports
+- Tree-shakable ESM build
+- Storybook-powered component development
+- Linting, formatting, type checking, and build validation
+- Web and desktop application support
+- Developer-friendly APIs
+
+## Installation
+
+Install the package:
+
+```bash
+npm install elseware-ui
+```
+
+Install required peer dependencies if they are not already installed:
+
+```bash
+npm install react react-dom tailwindcss
+```
+
+## Package Exports
+
+The package exposes the main component API and compiled styles:
+
+```json
+{
+  ".": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "./styles.css": "./dist/index.css"
+}
+```
+
+Recommended usage:
+
+```tsx
+import { Button } from "elseware-ui";
+import "elseware-ui/styles.css";
+```
+
+## Component Import Structure
+
+Use the following import ordering convention when creating or updating components:
+
+```ts
+// External
+
+// Internal
+
+// Data
+
+// Types
+```
+
+Example:
+
+```ts
+// External
+import React from "react";
+
+// Internal
+import { cn } from "../../../utils";
+
+// Data
+import { Shape, Variant } from "../../../data/enums";
+import { shapes, variants } from "../../../data/styles";
+
+// Types
+import type { BaseComponentProps } from "../../../interfaces";
+```
+
+## Development
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Start Storybook:
+
+```bash
+npm run dev
+```
+
+Build the component library:
+
+```bash
+npm run build
+```
+
+Build Storybook:
+
+```bash
+npm run build:storybook
+```
+
+## Code Quality
+
+Run TypeScript checks:
+
+```bash
+npm run typecheck
+```
+
+Run ESLint:
+
+```bash
+npm run lint
+```
+
+Fix lint issues:
+
+```bash
+npm run lint:fix
+```
+
+Format files with Prettier:
+
+```bash
+npm run format
+```
+
+Check formatting:
+
+```bash
+npm run format:check
+```
+
+Check unused files, exports, and dependencies:
+
+```bash
+npm run deadcode
+```
+
+Run the full validation pipeline:
+
+```bash
+npm run validate
+```
+
+Run automatic lint fixes, formatting, and validation:
+
+```bash
+npm run full
+```
+
+## Git Hooks
+
+Initialize Husky:
+
+```bash
+npm run prepare:husky
+```
+
+Recommended pre-commit hook:
+
+```bash
+npx lint-staged
+```
+
+## Publishing
+
+Before publishing, update the package version:
+
+```bash
+npm version patch
+```
+
+or:
+
+```bash
+npm version minor
+```
+
+or:
+
+```bash
+npm version major
+```
+
+Then publish:
+
+```bash
+npm run release
+```
+
+The `release` script validates the package before publishing.
+
+## Component Guidelines
+
+When building components:
+
+- Keep components modular and focused
+- Move reusable enums to `src/data/enums.ts`
+- Move reusable style maps to `src/data/styles.tsx`
+- Move reusable animation class maps to `src/data/animations.tsx`
+- Move generic SVG icons to `src/data/svgs.tsx`
+- Keep component-specific state logic in hooks when possible
+- Keep public types in each component's `types.ts`
+- Export each component through its local `index.ts`
+- Avoid unnecessary dependencies between unrelated component groups
+
+## Barrel Export Pattern
+
+Each component should expose a local barrel file:
+
+```ts
+export * from "./Button";
+export * from "./types";
+```
+
+Component groups should also expose barrel exports:
+
+```ts
+export * from "./avatar";
+export * from "./badge";
+export * from "./toast";
+```
+
+The root entry point should expose the public package API:
+
+```ts
+export * from "./components";
+export * from "./compositions";
+export * from "./hooks";
+export * from "./layouts";
+export * from "./providers";
+export * from "./routing";
+export * from "./utils";
+export * from "./interfaces";
+export * from "./types";
+```
+
+## Styling
+
+`elseware-ui` uses Tailwind CSS and shared design tokens.
+
+Consumers should import the compiled stylesheet once in their application entry:
+
+```tsx
+import "elseware-ui/styles.css";
+```
+
+## Documentation
+
+Interactive component documentation and examples are available through Storybook.
+
+Start Storybook locally:
+
+```bash
+npm run dev
+```
+
+## About elseware Technology
+
+elseware Technology builds tools, frameworks, and solutions for software engineering, cloud computing, game development, and developer productivity.
+
+## Contributing
+
+Contributions, issues, and feature requests are welcome.
+
+Before opening a pull request, run:
+
+```bash
+npm run validate
+```
+
+## License
+
+This project is licensed under the MIT License.
+
+Copyright © 2026 elseware Technology.