@nova-design-system/nova-base 3.0.0-beta.16

package/LICENSE.MD

@@ -0,0 +1,157 @@
+# End-User License Agreement: Nova Design System
+
+This End-User License Agreement ("Agreement") is entered into between:
+
+1. **Elia Group NV**
+
+Located at Keizerslaan 20, 1000 Brussel, registered at the Crossroads Bank for Enterprises in Belgium under number 0476.388.378 (hereafter: “Licensor”, “Elia”, “We”, “Our” or “Us”), and
+
+2. **Subsidiaries, Partners, or Affiliates**
+
+Collectively referred to as the "Licensee".
+
+**Licensor** and **Licensee** may both be referred to as a “Party” and jointly as the “Parties”.
+
+This Agreement can only be entered into by a party which qualifies as the “Licensee”. Any attempt by Third Parties to claim rights or licenses under this Agreement shall be considered null and void, as the Agreement is strictly limited to the Licensee, as defined herein.
+
+## Article 1: Definitions
+
+### 1.1 Affiliate
+
+A business entity related to Elia through ownership, control, or shared interests, as per Article 1:15 of the Belgian Code of Companies and Associations.
+
+### 1.2 Effective Date
+
+The date from which the Licensee accesses and downloads the Works.
+
+### 1.3 Elia Projects
+
+Initiatives, projects, or tasks directly relating to Elia’s business operations or those of Subsidiaries, Affiliates, or Partners, including development, execution, or management of services or products.
+
+### 1.4 Intellectual Property Rights
+
+Any intellectual property rights, including copyrights, trademarks, patents, and related rights worldwide.
+
+### 1.5 License
+
+As described in Article 2.1.
+
+### 1.6 Partner
+
+A business partner, subcontractor, or service provider of Elia engaged in Elia Projects.
+
+### 1.7 Subsidiary
+
+An entity directly or indirectly controlled by the Licensee, per Article 1:14 of the Belgian Code of Companies and Associations.
+
+### 1.8 Territory
+
+The entire world.
+
+### 1.9 Third Party
+
+A person or entity not defined as a Party, Subsidiary, Affiliate, or Partner of the Licensor.
+
+### 1.10 Works
+
+All elements and visuals in the UI library of the "Nova Design System", including source code and associated materials.
+
+## Article 2: Grant of License
+
+### 2.1 License Grant
+
+The **Licensor** grants the **Licensee** a non-exclusive, revocable, sublicensable, and non-transferable right to use the Works worldwide solely for Elia Projects.
+
+### 2.2 Usage Rights
+
+The usage rights include reproduction, translation, and public communication, provided the Licensee complies with the Agreement.
+
+### 2.3 Reporting Infringements
+
+Licensee must inform Licensor of any Intellectual Property infringement.
+
+## Article 3: Ownership of Intellectual Property Rights
+
+### 3.1 Ownership Retained
+
+The **Licensor** retains all ownership rights to the Intellectual Property related to the Works.
+
+### 3.2 Updates
+
+Updates may be implemented by the Licensor without prior notice. Licensee may choose whether to implement updates.
+
+## Article 4: Permitted Use and Restrictions
+
+### 4.1 Permitted Use
+
+- The Works may only be used by employees or contractors of the Licensee in Elia Projects.
+
+- Installation is restricted to devices owned or controlled by the Licensee.
+
+### 4.2 Restrictions
+
+The Works must not be:
+
+- Shared, sublicensed, or otherwise transferred to Third Parties.
+
+- Reverse-engineered, decompiled, or disassembled.
+
+## Article 5: Liability and Disclaimer of Warranties
+
+### 5.1 Disclaimer
+
+The Works are provided "as is", without warranty of any kind. The **Licensor** disclaims all implied warranties.
+
+### 5.2 Limitation of Liability
+
+The **Licensor** limits its liability to €1,000. The Licensee assumes all risks related to the use of the Works.
+
+## Article 6: Term and Termination
+
+### 6.1 Initial Term
+
+The Agreement is effective indefinitely from the Effective Date unless terminated.
+
+### 6.2 Termination by Notice
+
+Either Party may terminate with one month's written notice.
+
+### 6.3 Automatic Termination
+
+Termination occurs automatically upon:
+
+- Changes in control, ownership, or project participation.
+
+- Breach of material terms by the Licensee, following written notice.
+
+### 6.4 Post-Termination Obligations
+
+Upon termination, the **Licensee** must cease using and destroy all copies of the Works.
+
+## Article 7: Miscellaneous
+
+### 7.1 Waiver
+
+Waivers must be in writing and do not constitute ongoing waivers of similar rights.
+
+### 7.2 Costs
+
+Each Party bears its own implementation costs.
+
+### 7.3 Assignment
+
+The Agreement may not be assigned without prior consent from the **Licensor**.
+
+### 7.4 Severability
+
+Invalid provisions will not affect the remainder of the Agreement.
+
+## Article 8: Governing Law and Jurisdiction
+
+### 8.1 Governing Law
+
+This Agreement is governed by Belgian law.
+
+### 8.2 Jurisdiction
+
+The Dutch-speaking courts of Brussels have exclusive jurisdiction for disputes.

