@linear_non/stellar-libs 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,72 @@
+# stellar-libs
+
+A collection of lightweight, reusable frontend UI behavior modules — built to work seamlessly with [`stellar-kit`](https://www.npmjs.com/package/@linear_non/stellar-kit) and the [Stellar](https://github.com/nonlinearstudio/stellar) frontend system. Each library is self-contained, configurable, and designed to be dropped into modular websites.
+
+## ✨ Features
+
+- **Sticky**: Basic sticky logic for DOM elements
+- **SplitOnScroll**: Text splitting + reveal synced to scroll
+- **Smooth**: Smooth scroll instance using Virtual Scroll
+- Designed for plug-and-play usage inside Stellar Template
+- Works with `kitStore`, `Resize`, `Scroll`, `Raf`, and GSAP if needed
+
+## 📦 Installation
+
+```bash
+npm install @linear_non/stellar-libs
+```
+
+> Note: Some libraries rely on `stellar-kit` for shared events, scroll, or utilities. Be sure to install both if needed:
+
+```bash
+npm install @linear_non/stellar-kit
+```
+
+## 📁 Folder Structure
+
+```
+stellar-libs/
+├── src/
+│   ├── Sticky/             # Sticky behavior module
+│   ├── SplitOnScroll/      # Scroll-triggered text reveals
+│   ├── Smooth/             # Smooth scrolling system
+│   └── ScrollBar/          # Custom scrollbar component
+├── dev/                    # Dev playgrounds for each lib
+├── index.js                # Entry point for exports
+└── vite.config.js          # Vite config to run individual demos
+```
+
+## 🧪 Local Development
+
+```bash
+npm install
+npm run dev
+```
+
+> This launches a Vite server and scans `dev/*/index.html` to preview each module. You can open individual demos for testing.
+
+## 🛠️ Usage Example
+
+```js
+import { Sticky } from "@linear_non/stellar-libs";
+
+const sticky = new Sticky({
+  el: qs(".sticky"),
+  sticky: qs(".sticky-content"),
+});
+```
+
+> You can find usage examples in each library’s README file also an HTML markup example. You can see a live example inside the `dev/` folder.
+
+---
+
+### ✅ TODO
+
+- [ ] Implement `Marquee` module
+- [ ] Implement `Dropdown` module
+- [ ] Implement `Lenis` scroll
+- [ ] Update Readme files for each component
+
+---
+
+Made with ❤️ by [Non-Linear Studio](https://non-linear.studio)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linear_non/stellar-libs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Reusable JavaScript libraries for Non-Linear Studio projects.",
   "main": "src/index.js",
   "type": "module",
@@ -25,7 +25,7 @@
   "author": "Non-Linear Studio",
   "license": "MIT",
   "dependencies": {
-    "@linear_non/stellar-kit": "^1.0.7"
+    "@linear_non/stellar-kit": "^1.0.11"
   },
   "devDependencies": {
     "@linear_non/prettier-config": "^1.0.6",

package/src/SplitOnScroll/index.js

@@ -1,4 +1,5 @@
 import { splitText, reverseSplit } from "@linear_non/stellar-kit/utils";
+import { EVENTS } from "@linear_non/stellar-kit/events";
 import { ScrollTrigger } from "@linear_non/stellar-kit/libraries/gsap";
 
 export default class SplitonScroll {
@@ -41,9 +42,9 @@ export default class SplitonScroll {
 
   handleEnter() {
     const split = splitText(this.splitText);
-    split.on("ready", (splits) => {
+    split.on(EVENTS.APP_SPLITTEXT_READY, (splits) => {
       this.splits = [...splits];
-      this.animateCallback();
+      this.animateCallback([...splits]);
     });
   }
 

package/src/index.js

@@ -1,4 +1,5 @@
 import Sticky from "./Sticky";
 import Smooth from "./Smooth";
+import SplitonScroll from "./SplitOnScroll";
 
-export { Sticky, Smooth };
+export { Sticky, Smooth, SplitonScroll };