@ixo/ui 0.0.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+Copyright 2023 IXO
+
+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,389 @@
+# @ixo/ui
+
+A comprehensive React UI component library built with **Emotion** and **Mantine**, featuring a complete theming system, extensive icon library, and components designed for impact-focused applications.
+
+## ✨ Features
+
+- 🎨 **Theming System**: Light/dark theme support with customizable theme overrides
+- 🧩 **100+ Components**: Buttons, cards, forms, navigation, data display, and specialized components
+- 🎯 **Icon Library**: 300+ icons including crypto currencies, SDG icons, and general purpose icons
+- 📱 **Responsive**: Mobile-first design with responsive breakpoints
+- 🎭 **Emotion CSS-in-JS**: Styled with Emotion for dynamic styling and theme integration
+- 📖 **Storybook**: Comprehensive component documentation and playground
+- 🔧 **TypeScript**: Full TypeScript support with comprehensive type definitions
+- ⚡ **Tree-shakeable**: Optimized bundle size with selective imports
+
+## 🚀 Installation
+
+```bash
+npm install @ixo/ui @emotion/react @emotion/cache
+# or
+pnpm add @ixo/ui @emotion/react @emotion/cache
+# or
+yarn add @ixo/ui @emotion/react @emotion/cache
+```
+
+## 🛠️ Setup
+
+### 1. Wrap your app with UiProvider
+
+The `UiProvider` is **required** to provide theming context using Emotion's ThemeProvider:
+
+```tsx
+import { UiProvider } from "@ixo/ui/components";
+
+function App() {
+  return <UiProvider>{/* Your app content */}</UiProvider>;
+}
+```
+
+### 2. Custom Theme (Optional)
+
+You can customize both light and dark themes:
+
+```tsx
+import { UiProvider } from "@ixo/ui/components";
+
+const customLightTheme = {
+  colors: {
+    focus: "#ff6b35", // Custom accent color
+    focusHover: "#ff8c66"
+  },
+  text: {
+    main: "#1a1a1a"
+  }
+};
+
+const customDarkTheme = {
+  colors: {
+    focus: "#00d2ff",
+    focusHover: "#2ad9ff"
+  }
+};
+
+function App() {
+  return (
+    <UiProvider customlightTheme={customLightTheme} customDarkTheme={customDarkTheme}>
+      {/* Your app content */}
+    </UiProvider>
+  );
+}
+```
+
+### 3. Next.js Setup (SSR Support)
+
+For Next.js applications, add Emotion cache provider:
+
+```tsx
+// pages/_app.tsx
+import { CacheProvider } from "@emotion/react";
+import createCache from "@emotion/cache";
+import { UiProvider } from "@ixo/ui/components";
+
+const cache = createCache({ key: "css", prepend: true });
+
+function MyApp({ Component, pageProps }) {
+  return (
+    <CacheProvider value={cache}>
+      <UiProvider>
+        <Component {...pageProps} />
+      </UiProvider>
+    </CacheProvider>
+  );
+}
+```
+
+## 📦 Usage
+
+### Components
+
+```tsx
+import { Button, Card, Typography, TextInput, Avatar, Tag } from "@ixo/ui/components";
+
+function MyComponent() {
+  return (
+    <Card>
+      <Typography variant="h2">Welcome to IXO</Typography>
+
+      <Avatar src="/path/to/avatar.jpg" name="John Doe" size="lg" />
+
+      <TextInput label="Email" placeholder="Enter your email" required />
+
+      <Tag value="Verified" color="success" />
+
+      <Button value="Get Started" lg onClick={() => console.log("Button clicked!")} />
+    </Card>
+  );
+}
+```
+
+### Icons
+
+```tsx
+import { Heart, User, Search, ChevronDown } from "@ixo/ui/icons";
+
+function IconExample() {
+  return (
+    <div>
+      <Heart size={24} color="#ff6b35" />
+      <User size={20} />
+      <Search size={16} />
+    </div>
+  );
+}
+```
+
+### Crypto Icons
+
+```tsx
+import { Bitcoin, Ethereum, Solana } from "@ixo/ui/icons/crypto";
+
+function CryptoIcons() {
+  return (
+    <div>
+      <Bitcoin size={32} />
+      <Ethereum size={32} />
+      <Solana size={32} />
+    </div>
+  );
+}
+```
+
+### SDG Icons (Sustainable Development Goals)
+
+```tsx
+import { SDG1, SDG2, SDG3 } from "@ixo/ui/icons/sdg";
+
+function SDGIcons() {
+  return (
+    <div>
+      <SDG1 size={48} />
+      <SDG2 size={48} />
+      <SDG3 size={48} />
+    </div>
+  );
+}
+```
+
+### Pictograms
+
+```tsx
+import { Services, Impacts, Portfolio } from "@ixo/ui/pictograms";
+
+function PictogramExample() {
+  return (
+    <div>
+      <Services size={64} />
+      <Impacts size={64} />
+      <Portfolio size={64} />
+    </div>
+  );
+}
+```
+
+### Hooks
+
+```tsx
+import { useColorScheme, useUITheme, useEventSubscribe } from "@ixo/ui/hooks";
+
+function HookExample() {
+  const theme = useUITheme();
+  const { isDark, toggle } = useColorScheme();
+
+  return (
+    <div style={{ color: theme.text.main }}>
+      <p>Current theme: {isDark ? "Dark" : "Light"}</p>
+      <button onClick={toggle}>Toggle Theme</button>
+    </div>
+  );
+}
+```
+
+## 📚 Available Components
+
+### Layout & Navigation
+
+- `Layout`, `NavigationBar`, `NavButton`, `TabNavigation`, `TabSelector`
+
+### Buttons & Actions
+
+- `Button`, `ButtonBasic`, `ButtonSubtle`, `RoundedButton`, `IconButton`, `ActionCard`
+
+### Data Display
+
+- `Card`, `Table`, `Tag`, `Avatar`, `Typography`, `Chart`, `Tooltip`
+
+### Forms & Inputs
+
+- `TextInput`, `Select`, `Checkbox`, `Switch`, `ComboBox`, `SearchInput`
+
+### Feedback & Loading
+
+- `Loader`, `Modal`, `Toast`, `FeedbackMessage`, `Tooltip`
+
+### Specialized Components
+
+- `ActivityCard`, `ProfileCard`, `EcosystemCard`, `SodaCard`, `PlanCard`
+- `EntityList`, `GroupSelector`, `FilterTags`, `ImpactCreditState`
+
+And many more! See the full list in [Storybook](#storybook).
+
+## 🎨 Theme System
+
+The library uses a comprehensive theme system with:
+
+- **Colors**: Focus colors, semantic colors (success, warning, error), neutral shades
+- **Typography**: Font sizes, weights, and responsive text scaling
+- **Spacing**: Consistent spacing scale for margins and padding
+- **Breakpoints**: Mobile-first responsive breakpoints
+- **Glass effects**: Modern glassmorphism styling
+- **Automatic theme switching**: Based on user preference stored in localStorage
+
+### Theme Structure
+
+```typescript
+type UITheme = {
+  colors: {
+    focus: string;
+    focusSecondary: string;
+    focusHover: string;
+    // ... more colors
+  };
+  text: {
+    main: string;
+    secondary: string;
+    overPicture: string;
+  };
+  bg: {
+    card: string;
+    main: string;
+    navbar: string;
+    // ... more backgrounds
+  };
+  semantic: {
+    success: string;
+    warning: string;
+    error: string;
+  };
+  // ... spacing, radius, etc.
+};
+```
+
+## 🧑‍💻 Local Development
+
+### Prerequisites
+
+- Node.js 20+
+- pnpm 10.6.5+
+
+### Setup
+
+```bash
+# Clone the repository
+git clone <repository-url>
+cd ixo-ui
+
+# Install dependencies
+pnpm install
+```
+
+### Development Commands
+
+```bash
+# Start Storybook development server
+pnpm dev
+
+# Build the library
+pnpm build
+
+# Build for local testing (creates .tgz package)
+pnpm build:local
+
+# Lint code
+pnpm lint
+pnpm lint:fix
+
+# Format code
+pnpm format
+pnpm format:check
+
+# Build Storybook for production
+pnpm build:storybook
+```
+
+### Storybook
+
+Launch the component playground and documentation:
+
+```bash
+pnpm dev
+```
+
+This will start Storybook at `http://localhost:6006` where you can:
+
+- 📖 Browse all components with live examples
+- 🎛️ Interact with component props in real-time
+- 🎨 Test different themes and configurations
+- 📱 Test responsive behavior
+- 📋 Copy code examples
+- 🧪 Test accessibility features
+
+### Adding New Components
+
+1. Create component directory: `src/components/MyComponent/`
+2. Add implementation: `index.tsx`, `types.ts`
+3. Create Storybook story: `MyComponent.stories.tsx`
+4. Export from: `src/export/components.ts`
+5. Test in Storybook: `pnpm dev`
+
+## 🏗️ Build System
+
+Built with **Vite** and configured for optimal library distribution:
+
+- **Multiple entry points**: Components, hooks, icons, themes
+- **Dual format**: ES modules (.mjs) and CommonJS (.cjs)
+- **TypeScript declarations**: Full type support
+- **Tree-shaking**: Import only what you need
+- **Emotion externalization**: Prevents SSR issues
+- **Source maps**: For easier debugging
+
+### Build Outputs
+
+```
+dist/
+├── export/
+│   ├── components.mjs/.cjs/.d.ts
+│   ├── hooks.mjs/.cjs/.d.ts
+│   ├── icons/index.mjs/.cjs/.d.ts
+│   ├── icons/crypto.mjs/.cjs/.d.ts
+│   ├── icons/sdg.mjs/.cjs/.d.ts
+│   ├── pictograms.mjs/.cjs/.d.ts
+│   ├── themes.mjs/.cjs/.d.ts
+│   └── types.mjs/.cjs/.d.ts
+```
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create feature branch: `git checkout -b feature/amazing-component`
+3. Add your component with proper TypeScript types
+4. Create comprehensive Storybook stories
+5. Add component to exports
+6. Test thoroughly in Storybook
+7. Commit changes: `git commit -m 'Add amazing component'`
+8. Push to branch: `git push origin feature/amazing-component`
+9. Open a Pull Request
+
+## 📄 License
+
+[License information here]
+
+## 🆘 Support
+
+- 📖 [Storybook Documentation](http://localhost:6006) (run `pnpm dev`)
+- 🐛 [Issue Tracker](repository-issues-url)
+- 💬 [Discussions](repository-discussions-url)
+
+---
+
+Built with ❤️ for impact-focused applications