@columbia-libraries/cul-toolkit 5.1.3 → 5.3.0

package/README.md

@@ -2,43 +2,44 @@
 
 _Version 5.x_
 
-## Development requirements
+## Requirements
 ```
-nodejs >= v20
-npm >= 10.2
+nodejs >= v22
 ```
 
-## Vite for development
-Dev server runs on http://localhost:8181 and auto-recompiles code when resources change.
+## Development
+Start the Vite dev server:
 ```
-npm start
+npm run dev
 ```
-Preview server runs on http://localhost:4173 and serves the built dist/ dir.
+The app is available at http://localhost:5173
+
+## Preview production build
+Serve the production build locally:
 ```
 npm run preview
 ```
 
-## Vite Build Instructions
-Vite will bundle code and copy public/ files for distribution into the dist/ dir.
-```
-npm install # run the first time you want to build, or if the package-lock.json file has changed
-```
-```
+## Build
+Install dependencies and build:
+```bash
+npm install
 npm run build
 ```
+The output is written to the dist/ directory.
 
 ## Deployment requirements
 
 Local machine:
 ```
-ruby >= 2.5.3 (we currently have a .ruby-version file requiring 2.5.3)
+ruby >= 2.7.5 (we currently have a .ruby-version file requiring 2.7.5)
 bundler
 ```
 
 Remote deployment server:
 ```
-node >= 10.17.0
-yarn >= 1.19.1
+node >= 22
+npm >= 10
 ```
 ## Deploying a versioned release
 
@@ -124,7 +125,7 @@ Requirements:
 Create root `.env`:
 
 ```env
-VITE_CUL_MENU_URL=https://menus.example.com/cul-main-menu.json
+VITE_CUL_MENU_URL=https://toolkit.library.columbia.edu/v5/assets/cul-main-menu.json
 ```
 
 #### main.js
@@ -211,13 +212,13 @@ Standalone bundle:
 
 #### ES module app usage
 
-*Installation*
+##### *Installation*
 
 ```bash
 npm install @columbia-libraries/cul-toolkit
 ```
 
-*Import and usage*
+##### *Import and usage*
 
 ```js
 import '@columbia-libraries/cul-toolkit/styles';
@@ -232,7 +233,35 @@ const MENU_URL =
 makeCULmenu(MENU_URL);
 ```
 
-*Framework Notes*
+##### *Importing Individual SCSS Partials*
+
+SCSS source files are exposed enabling finer‑grained control and theming.
+
+**Important:** To ensure CUL Toolkit variable overrides work, import `_variables.scss` **before** Bootstrap's variables:
+
+```scss
+// Step 1: Bootstrap core functions
+@import "bootstrap/scss/functions";
+
+// Step 2: CUL Toolkit variables (must come before Bootstrap variables)
+@import "@columbia-libraries/cul-toolkit/src/scss/_variables";
+
+// Step 3: Bootstrap variables and core
+@import "bootstrap/scss/variables";
+@import "bootstrap/scss/bootstrap";
+
+// Step 4: Blacklight overrides (optional)
+@import "blacklight-frontend/app/assets/stylesheets/blacklight/blacklight";
+
+// Step 5: CUL Toolkit components
+@import "@columbia-libraries/cul-toolkit/src/scss/_cul";
+@import "@columbia-libraries/cul-toolkit/src/scss/_sidebars";
+```
+
+This allows you to override variables, functions, or partials before compiling with your own build pipeline (Sass, Rails asset pipeline, Webpack, Vite, etc.).
+
+
+##### *Framework Notes*
 
 	makeCULmenu(MENU_URL) manipulates DOM elements with [data-cul-menu].
 	It must be called after the elements exist in the DOM:
@@ -240,7 +269,7 @@ makeCULmenu(MENU_URL);
 	- Vue: call after app.mount() or inside onMounted() / nextTick().
 	- React: call inside useEffect(() => { ... }, []).
 
-*Vue note:*
+###### *Vue note:*
 ```js
 import { createApp, nextTick } from 'vue';
 import App from './App.vue';
@@ -260,11 +289,11 @@ onMounted(() => {
 });
 ```
 
-*React/other frameworks:*
+###### *React/other frameworks:*
 
 	Call after the component that contains [data-my-menu] has mounted.
 
-*Markup requirement*
+##### *Markup requirement*
 
 	Must include target element: <nav data-my-menu></nav>
 

package/dist/assets/cul-main-menu.json

@@ -4,10 +4,6 @@
       "href": "https://library.columbia.edu/services.html",
       "value": "Services & Tools"
     },
-    {
-      "href": "https://library.columbia.edu/services/faq.html",
-      "value": "FAQ"
-    },
     {
       "href": "https://library.columbia.edu/using-libraries/alumni.html",
       "value": "For Alumni"
@@ -78,10 +74,6 @@
       "href": "https://library.columbia.edu/libraries/math.html",
       "value": "Mathematics Library"
     },
-    {
-      "href": "https://library.columbia.edu/libraries/undergraduate.html",
-      "value": "Milstein Undergraduate Library"
-    },
     {
       "href": "https://library.columbia.edu/libraries/rbml.html",
       "value": "Rare Book & Manuscript Library"
@@ -117,17 +109,13 @@
       "value": "Collection Development"
     },
     {
-      "href": "https://library.columbia.edu/collections/digital-collections.html",
-      "value": "Digital Collections & Exhibitions"
+      "href": "https://dlc.library.columbia.edu",
+      "value": "Digital Collections"
     },
     {
       "href": "https://library.columbia.edu/collections/eresources.html",
       "value": "E-Resources"
     },
-    {
-      "href": "https://library.columbia.edu/collections/oral-history-portal.html",
-      "value": "Oral History Collections"
-    },
     {
       "href": "https://resolver.library.columbia.edu/lweb0004",
       "value": "Recommend a Title for Purchase"
@@ -177,13 +165,17 @@
       "value": "Research & Teaching"
     },
     {
-      "href": "https://copyright.columbia.edu/index.html",
-      "value": "Copyright Advisory Services"
+      "href": "https://library.columbia.edu/research-teaching/copyright.html",
+      "value": "Copyright Information"
     },
     {
       "href": "https://library.columbia.edu/research-teaching/getting-started.html",
       "value": "Getting Started with the Libraries"
     },
+    {
+      "href": "https://library.columbia.edu/research-teaching/global.html",
+      "value": "Global Studies"
+    },
     {
       "href": "https://library.columbia.edu/research-teaching/open-scholarship.html",
       "value": "Open Scholarship Services"