package/README.md

@@ -0,0 +1,94 @@
+# Nova Components Base
+
+The Nova Components Base package provides essential tokens and precompiled CSS for the Nova Design System. It aims to streamline the use of Nova’s design tokens and offer flexibility in customizing the setup with Tailwind CSS.
+
+## Features
+
+- **Precompiled CSS:** A simple css file tailored with Nova’s design theme and a collection of utilities. Ideal for quick integration.
+- **Tokens:** Design tokens defined by the Nova Design.
+- **Tailwind Theme and Plugin:** Configure your own Tailwind CSS setup with the Nova theme and plugin, eliminating the need for the precompiled CSS and significantly reducing CSS size.
+
+---
+
+## Installation
+
+```bash
+npm install @nova-design-system/nova-base
+```
+
+## Usage
+
+### Include Tokens CSS
+
+Include the tokens CSS in your project (two themes are available: Spark and Ocean):
+
+```css
+/* For the Spark theme */
+@import '@nova-design-system/nova-base/dist/css/spark.css';
+
+/* Or, for the Ocean theme */
+@import '@nova-design-system/nova-base/dist/css/ocean.css';
+```
+
+### Recommended Approach: Using Tailwind CSS with Nova Theme and Plugin
+
+The recommended approach is to set up Tailwind CSS and use our tokens, `novaTailwindTheme`, and `novaTailwindPlugin` for the Tailwind configuration. This method provides a smaller CSS bundle and access to more utilities than the precompiled CSS.
+
+#### Prerequisites
+
+Ensure that Tailwind CSS is installed in your project. If not, you can install it by following the [Tailwind CSS installation guide](https://tailwindcss.com/docs/installation).
+
+#### Tailwind Configuration
+
+After setting up Tailwind CSS, add the following to your `tailwind.config.js`:
+
+```js
+import {
+  novaTailwindTheme,
+  novaTailwindPlugin,
+} from '@nova-design-system/nova-base/theme';
+
+/** @type {import('tailwindcss').Config} */
+export default {
+  // ...
+  theme: novaTailwindTheme,
+  plugins: [novaTailwindPlugin],
+};
+```
+
+The `novaTailwindTheme` maps our CSS variable tokens to utilities, ensuring consistent styling across your project. The `novaTailwindPlugin` adds additional base styles, components, and utilities.
+
+#### Importing Theme Tokens in CSS
+
+In your CSS file, along with the default Tailwind imports, you should import the tokens for the theme:
+
+```css
+/* Import the theme tokens */
+@import '@nova-design-system/nova-base/dist/css/spark.css';
+
+/* Tailwind CSS imports */
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+/* Or, for the Ocean theme */
+/* @import '@nova-design-system/nova-base/dist/css/ocean.css'; */
+```
+
+#### Benefits of Using Tailwind CSS with Nova Theme and Plugin
+
+- **Smaller CSS Bundle:** By configuring Tailwind CSS with our theme and plugin, you eliminate unused styles, resulting in a significantly smaller CSS file.
+- **More Utilities:** Gain access to a wider range of utilities beyond those included in the precompiled CSS.
+- **Customization:** Tailwind CSS allows you to customize and extend your styles as needed.
+
+### Alternative Approach: Using Precompiled CSS
+
+If it's not possible to set up Tailwind CSS in your project, you can include the precompiled CSS along with the tokens:
+
+```js
+import '@nova-design-system/nova-base/dist/css/spark.css';
+// or import '@nova-design-system/nova-base/dist/css/ocean.css';
+import '@nova-design-system/nova-base/dist/css/nova-utils.css';
+```
+
+**Note:** The precompiled CSS includes a whitelist of Tailwind classes and is quite large. This approach is only recommended if you cannot set up Tailwind CSS yourself.