dolphincss
v1.4.6
Published
DolphinCSS - World-class TailwindCSS + React component library
Maintainers
Readme
DolphinCSS combines component generation with utility-first CSS. It provides TailwindCSS-style utilities with Bootstrap-like semantic classes, plus a Vite plugin for automatic component code generation.
⚡ Core Features
1. 🪄 Automatic Component Generation
Generate component code directly in your files without CLI commands. The Vite plugin detects marker classes and replaces them with full implementation:
// Write this:
<div className="dolphin-card"></div>
// Save file (Ctrl+S)
// Plugin generates:
<div className="glass card p-6 border border-white/20 rounded-2xl max-w-sm hover:shadow-xl hover:-translate-y-1 transition-all duration-300 relative overflow-hidden" style={{ backdropFilter: 'blur(20px)' }}>
{/* Customizable component code */}
</div>2. 🌐 Semantic Utility Classes
Semantic classes that combine multiple utilities for common patterns:
// Standard approach
<button className="px-6 py-2 bg-blue-500 hover:bg-blue-600 text-white font-bold rounded-lg shadow-lg shadow-blue-500/50 transition-all">
Click
</button>
// DolphinCSS approach
<button className="filled primary-500 glow btn-lg">
Click
</button>3. 🧩 Composable Classes
Classes designed to work together without conflicts:
<button className="filled success gradient glow glow-pulse rounded-full">
Animated Gradient Button
</button>
<div className="overlay overlay-blur-xl overlay-dark-50"></div>4. 🎬 Built-in Animations
Animation utilities included without additional libraries:
- Continuous:
float,spin-slow,pulse,bounce,shimmer,gradient-flow,neon-flicker - Hover:
hover-pulse,hover-jelly,hover-glow,hover-ripple - Entrance:
fade-in,slide-up,zoom-in,rotate-3d - Controls:
delay-200,duration-500
<img src="logo.png" className="float hover-jelly fade-in delay-200" />⚙️ Installation & Setup
- Install via npm:
npm install tailwindcss @tailwindcss/vite dolphincss lucide-react(Note: lucide-react is required because the generated magic components use these beautiful icons by default.)
- Add the Plugins: (In
vite.config.js)
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import tailwindcss from '@tailwindcss/vite'
import dolphincssPlugin from 'dolphincss/vite-plugin'
export default defineConfig({
plugins: [react(), tailwindcss(), dolphincssPlugin()]
})- Import Styles: (In your main
main.jsxorindex.css)
import 'dolphincss/dolphin-css.css';🧠 VS Code IntelliSense — Auto Extension Install via Marker
DolphinCSS IntelliSense can be automatically installed into VS Code using a single magic marker — no marketplace search, no manual download needed.
✨ How it works
Just add the vscode-init marker anywhere in your JSX/TSX component and save the file:
// In any component file (e.g., App.jsx)
export default function App() {
return (
<div>
{/* 🐬 Add this ONE line — remove it after first run */}
<div className="vscode-init" style={{display:'none'}}></div>
{/* rest of your app */}
</div>
)
}When the Vite dev server (npm run dev) detects this marker, it automatically:
- 📥 Downloads the DolphinCSS IntelliSense extension (
.vsix) directly from GitHub - ⚡ Installs it into VS Code via
code --install-extension - 🗂️ Creates
.vscode/dolphin-tags.jsonwith 1,269 CSS class suggestions - ⚙️ Updates
.vscode/settings.jsonwithhtml.customDatafor HTML autocomplete - 📌 Adds extension recommendation to
.vscode/extensions.json - 🗑️ Removes the
vscode-initclass from your file automatically
Then simply reload your VS Code window:
Ctrl + Shift + P → "Reload Window"After reload, you'll get:
- ✅ 1,269 DolphinCSS class suggestions in
className=""/class="" - ✅ 51
dolphin-*marker suggestions when you typedolphin- - ✅ Works in JSX, TSX, HTML, Vue, Svelte, Astro files
🔧 Manual Install (Alternative)
If auto-install didn't work (e.g., code CLI not in PATH), install manually:
Option A — VS Code Marketplace:
Search DolphinCSS IntelliSense in the Extensions panel (Ctrl+Shift+X).
Option B — Direct VSIX download:
# Download and install the extension from GitHub Releases
curl -L -o dolphincss-intellisense.vsix https://github.com/Phuyalshankar/dolphincss-vscode-/releases/download/v0.1.0/dolphincss-intellisense-0.1.0.vsix
code --install-extension dolphincss-intellisense.vsix🧹 Cleanup
When you no longer need the VS Code helpers, remove them cleanly:
npx dolphin-cleanup- Removes only DolphinCSS files from
.vscode/ - Removes the
html.customDataentry from.vscode/settings.json - Keeps your own VS Code settings and other
.vscodefiles untouched
🛜 Offline & CDN Usage
For static HTML pages or offline projects, you can use the minified files directly without npm/Node.js setup.
1. CDN Links (jsDelivr)
Include these links directly in your HTML for zero-install setup:
- CSS (Global Styles & Animations):
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/dolphincss@latest/dolphin-css.css"> - JS (Vanilla Utility Builder):
<script src="https://cdn.jsdelivr.net/npm/dolphincss@latest/src/ub-vanilla.js"></script>
📥 Direct File Downloads (One-Click)
Click the buttons below to download the latest files directly:
(For Markdown/GitHub compatibility, you can also use these badges:)
2. Download Commands (For Offline Usage)
Run these commands in your project folder to download the files locally:
Using curl:
# Download CSS
curl -o dolphin-css.min.css https://cdn.jsdelivr.net/npm/dolphincss@latest/dolphin-css.css
# Download Vanilla Utility Builder JS
curl -o ub-vanilla.min.js https://cdn.jsdelivr.net/npm/dolphincss@latest/src/ub-vanilla.jsUsing wget:
# Download CSS
wget -O dolphin-css.min.css https://cdn.jsdelivr.net/npm/dolphincss@latest/dolphin-css.css
# Download Vanilla Utility Builder JS
wget -O ub-vanilla.min.js https://cdn.jsdelivr.net/npm/dolphincss@latest/src/ub-vanilla.js3. How to Setup & Use Locally (Offline)
A. Static HTML Setup
Once you have downloaded dolphin-css.min.css and ub-vanilla.min.js, link them locally in your index.html file:
<!DOCTYPE html>
<html lang="en" data-theme-mode="dark" data-theme="dolphin">
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="./dolphin-css.min.css">
</head>
<body>
<!-- Use magic markers to be injected later -->
<div class="dolphin-card"></div>
<script type="module">
import { ub, map } from './ub-vanilla.min.js';
// Use ub engine for dynamic runtime styling
</script>
</body>
</html>B. Offline Component Injection
When working offline (without an internet connection), component injection still works seamlessly:
- Using Vite Plugin (React/Vue/etc.): The
vite-plugin-dolphincssautomatically loads templates locally from thenode_modules/dolphincss/core-templates/directory. No internet connection is needed to parse and expand markers like<div className="dolphin-card"></div>. - Using CLI Watcher (Plain HTML/Other projects): Start the watcher offline:
The watcher will attempt to sync with the remote repository. After failing to connect, it will automatically fallback to Local Mode. It will watch your files and expand markers (e.g.npx dolphincss-template # OR node node_modules/dolphincss/bin/dolphin.jsdolphin-cardto full HTML/JSX) using the offline templates stored locally in your package.
C. Zero-Install / CDN Component Injection (Online)
If you are using DolphinCSS via CDN links and do not want to install dolphincss locally in your project, you can still use the magic component generator:
- Include the jsDelivr CDN links in your static HTML file.
- Put any magic marker class (e.g.,
<div class="dolphin-card"></div>) in your HTML code. - Start the watcher directly from npm without installing the package:
npx dolphin-template # OR (if package is not installed) npx --package=dolphincss dolphin-template - Save your HTML file. The watcher will dynamically fetch the component templates from GitHub and inject them directly into your local file!
🧠 Dynamic Runtime Styling Engine (dolphincss/ub)
The ub (Utility Builder) engine generates OKLCH color shades and dynamic styles at runtime with browser-native performance.
Suitable for IoT dashboards, analytics, real-time data visualization, and applications requiring dynamic styling based on runtime values.
🎯 Universal map() Function
Maps any input range to the 0-255 scale system used by DolphinCSS:
import { ub, map } from 'dolphincss/ub';
// Color mapping
map(temp, 0, 50, 'red') // → 'red-142'
// Multi-color gradients
map(battery, 0, 100, ['red', 'orange', 'green'])
// Dimensions
map(500, 0, 1000, 'w') // → 'w-128' → 512px
// Spacing
map(20, 0, 40, 'p') // → 'p-128' → 512px
// Effects
map(50, 0, 100, 'opacity') // → 'opacity-128' → 50%Example: IoT Sensor Dashboard
function SensorDashboard({ sensors }) {
return (
<div className="grid grid-cols-3 gap-4">
<div className={ub(
'card p-6 text-4xl font-bold',
map(sensors.temp, -10, 50, ['blue', 'green', 'orange', 'red'])
)}>
🌡️ {sensors.temp}°C
</div>
<div className={ub(
'card p-6',
map(sensors.battery, 0, 100, ['red', 'orange', 'green'])
)}>
🔋 {sensors.battery}%
</div>
</div>
);
}Example: Dynamic Charts
function BarChart({ data }) {
const maxValue = Math.max(...data.map(d => d.value));
return (
<div className="flex items-end gap-2 h-64">
{data.map((item, i) => (
<div
key={i}
className={ub(
'rounded-t-xl transition-all',
map(item.value, 0, maxValue, 'h'),
map(item.value, 0, maxValue, ['red', 'orange', 'green'])
)}
/>
))}
</div>
);
}Technical Details
Performance:
- Pre-generating all 256 shades × 9 colors with variants would create 400,000+ CSS classes (40MB+)
- Runtime generation keeps core CSS at 319KB while providing access to all shades on-demand
- LRU caching: 2,000 class entries, 500 color combinations
- Cache performance: 0.001ms hits, 0.1ms misses, 85-95% hit rate
- Uses Constructable Stylesheets API for native browser rendering
Features:
- Dynamic OKLCH color generation (0-255 scale)
- Automatic text contrast calculation
- Multi-color gradient support with auto-distribution
- Custom color stops
- Works with standard CSS properties (width, height, padding, margin, opacity, scale)
- Compatible with responsive variants (
lg:) and pseudo-states (hover:) - TypeScript definitions included
⚙️ How to Import
import {
// Core
ub, debugUB, clearUBCache, oklch,
// Spacing
p, pt, pb, pl, pr,
m, mt, mb, ml, mr,
w, h, scale,
// Border / Shadow / Rounded / Opacity
border, borderT, borderR, borderB, borderL, borderX, borderY,
rounded, shadow, opacity,
// Color helpers
bg, text,
// Gradient helpers
gradient, gradientAngle, gradientVertical, gradientHorizontal,
gradientRadial, gradientTriple,
// Layout helpers
grid, autoGrid, autoLayout, span, row,
// Animation helpers
animate, widthAnim, heightAnim, paddingAnim, marginAnim,
bgAnim, opacityAnim, roundedAnim, scaleAnim,
infiniteAnim, clickAnim, bgFill,
// Shorthand objects
btn, input, card,
// IoT data mapping
map,
} from 'dolphincss/ub';🎯 Universal map() Function API
The map() function provides a unified interface for mapping any value range to the 0-255 scale system:
// Function signature
map(value: number, min: number, max: number, config?: string | string[] | ColorStop[]): string | number
// Examples
map(50, 0, 100) // → 128 (raw normalized value)
map(28, 0, 50, 'red') // → 'red-142'
map(75, 0, 100, ['red', 'orange', 'green']) // → 'green-191'
map(500, 0, 1000, 'w') // → 'w-128'
map(20, 0, 40, 'p') // → 'p-128'
map(50, 0, 100, 'opacity') // → 'opacity-128'Supported Properties:
- Colors: Any color name (
red,blue,green,purple,orange,pink,teal,amber,gray) - Dimensions:
w,h,width,height - Spacing:
p,pt,pb,pl,pr,m,mt,mb,ml,mr,gap - Effects:
opacity,scale,border
Multi-Color Gradients:
// 2 colors
map(value, 0, 100, ['red', 'green'])
// 3+ colors (auto-distributed)
map(value, 0, 100, ['blue', 'purple', 'pink', 'red'])
// Custom stops
map(value, 0, 100, [
{ at: 0, color: 'blue' },
{ at: 128, color: 'purple' },
{ at: 255, color: 'red' }
])🪄 Core Features
1. Dynamic OKLCH Shading (0-255 Scale)
Generate arbitrary, dynamically computed color shades and gradients on the fly:
// 128 starts a medium red, 255 ends a very dark blue
<div className={ub("card glass gradient-red-128-blue-255 p-6 rounded-2xl")}>
I am a mathematically perfect gradient!
</div>
// You can feed it dynamic states or sliders:
<div className={ub(`card bg-blue-${volumeLevel} p-4 text-center`)}>
Volume Level: {Math.round((volumeLevel/255)*100)}%
</div>2. Auto-Inversion Text Contrast
You never have to manually adjust text color when background colors change. The ub engine dynamically parses the OKLCH lightness (L) and average hue (H) of the background, and automatically applies high-contrast light or dark text color (oklch(...) !important) to guarantee perfect readability!
3. Ultra-Fast LRU Class Caching
The engine includes a double-layer LRU Cache (caches compiled color codes and class list parses). If a class (even a standard static CSS class like transition-all or p-4) is evaluated again, the engine returns it instantly in O(1) time with 0ms latency, preventing redundant browser style recalculations and regex parses.
4. Dynamic Transitions & Animations
Define dynamically timed transitions in JSX:
// Fills background color from left to red-128 in 500ms
className={ub("card bg-fill-left-red-128-500ms")}5. Dynamic Sizing with Custom CSS Units
You are no longer limited to pixel-based sizes like w-4 (16px). You can now supply arbitrary values with custom CSS units (like %, px, rem, em, vh, vw) directly in your utility classes:
w-58%➔ generateswidth: 58% !important;w-12.5rem➔ generateswidth: 12.5rem !important;h-50vh➔ generatesheight: 50vh !important;This eliminates the need for inline style mapping likestyle={{ width:${val}%}}!
6. Smart Fallback Background Shading
For IoT and quick data mappings, you can omit the bg- prefix when utilizing color shades. The engine automatically fallbacks to background shading if a raw color shade is provided:
ub(map.heat(load, 0, 100))➔ outputsub-xxxxwhich appliesbackground: oklch(...) !important;ub("red-128")➔ defaults to background styling for"bg-red-128".
7. Self-Healing Connection (Vite HMR Safety)
Modern dev servers with Hot Module Replacement (HMR) can dynamically refresh components and clear document.adoptedStyleSheets. The ub engine has built-in connection checking that automatically detects stylesheet disconnection and re-attaches itself instantly to keep real-time UI values active and styled correctly.
📖 Complete ub Class Syntax Reference
🎨 Colors
bg-{color}-{shade} → background color (e.g. bg-blue-128)
bg-{color}-{shade}/{opacity} → with opacity (e.g. bg-blue-128/50)
text-{color}-{shade} → text color (e.g. text-red-200)
border-{color}-{shade} → border color (e.g. border-green-100)Colors: red blue green purple orange pink teal amber gray
Shade: 0–255 (0 = lightest, 255 = darkest)
📐 Spacing
p-{n} pt-{n} pb-{n} pl-{n} pr-{n} → padding (n × 4px)
m-{n} mt-{n} mb-{n} ml-{n} mr-{n} → margin (n × 4px)
w-{n} h-{n} → size (n × 4px)
scale-{n} → CSS scale transform
opacity-{n} → opacity 0–100🔲 Border, Shadow, Rounded
border → 1px solid border
border-{n} → n px border
border-t-{n} border-b-{n} border-l-{n} border-r-{n} → single side
border-x-{n} border-y-{n} → horizontal / vertical
rounded-{n} → border-radius (e.g. rounded-2)
rounded-full → border-radius: 9999px
shadow-{1–10} → box-shadow scale📦 Flexbox / Grid
flex-center flex-between flex-left flex-right
flex-around flex-evenly flex-start flex-end flex-stretch
flexcol-center flexcol-between flexcol-left flexcol-right
grid-{cols}x{rows}-{gap} → explicit grid
auto-grid-{minWidth}-{gap} → auto-fit grid
auto-layout-{row|col|wrap}-{align}-{gap}
span-{n} → grid-column: span n
row-{n} → grid-row: span n
full → grid-column: 1 / -1🌈 Gradients
gradient-{c1}-{s1}-{c2}-{s2} → 135deg gradient
gradient-{angle}deg-{c1}-{s1}-{c2}-{s2} → custom angle
gradient-vert-{c1}-{s1}-{c2}-{s2} → top to bottom
gradient-horiz-{c1}-{s1}-{c2}-{s2} → left to right
gradient-radial-{c1}-{s1}-{c2}-{s2} → radial
gradient-{c1}-{s1}-{c2}-{s2}-{c3}-{s3} → 3-color gradient🃏 Component Shorthands
// Buttons
className={ub(btn.primary)} // → "btn btn-primary"
className={ub(btn.danger)} // → "btn btn-danger"
className={ub(btn.ghost)} // → "btn btn-ghost"
className={ub(btn.glow)} // → "btn btn-glow"
// Also: btn.sm btn.md btn.lg btn.secondary btn.success btn.warning btn.outline
// Inputs
className={ub(input.base)} // → "input"
className={ub(input.error)} // → "input input-error"
// Also: input.sm input.md input.lg input.success
// Cards
className={ub(card.glass)} // → "card card-glass"
className={ub(card.hover)} // → "card card-hover"
className={ub(card.click)} // → "card card-click card-hover"🎬 Animations
// Property animation (from → to in Nms)
{prop}-{from}-{to}-{N}ms → one-shot
{prop}-{from}-{to}-{N}ms-infinite → loops forever
hover:{prop}-{from}-{to}-{N}ms → triggers on hover
click:{prop}-{from}-{to}-{N}ms → triggers on click
// Examples:
w-10-50-300ms → width 40px → 200px in 300ms
scale-50-110-200ms → scale 0.5 → 1.1 in 200ms
opacity-0-100-400ms → fade in
p-2-8-250ms → padding grow
rounded-2-full-300ms → pill animation
// Background fill sweep
bg-fill-left-red-128-500ms → fills red from left in 500ms
bg-fill-right-blue-200-800ms → fills blue from right in 800ms
bg-fill-top-green-100-600ms
bg-fill-bottom-purple-150-400ms
// Color animation (bg or text)
bg-blue-50-200-500ms → bg transitions shade 50→200 in 500ms
bg-red-100-255-1000ms-infinite → loops forever
text-green-128-255-300ms → text color animates🎯 Variants (Prefix Modifiers)
hover:{class} → applies on hover (e.g. hover:scale-110)
active:{class} → applies on active
focus:{class} → applies on focus
// Responsive breakpoints
sm:{class} → min-width: 640px
md:{class} → min-width: 768px
lg:{class} → min-width: 1024px
xl:{class} → min-width: 1280px
2xl:{class} → min-width: 1536px
// Combine prefix + class
lg:flex-center
hover:bg-blue-200
sm:p-2 lg:p-8🔧 Helper Functions (JS API)
import { bg, text, gradient, gradientVertical, gradientHorizontal,
gradientRadial, gradientAngle, gradientTriple,
widthAnim, heightAnim, bgAnim, scaleAnim,
opacityAnim, roundedAnim, infiniteAnim } from 'dolphincss/ub';
// Color helpers
bg('blue', 128) // → "bg-blue-128"
bg('red', 200, 50) // → "bg-red-200/50" (with opacity)
text('green', 100) // → "text-green-100"
// Gradient helpers
gradient('blue', 100, 'purple', 200) // → "gradient-blue-100-purple-200"
gradientVertical('red', 128, 'orange', 200) // → "gradient-vert-red-128-orange-200"
gradientHorizontal('teal', 100, 'blue', 200) // → "gradient-horiz-teal-100-blue-200"
gradientRadial('pink', 100, 'purple', 200) // → "gradient-radial-pink-100-purple-200"
gradientAngle(45, 'blue', 100, 'green', 200) // → "gradient-45deg-blue-100-green-200"
gradientTriple('red',100,'blue',150,'purple',200) // → 3-stop gradient
// Animation helpers
widthAnim(10, 50, 300) // → "w-10-50-300ms"
heightAnim(20, 80, 500) // → "h-20-80-500ms"
scaleAnim(50, 110, 200) // → "scale-50-110-200ms"
opacityAnim(0, 100, 400) // → "opacity-0-100-400ms"
roundedAnim(2, 16, 300) // → "rounded-2-16-300ms"
bgAnim('blue', 50, 'blue', 200, 500) // → "bg-blue-50-blue-200-500ms"
infiniteAnim('scale', 90, 110, 1000) // → loops forever🛠️ Debug & Cache
import { debugUB, clearUBCache } from 'dolphincss/ub';
console.log(debugUB());
// → { classCache: 42, styleCount: 38, totalRequests: 150,
// cacheHits: 108, totalSegmentRequests: 210, version: 'v19.0.3' }
clearUBCache(); // Flush all cached styles (useful after theme change)🚀 Available Magic Components
Type any of these magic markers in your .jsx or .tsx file, hit save, and watch the code generate instantly:
<div className="dolphin-form-floating"></div>(Beautiful Floating Label Form)<div className="dolphin-form-standard"></div>(Minimalist Standard Label Form)<div className="dolphin-table"></div>(Responsive Data Table)<div className="dolphin-toast"></div>(Notification Toast)<div className="dolphin-modal"></div>(Native HTML Dialog Modal)<div className="dolphin-button"></div>(Button Variants Showcase)<div className="dolphin-card"></div>(Glassmorphic Profile Card)<div className="dolphin-grid"></div>(Responsive Product/Car Grid)<div className="dolphin-navbar"></div>(Sleek Navigation Bar)<div className="dolphin-header"></div>(Modern Header/Navbar)<div className="dolphin-footer"></div>(Premium Footer Section)<div className="dolphin-alert"></div>(Modern Alert Box)<div className="dolphin-badge"></div>(Status Badges)<div className="dolphin-hero"></div>(Stunning Landing Page Hero)<div className="dolphin-pricing"></div>(Premium Pricing Tables)<div className="dolphin-timeline"></div>(Vertical Activity Timeline)<div className="dolphin-chat"></div>(Modern Messaging Interface)<div className="dolphin-carousel"></div>(Interactive Image Slider)<div className="dolphin-dropzone"></div>(Drag & Drop File Upload)<div className="dolphin-rating"></div>(Interactive 5-Star Rating)<div className="dolphin-steps"></div>(Progress Stepper)<div className="dolphin-pagination"></div>(Page Navigation Controls)<div className="dolphin-drawer"></div>(Off-canvas Glass Sidebar)<div className="dolphin-breadcrumbs"></div>(Navigation Trail)
🎭 The Power of Variants (fx-*)
DolphinCSS ships with world-class, pre-built global variants. Instead of writing 15 Tailwind utility classes to create a glassmorphism effect, just use one class!
🌟 Premium Effects
Combine these on any div, card, or container:
- fx-glass (Classic Frosted Glass)
- fx-crystal (Ultra-clear Crystal Border)
- fx-neon (Cyberpunk Neon Glow)
- fx-holo (Holographic Matrix)
- fx-flare (Solar Flare Gradient)
- fx-cyber (Cyberpunk Aesthetic)
- fx-nebula (Galactic Nebula Depth)
- fx-metal (Liquid Mercury)
- fx-aurora (Frosted Aurora)
- fx-float (Quantum Float on Hover)
🔥 Advanced Glows & Animations
Bring your UI to life instantly:
- glow (Standard Hover Glow)
- glow pulse (Continuous Pulsing Glow)
- glow wave (Ocean Wave Animation)
🎨 Global Colors & Buttons
Propagate theme colors cleanly:
<button className="filled primary px-6 py-2 glow wave">Primary Action</button>
<button className="outlined success px-6 py-2">Success Outline</button>
<button className="plain danger px-6 py-2">Danger Plain</button>
{/* Perfect Circle Icons */}
<button className="circle lg fx-aurora glow wave">
<Icon />
</button>🌐 Auto-Push Marker & Sync Engine (Cloud UI Bank)
DolphinCSS includes a revolutionary Bi-directional Cloud Sync Engine that lets you register, update, inject, and delete custom components directly from your code workspace, with absolute framework portability (React, Svelte, Vue, PHP, HTML, Django).
⚙️ Setup configuration (dolphin.config.json)
Create a dolphin.config.json file in your project root to authenticate with the Cloud UI Bank:
{
"pushUrl": "http://localhost:3000/api/templates/push",
"secretKey": "dolphin-admin-2025",
"username": "john_dev",
"author": "John Shrestha"
}- First-time setup: Use the global secret key (
dolphin-admin-2025). The server will automatically register your username profile, generate a unique developer-specific API token, and the plugin/watcher will auto-save it back into yourdolphin.config.jsonunder"secretKey"!
🛠️ Advanced Code Markers (State Actions)
Simply write these CSS classes on your container tags and press Save (Ctrl + S). The dev server / watcher handles the synchronization instantly:
1. 📤 Publish / Create (dolphin-push--[name]--[variant])
Uploads the local component code and metadata to the Cloud UI Bank.
<div class="dolphin-push--my-card--glass" data-version="1.0.0" data-category="cards" data-tags="auth,glass">
<h3>Card Title</h3>
<p>Content...</p>
</div>- On Save: Pushes component markup and renames class to
dolphin-pushed--my-card--glass.
2. 🔄 Update / Replace (dolphin-put-- or dolphin-patch--)
Performs updates to component settings and code on the server.
<div class="dolphin-patch--my-card--glass" data-version="1.1.0" data-tags="auth,glass,v2">
<h3>Card Title (Updated)</h3>
<p>Content...</p>
</div>- On Save: Syncs modifications to the DB and renames class to
dolphin-patched--my-card--glass.
3. 📥 Pull / Inject (dolphin-inject--[name]--[variant])
Downloads the template markup from the server database and embeds it directly inside your local tag.
<div class="dolphin-inject--my-card--glass"></div>- On Save: Inserts the formatted markup and renames class to
dolphin-injected--my-card--glass.
4. 🗑️ Delete (dolphin-delete--[name]--[variant])
Deletes the component from the cloud database.
<div class="dolphin-delete--my-card--glass">...</div>- On Save: Removes the remote component and renames class to
dolphin-deleted--my-card--glass.
👨💻 Developer Dashboard (/dashboard)
Log in to the Web Portal Dashboard using your username and credentials to manage your creations visually:
- Live Iframe Preview: Inspect how your templates render in an isolated, dark-themed ocean HSL glassmorphism environment.
- PrismJS Code Viewer: Read and copy raw component code with a single click.
- Component CRUD: Edit metadata, category, version, privacy toggle (
isPublic), and premium tier (isPremium). - Developer API Token: Copy your personal API token from the sidebar to authorize other local workspaces.
Built with ❤️ in Nepal. Ready for the future of UI development.
