@open-ui-kit/core 1.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                        Apache License
+                  Version 2.0, January 2004
+               http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Open UI Kit Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,393 @@
+<!-- To update the table of contents, install globally `doctoc`, and run 'doctoc ./README.md'
+DO NOT UPDATE MANUALLY! -->
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Open UI Kit](#open-ui-kit)
+  - [✨ Features](#-features)
+  - [🚀 Quick Start](#-quick-start)
+  - [🔐 Authentication](#-authentication)
+  - [📦 Installation](#-installation)
+    - [NPM](#npm)
+    - [Yarn](#yarn)
+  - [💻 Usage](#-usage)
+    - [Basic Setup](#basic-setup)
+    - [Using Components](#using-components)
+    - [Theme Customization](#theme-customization)
+    - [TypeScript Support](#typescript-support)
+  - [📚 Available Components](#-available-components)
+  - [📖 Documentation](#-documentation)
+  - [🧪 Testing](#-testing)
+  - [🚢 Releases](#-releases)
+    - [Beta Releases](#beta-releases)
+  - [🤝 Contributing](#-contributing)
+  - [📄 License](#-license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+<div align="center">
+
+<h1> 🎨 Open UI Kit </h1>
+
+**A comprehensive React component library built on Material-UI for modern applications**
+
+<br />
+<br />
+
+[![npm](https://img.shields.io/badge/npm-package-CB3837?logo=npm)](https://www.npmjs.com/package/@open-ui-kit/core)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+[![Storybook](https://img.shields.io/badge/storybook-view%20docs-ff69b4)](https://main--67e2c28f188630b706cee923.chromatic.com)
+[![License](https://img.shields.io/github/license/outshift-open/open-ui-kit)](LICENSE)
+
+</div>
+
+## ✨ Features
+
+- 🎯 **50+ Pre-built Components** - From basic buttons to complex data tables and interactive charts
+- 🌓 **Dark/Light Theme Support** - Built-in theme switching with seamless transitions
+- 📱 **Responsive Design** - Mobile-first approach with flexible, adaptive layouts
+- ♿ **Accessibility First** - WCAG compliant components with proper ARIA attributes
+- 🔧 **TypeScript Native** - Full TypeScript support with comprehensive type definitions
+- 📊 **Data Visualization** - Rich chart components for analytics and dashboards
+- 🎨 **Customizable Theming** - Extend and customize colors, typography, and spacing
+- 📚 **Interactive Documentation** - Comprehensive Storybook with live examples
+
+## 🚀 Quick Start
+
+```bash
+# Install the package and peer dependencies
+npm install @open-ui-kit/core @mui/material @emotion/react @emotion/styled
+
+# Import CSS and start using components
+import '@open-ui-kit/core/typography.css';
+import { ThemeProvider, Button } from '@open-ui-kit/core';
+```
+
+## 🔐 Installation
+
+Open UI Kit is available as an open source package. You can install it directly from npm.
+
+## 📦 Installation
+
+> **Prerequisites**: Node.js 18+ and npm 8+ (or Yarn 1.22+)
+
+### NPM
+
+```bash
+npm install @open-ui-kit/core @mui/material @emotion/react @emotion/styled
+```
+
+### Yarn
+
+```bash
+yarn add @open-ui-kit/core @mui/material @emotion/react @emotion/styled
+```
+
+**Required Peer Dependencies:**
+- `@mui/material` ^5.0.0 - Core Material-UI components
+- `@emotion/react` ^11.0.0 - CSS-in-JS styling engine  
+- `@emotion/styled` ^11.0.0 - Styled component utilities
+- `react` ^17.0.0 || ^18.0.0
+- `react-dom` ^17.0.0 || ^18.0.0
+
+## 💻 Usage
+
+### Basic Setup
+
+Wrap your application with the `ThemeProvider` to enable Open UI Kit theming:
+
+```jsx
+import React, { useState } from 'react';
+import { ThemeProvider } from '@open-ui-kit/core';
+import '@open-ui-kit/core/typography.css';
+
+function App() {
+  const [isDarkMode, setIsDarkMode] = useState(false);
+
+  return (
+    <ThemeProvider isDarkMode={isDarkMode}>
+      <div className="app">
+        <header>
+          <button onClick={() => setIsDarkMode(!isDarkMode)}>
+            Switch to {isDarkMode ? 'Light' : 'Dark'} Mode
+          </button>
+        </header>
+        {/* Your app content goes here */}
+      </div>
+    </ThemeProvider>
+  );
+}
+
+export default App;
+```
+
+### Using Components
+
+Import and use components from the library:
+
+```jsx
+import {
+  Button,
+  Card,
+  TextField,
+  Badge,
+  Avatar,
+  Modal,
+  Typography
+} from '@open-ui-kit/core';
+
+function MyComponent() {
+  const [open, setOpen] = useState(false);
+
+  return (
+    <Card sx={{ p: 3, maxWidth: 400 }}>
+      <div style={{ display: 'flex', alignItems: 'center', mb: 2 }}>
+        <Avatar src="/user-avatar.jpg" sx={{ mr: 2 }} />
+        <Typography variant="h6">Welcome back!</Typography>
+      </div>
+      
+      <TextField 
+        label="Enter your message" 
+        variant="outlined" 
+        fullWidth 
+        sx={{ mb: 2 }}
+      />
+      
+      <Button 
+        variant="contained" 
+        color="primary" 
+        onClick={() => setOpen(true)}
+        sx={{ mr: 1 }}
+      >
+        Open Modal
+      </Button>
+      
+      <Badge badgeContent={4} color="secondary">
+        <Button variant="outlined">Notifications</Button>
+      </Badge>
+
+      <Modal open={open} onClose={() => setOpen(false)}>
+        <div>Modal content here</div>
+      </Modal>
+    </Card>
+  );
+}
+```
+
+### Theme Customization
+
+Access theme variables for consistent styling across your application:
+
+```jsx
+import { useTheme } from '@open-ui-kit/core';
+
+function StyledComponent() {
+  const theme = useTheme();
+
+  return (
+    <div
+      style={{
+        backgroundColor: theme.palette.vars.controlBackgroundDefault,
+        color: theme.palette.vars.textPrimary,
+        padding: theme.spacing(2),
+        borderRadius: theme.shape.borderRadius,
+        border: `1px solid ${theme.palette.divider}`
+      }}
+    >
+      <h3 style={{ color: theme.palette.primary.main }}>
+        Themed Content
+      </h3>
+      <p>This component uses theme variables for consistent styling.</p>
+    </div>
+  );
+}
+```
+
+### TypeScript Support
+
+The library provides full TypeScript support with augmented Material-UI theme types:
+
+```typescript
+import { useTheme, Theme } from '@open-ui-kit/core';
+
+const MyTypedComponent: React.FC = () => {
+  const theme: Theme = useTheme();
+  
+  // Access custom theme variables with full type safety
+  const backgroundColor = theme.palette.vars.controlBackgroundDefault;
+  const primaryColor = theme.palette.primary.main;
+  const spacing = theme.spacing(2);
+  
+  return (
+    <div 
+      style={{ 
+        backgroundColor, 
+        color: primaryColor,
+        padding: spacing
+      }}
+    >
+      Fully typed theme access
+    </div>
+  );
+};
+```
+
+## 📚 Available Components
+
+The library includes 50+ components organized into the following categories:
+
+**🔧 Layout & Structure**
+- `Card`, `Divider`, `Drawer`, `Modal`, `Tabs`, `Accordion`
+
+**📝 Form Controls**
+- `Button`, `TextField`, `Checkbox`, `Radio`, `Select`, `Slider`, `Toggle`
+
+**🧭 Navigation**
+- `Breadcrumbs`, `Menu`, `Pagination`, `Stepper`, `Header`, `Footer`
+
+**📊 Data Display**
+- `Avatar`, `Badge`, `Table`, `List`, `Typography`, `Code Block`
+
+**💬 Feedback & Status**
+- `Toast`, `Spinner`, `Loading States`, `Empty State`, `Banner`
+
+**📈 Data Visualization**
+- `Bar Chart`, `Line Chart`, `Donut Chart`, `Gauge Chart`, `Chart Widget`
+
+**🔍 Specialized**
+- `Search Field`, `Autocomplete Tree`, `Date Time`, `Copy Button`, `Filters`
+
+> **💡 Tip**: All components are fully documented with interactive examples in our [Storybook](https://main--67e2c28f188630b706cee923.chromatic.com).
+
+## 📖 Documentation
+
+### Interactive Documentation
+We use **Storybook** for comprehensive component documentation with live examples:
+
+```bash
+# Run Storybook locally
+yarn storybook
+```
+
+🌐 **[View Live Documentation](https://main--67e2c28f188630b706cee923.chromatic.com)**
+
+### What you'll find in Storybook:
+- 📖 **Component API docs** - Props, types, and usage examples
+- 🎮 **Interactive playground** - Test components with different configurations
+- 🎨 **Design tokens** - Colors, typography, spacing, and theme variables
+- 📱 **Responsive examples** - See how components adapt to different screen sizes
+- ♿ **Accessibility guidelines** - WCAG compliance information and best practices
+
+## 🧪 Testing
+
+We use **Jest** and **React Testing Library** for comprehensive testing coverage.
+
+### Writing Tests
+- Create test files alongside components: `ComponentName.test.tsx`
+- Test component functionality, accessibility, and user interactions
+- Ensure all custom (non-MUI) components have test coverage
+
+### Running Tests
+```bash
+# Run all tests
+yarn test
+
+# Run tests in watch mode
+yarn test --watch
+
+# Run tests with coverage report
+yarn test --coverage
+```
+
+### Example Test Structure
+```typescript
+// src/components/Button/Button.test.tsx
+import { render, screen, fireEvent } from '@testing-library/react';
+import { ThemeProvider } from '@open-ui-kit/core';
+import { Button } from './Button';
+
+const renderWithTheme = (component: React.ReactElement) => {
+  return render(
+    <ThemeProvider>
+      {component}
+    </ThemeProvider>
+  );
+};
+
+describe('Button Component', () => {
+  it('renders correctly', () => {
+    renderWithTheme(<Button>Click me</Button>);
+    expect(screen.getByRole('button')).toBeInTheDocument();
+  });
+
+  it('handles click events', () => {
+    const handleClick = jest.fn();
+    renderWithTheme(<Button onClick={handleClick}>Click me</Button>);
+    
+    fireEvent.click(screen.getByRole('button'));
+    expect(handleClick).toHaveBeenCalledTimes(1);
+  });
+});
+```
+
+## 🚢 Releases
+
+This repository uses [**semantic-release**](https://github.com/semantic-release/semantic-release) for automated version management and package publishing.
+
+### 🎯 Stable Releases
+
+When a pull request is merged into the `main` branch, changes are automatically bundled into a stable release.
+
+- **Format**: `vX.Y.Z` (e.g., `v1.2.3`)
+- **Purpose**: Production-ready releases with all new features, improvements, and bug fixes
+- **Availability**: Published to npm with `latest` tag
+
+### 🧪 Beta Releases
+
+When a pull request is merged into the `beta` branch, changes are automatically bundled into a beta release.
+
+- **Format**: `vX.Y.Z-beta.N` (e.g., `v1.2.3-beta.4`)
+- **Purpose**: Pre-release testing and preview of upcoming features
+- **Availability**: Published to npm with `beta` tag
+- **⚠️ Note**: Beta releases may be less stable than production releases
+
+### 📋 Release Notes
+
+Each release includes:
+- 📝 **Changelog** - Detailed list of changes, additions, and fixes
+- 🏷️ **Git Tags** - Semantic versioning tags for easy reference
+- 📦 **Package Artifacts** - Built and tested distribution files
+
+### 🆘 Support
+
+- **🔧 Engineering Support**: [ENG Support](https://eurl.io/#n5tjptkJ2)
+- **🎨 UI/UX Support**: [UI/UX Support](https://eurl.io/#_uXpdQd1z)
+- **📞 Team Contact**: [Team Contact](https://eurl.io/#Nc8d4kzLp)
+
+## 🤝 Contributing
+
+We welcome contributions from the open source community! Please read our [Contributing Guidelines](../../CONTRIBUTING.md) and [Code of Conduct](../../CODE_OF_CONDUCT.md) before getting started.
+
+### Quick Start for Contributors
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-feature`
+3. Make your changes and add tests
+4. Run tests: `yarn test`
+5. Submit a pull request
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](../../LICENSE) file for details.
+
+---
+
+<div align="center">
+
+**Built with ❤️ by the Open UI Kit community**
+
+<br/>
+
+[📚 Documentation](https://main--67e2c28f188630b706cee923.chromatic.com) • [🐛 Report Issues](https://github.com/outshift-open/open-ui-kit/issues) • [💬 Discussions](https://github.com/outshift-open/open-ui-kit/discussions)
+
+</div>