nnp-shared-styles 1.1.6

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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,298 @@
+# PICC - PC - NNP Shared Styles 
+
+> A modular, lightweight SCSS/CSS design system and styling foundation providing design tokens, CSS custom properties, light/dark themes, responsive layout utilities, and reusable component styles.
+
+[![License: Apache License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![NPM Version](https://img.shields.io/badge/npm-v1.1.6-orange.svg)](https://www.npmjs.com/)
+[![SCSS](https://img.shields.io/badge/style-SCSS-CC6699.svg)](https://sass-lang.com/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](DEVELOPER_GUIDELINES.md)
+
+---
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Key Features](#key-features)
+- [Project Structure](#project-structure)
+- [Installation](#installation)
+- [Quick Start & Usage](#quick-start--usage)
+  - [1. Using SCSS (@use)](#1-using-scss-use)
+  - [2. Using Pre-compiled CSS](#2-using-pre-compiled-css)
+  - [3. Integration by Framework](#3-integration-by-framework)
+- [Theming (Light & Dark Mode)](#theming-light--dark-mode)
+- [Core Design Tokens](#core-design-tokens)
+- [Component & Utility Classes](#component--utility-classes)
+- [NPM Scripts](#npm-scripts)
+- [Documentation & Guidelines](#documentation--guidelines)
+- [Contributing](#contributing)
+- [Security & Credentials](#security--credentials)
+- [License](#license)
+
+---
+
+##  Overview
+
+`nnp-shared-styles` is an open-source styling library engineered to deliver a consistent look-and-feel across multi-project ecosystems. It provides:
+- **Design Tokens**: Standardized CSS custom properties for colors, typography, spacing, border radii, and component dimensions.
+- **Dynamic Theming**: Seamless runtime switching between Light and Dark modes.
+- **Layout Engines**: Flexbox helper classes, sticky headers, collapsible side navigation, and responsive content wrappers.
+- **Component Foundations**: Built-in styling for buttons, modals, accordions, cards, and third-party UI overrides (e.g., Material UI DataGrid).
+- **Client Themes**: Extensible folder structure for white-label and multi-tenant customization.
+
+---
+
+##  Key Features
+
+- ** Zero JS Dependencies**: Pure SCSS and CSS with zero JavaScript overhead.
+- ** Instant Dark Mode**: Toggle between themes effortlessly by switching the `.dark` or `.dark-theme` class.
+- ** Modular Architecture**: Import only what you need, or include the full compiled stylesheet.
+- ** Responsive & Cross-Browser**: Standardized scrollbar styling, modern autofill overrides, and flexible layouts.
+- ** Component Agnostic**: Works seamlessly with React, Angular, Vue, Svelte, or vanilla HTML/CSS.
+
+---
+
+##  Project Structure
+
+```text
+nnp-shared-styles/
+├── dist/                                # Compiled CSS production bundles
+│   ├── index.css                        # Expanded compiled CSS
+│   └── index.min.css                    # Minified compiled CSS
+├── src/                                 # SCSS source files
+│   ├── index.scss                       # Main entry point importing all shared modules
+│   ├── clients/                         # Client-specific / white-label themes
+│   │   ├── clientA-theme/               # Client A customization overrides
+│   │   └── clientB-theme/               # Client B customization overrides
+│   └── shared/                          # Core design system modules
+│       ├── common-styles.scss           # Common style definitions
+│       ├── nnp-base-styles.scss         # Typography, sizing, borders, and layout helpers
+│       ├── nnp-component-styles.scss    # UI components (buttons, nav, modals, tables)
+│       ├── nnp-mixins.scss              # Reusable Sass mixins (flex, dimensions)
+│       └── nnp-variables.scss           # CSS custom properties (colors, fonts, tokens)
+├── package.json                         # Package manifest & build scripts
+├── USER_MANUAL_AND_DEPLOYMENT_GUIDE.md  # Detailed user manual & deployment pipelines
+└── DEVELOPER_GUIDELINES.md              # Developer setup, build, and contribution guide
+```
+
+---
+
+## Installation
+
+Install the package via your preferred package manager:
+
+```bash
+# Using npm
+npm install nnp-shared-styles
+
+# Using yarn
+yarn add nnp-shared-styles
+
+# Using pnpm
+pnpm add nnp-shared-styles
+```
+
+Or install directly from the GitHub repository:
+
+```bash
+npm install git+https://github.com/Nubo-Native-Platform/PICC-PC-NNP-Shared-Styles.git#v1.1.6
+```
+
+---
+
+## Quick Start & Usage
+
+### 1. Using SCSS (@use)
+
+Import the master SCSS stylesheet directly in your project's main stylesheet (e.g., `styles.scss` or `App.scss`):
+
+```scss
+// Import the entire design system
+@use 'nnp-shared-styles/src/index.scss';
+
+// Or import specific modules individually
+@use 'nnp-shared-styles/src/shared/nnp-variables.scss';
+@use 'nnp-shared-styles/src/shared/nnp-mixins.scss' as mixins;
+@use 'nnp-shared-styles/src/shared/nnp-base-styles.scss';
+@use 'nnp-shared-styles/src/shared/nnp-component-styles.scss';
+```
+
+### 2. Using Pre-compiled CSS
+
+If your project does not use a Sass compiler, import the pre-compiled CSS bundle:
+
+```javascript
+// In your application root file (e.g., main.js, index.tsx, App.jsx)
+import 'nnp-shared-styles/dist/index.min.css';
+```
+
+Or link it directly in your HTML `<head>`:
+
+```html
+<link rel="stylesheet" href="node_modules/nnp-shared-styles/dist/index.min.css" />
+```
+
+---
+
+### 3. Integration by Framework
+
+#### React / Next.js / Vite
+```tsx
+// src/index.tsx or src/main.tsx
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import 'nnp-shared-styles/dist/index.min.css';
+import App from './App';
+
+ReactDOM.createRoot(document.getElementById('root')!).render(<App />);
+```
+
+#### Angular
+```json
+// angular.json
+"styles": [
+  "node_modules/nnp-shared-styles/dist/index.min.css",
+  "src/styles.scss"
+]
+```
+
+#### Vue.js
+```vue
+<!-- src/App.vue -->
+<style>
+@import 'nnp-shared-styles/dist/index.min.css';
+</style>
+```
+
+---
+
+## Theming (Light & Dark Mode)
+
+All color tokens are bound to CSS custom properties. By default, the root variables apply the **Light Theme**.
+
+To switch to **Dark Theme**, add either the `dark` class to `<html>` or `dark-theme` to `<body>`:
+
+```html
+<!-- Enable Dark Theme via HTML class -->
+<html class="dark">
+  ...
+</html>
+
+<!-- Or enable Dark Theme via Body class -->
+<body class="dark-theme">
+  ...
+</body>
+```
+
+### Dynamic Theme Toggle Example (JavaScript)
+
+```typescript
+function toggleDarkMode(isDark: boolean) {
+  const root = document.documentElement;
+  if (isDark) {
+    root.classList.add('dark');
+  } else {
+    root.classList.remove('dark');
+  }
+}
+```
+
+---
+
+## Core Design Tokens
+
+A snapshot of the key CSS variables available in your stylesheets:
+
+| Variable Category | CSS Variable Names | Example Default Value |
+| :--- | :--- | :--- |
+| **Typography** | `--font-family-special`, `--font-family-header`, `--font-family-body` | `Verdana, sans-serif`, `"Helvetica"` |
+| **Font Sizes** | `--font-size-xs`, `--font-size-sm`, `--font-size-nm`, `--font-size-md`, `--font-size-lg`, `--font-size-xl`, `--font-size-xxl` | `0.70rem` to `2.0rem` |
+| **Border Radii** | `--radius-small`, `--radius-medium`, `--radius-large` | `0.15rem`, `0.25rem`, `0.75rem` |
+| **Padding** | `--nnp-padding-small`, `--nnp-padding-medium`, `--nnp-padding-large` | `0.5rem`, `1rem`, `2rem` |
+| **Component Heights**| `--component-height-small`, `--component-height-medium`, `--component-height-large` | `30px`, `50px`, `150px` |
+| **Light Theme Colors** | `--base-color-primary`, `--component-color-highlight`, `--text-color-primary` | `#E8E8E8`, `#0099cc`, `#000000` |
+| **Dark Theme Colors** | `--base-color-primary`, `--component-color-highlight`, `--text-color-primary` | `#3D3D3D`, `#0099cc`, `#ffffff` |
+
+For the complete list of tokens and their values, refer to the [User Manual](USER_MANUAL_AND_DEPLOYMENT_GUIDE.md).
+
+---
+
+## Component & Utility Classes
+
+### Layout
+- `.nnp-layout-container`: Base full-height column layout.
+- `.nnp-top-header`: Standardized sticky application top navigation bar.
+- `.nnp-side-layout-container`: Flex container for side-nav + main workspace.
+- `.nnp-side-nav`: Collapsible vertical navigation sidebar with smooth animation.
+
+### Buttons
+```html
+<button class="nnp-btn nnp-btn-primary">Primary Button</button>
+<button class="nnp-btn nnp-btn-secondary">Secondary Button</button>
+<button class="nnp-btn nnp-btn-tertiary">Tertiary Button</button>
+<button class="nnp-btn nnp-btn-disabled" disabled>Disabled Button</button>
+```
+
+### Modals & Dialogs
+```html
+<div class="nnp-modal-container">
+  <div class="nnp-modal-content">
+    <div class="nnp-header nnp-header-primary">Modal Title</div>
+    <div class="nnp-modal-body">Modal Content Goes Here...</div>
+  </div>
+</div>
+```
+
+---
+
+## NPM Scripts
+
+| Command | Description |
+| :--- | :--- |
+| `npm run build` | Compiles SCSS sources to uncompressed `dist/index.css`. |
+| `npm run build:min` | Compiles and compresses SCSS to `dist/index.min.css`. |
+| `npm run build:all` | Compiles both expanded and minified production bundles. |
+| `npm run watch` | Watches SCSS source files for changes and re-compiles automatically. |
+
+---
+
+## Documentation & Guidelines
+
+- **[User Manual & Deployment Guide](USER_MANUAL_AND_DEPLOYMENT_GUIDE.md)**:
+  - Deep-dive component integration recipes.
+  - Complete CSS variable and theme catalog.
+  - Step-by-step CI/CD pipeline automation (GitHub Actions & GitLab CI).
+  - Package publishing workflows (Public npm, Private Registries, GitHub Packages).
+- **[Developer Guidelines](DEVELOPER_GUIDELINES.md)**:
+  - Developer workstation setup.
+  - SCSS coding standards, token architecture, and mixin conventions.
+  - Guide to adding new components and client themes.
+  - Contribution and pull request workflows.
+- **[Security Policy](SECURITY.md)**: Vulnerability disclosure and reporting procedure.
+- **[Changelog](CHANGELOG.md)**: Version release notes and change history.
+
+---
+
+## Contributing
+
+We welcome contributions from the community! Please check our [Developer Guidelines](DEVELOPER_GUIDELINES.md) before submitting a Pull Request.
+
+1. Fork the repository on [GitHub](https://github.com/Nubo-Native-Platform/PICC-PC-NNP-Shared-Styles).
+2. Create your feature branch (`git checkout -b feature/amazing-feature`).
+3. Commit your changes (`git commit -m 'feat: add amazing feature'`).
+4. Push to the branch (`git push origin feature/amazing-feature`).
+5. Open a Pull Request.
+
+---
+
+## Security & Credentials Policy
+
+This project strictly adheres to open-source security standards:
+- **No hardcoded secrets or credentials**: All internal URLs, tokens, passwords, and private registry endpoints have been scrubbed.
+- Use environment variables (e.g., `NPM_TOKEN`, `GITHUB_TOKEN`) when deploying or publishing packages.
+- Placeholders such as `<YOUR_ORGANIZATION>`, `<YOUR_REGISTRY_URL>`, and `<AUTH_TOKEN>` are used throughout configuration templates and documentation.
+
+---
+
+## License
+
+This project is licensed under the **Apache License**. See the [LICENSE](LICENSE) file for details.