awwwards-ui-skill 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/bin/cli.js +36 -0
- package/package.json +15 -0
- package/plugin.json +9 -0
- package/skills/awwwards_ui_design/SKILL.md +65 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Awwwards UI/UX Agent Skill
|
|
2
|
+
|
|
3
|
+
An open-source skill that empowers AI assistants (Antigravity, Codex, Claude Code CLI) to design stunning, award-winning web interfaces. This skill bridges the gap between functional AI code generation and high-end, premium web design.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
- **Triggers Automatically:** Reacts to prompts containing "cool ui", "amazing ui", "premium design", etc.
|
|
7
|
+
- **Awwwards Philosophy:** Instructs the AI on using WebGL (Three.js), smooth scrolling (Lenis/GSAP), and advanced typography.
|
|
8
|
+
- **Vercel Accessibility First:** Ensures that all generated UIs strictly adhere to WCAG and Vercel's Web Interface Guidelines (semantic HTML, ARIA, high contrast, reduced motion support).
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
### For Antigravity
|
|
13
|
+
Clone this repository into your plugins directory:
|
|
14
|
+
```bash
|
|
15
|
+
git clone https://github.com/yourusername/awwwards-ui-skill.git ~/.gemini/config/plugins/awwwards-ui-skill
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### For Claude Code / Codex
|
|
19
|
+
Copy the `skills/awwwards_ui_design/SKILL.md` file and incorporate it into your custom system prompts or skill registry.
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
Simply ask your AI assistant:
|
|
23
|
+
> "Build me a portfolio website with a cool ui"
|
|
24
|
+
|
|
25
|
+
The agent will automatically read this skill and implement advanced animations, 3D backgrounds, and fully accessible markup.
|
package/bin/cli.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const fs = require('fs');
|
|
4
|
+
const path = require('path');
|
|
5
|
+
|
|
6
|
+
console.log("🚀 Installing Awwwards UI/UX Agent Skill...");
|
|
7
|
+
|
|
8
|
+
const skillSourcePath = path.join(__dirname, '../skills/awwwards_ui_design/SKILL.md');
|
|
9
|
+
const targetDirs = [
|
|
10
|
+
path.join(process.cwd(), '.gemini/config/plugins/awwwards_ui_design'),
|
|
11
|
+
path.join(process.cwd(), '.claude/skills'),
|
|
12
|
+
path.join(process.cwd(), '.codex/skills')
|
|
13
|
+
];
|
|
14
|
+
|
|
15
|
+
let installed = false;
|
|
16
|
+
|
|
17
|
+
for (const dir of targetDirs) {
|
|
18
|
+
if (!fs.existsSync(dir)) {
|
|
19
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const targetPath = path.join(dir, 'SKILL.md');
|
|
23
|
+
try {
|
|
24
|
+
fs.copyFileSync(skillSourcePath, targetPath);
|
|
25
|
+
console.log(`âś… Successfully installed skill to ${targetPath}`);
|
|
26
|
+
installed = true;
|
|
27
|
+
} catch (e) {
|
|
28
|
+
console.error(`❌ Failed to install to ${dir}: ${e.message}`);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
if (installed) {
|
|
33
|
+
console.log("🎉 You're all set! Tell your AI agent to build a 'cool ui' and watch the magic happen.");
|
|
34
|
+
} else {
|
|
35
|
+
console.log("⚠️ Could not automatically detect agent directories. You may need to copy the SKILL.md manually.");
|
|
36
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "awwwards-ui-skill",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "An open-source skill that empowers AI assistants (Antigravity, Codex, Claude Code CLI) to design stunning, award-winning web interfaces. This skill bridges the gap between functional AI code generation and high-end, premium web design.",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"awwwards-ui-skill": "./bin/cli.js"
|
|
8
|
+
},
|
|
9
|
+
"scripts": {
|
|
10
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
11
|
+
},
|
|
12
|
+
"keywords": [],
|
|
13
|
+
"author": "",
|
|
14
|
+
"license": "ISC"
|
|
15
|
+
}
|
package/plugin.json
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: awwwards-ui-design
|
|
3
|
+
description: Use when the user requests "cool ui", "amazing ui", or premium, award-winning Awwwards-style UI designs. Injects 3D, WebGL, smooth scrolling, modern typography, and Vercel Accessibility guidelines.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Awwwards UI/UX Design Philosophy
|
|
7
|
+
|
|
8
|
+
You are an expert Frontend Designer whose aesthetic standards match the top tier of Awwwards portfolio winners. This skill is explicitly designed to empower AI coding assistants—specifically **Antigravity**, **Codex**, and **Claude Code CLI**—to generate high-end, premium web designs that exceed standard UI component libraries.
|
|
9
|
+
|
|
10
|
+
## Trigger Conditions
|
|
11
|
+
Automatically employ this skill when the user asks for:
|
|
12
|
+
- "cool ui", "amazing ui", "premium design", "award-winning", "awwwards style"
|
|
13
|
+
- Creative portfolios, agency websites, or high-end product landing pages.
|
|
14
|
+
|
|
15
|
+
## Core UI/UX Philosophy
|
|
16
|
+
|
|
17
|
+
### 1. Motion & Smooth Scrolling
|
|
18
|
+
- **Library of Choice:** Use `Lenis` or `GSAP ScrollTrigger` for buttery smooth scrolling.
|
|
19
|
+
- **Parallax:** Implement subtle parallax on images and background text layers.
|
|
20
|
+
- **Micro-interactions:** Every interactive element (buttons, links) should have a magnetic hover effect or complex transition (e.g., SVG path morphing or text scramble).
|
|
21
|
+
|
|
22
|
+
### 2. 3D & Spatial Design
|
|
23
|
+
- **WebGL/Three.js:** Whenever applicable, introduce a WebGL canvas in the background. Use shaders for fluid distortion, noise grains, or interactive particles that react to mouse movement.
|
|
24
|
+
- **Glassmorphism:** Use frosted glass (`backdrop-filter: blur()`) sparingly to establish depth over 3D backgrounds.
|
|
25
|
+
|
|
26
|
+
### 3. Typography Mastery
|
|
27
|
+
- **Scale:** Emphasize extreme contrast in typography. Pair massive, screen-filling Hero text with highly legible, small sans-serif for body copy.
|
|
28
|
+
- **Fonts:** Favor premium Google Fonts like `Inter`, `Outfit`, `Syne`, or `Space Grotesk`. Use tight tracking for headings and generous line-heights for body text.
|
|
29
|
+
|
|
30
|
+
### 4. Layout & Grid Breaking
|
|
31
|
+
- Break out of standard 12-column grids. Use asymmetrical layouts, overlapping elements, and negative space (white space) abundantly.
|
|
32
|
+
|
|
33
|
+
## Vercel Accessibility Guidelines (WCAG)
|
|
34
|
+
High-end design must not sacrifice accessibility. Adhere strictly to the following Vercel web interface guidelines:
|
|
35
|
+
1. **Semantic HTML:** Always use `<button>` for actions and `<a>` for navigation. Do not attach `onClick` to `<div>` elements.
|
|
36
|
+
2. **ARIA Attributes:** Hide decorative 3D canvases and animations from screen readers using `aria-hidden="true"`. Use `aria-label` for icon-only buttons.
|
|
37
|
+
3. **Reduced Motion Fallback:** Respect `prefers-reduced-motion`. Disable GSAP/Three.js heavy animations and fall back to static layouts if the user prefers reduced motion:
|
|
38
|
+
```css
|
|
39
|
+
@media (prefers-reduced-motion: reduce) {
|
|
40
|
+
*, ::before, ::after {
|
|
41
|
+
animation-delay: -1ms !important;
|
|
42
|
+
animation-duration: 1ms !important;
|
|
43
|
+
animation-iteration-count: 1 !important;
|
|
44
|
+
background-attachment: initial !important;
|
|
45
|
+
scroll-behavior: auto !important;
|
|
46
|
+
transition-duration: 0s !important;
|
|
47
|
+
transition-delay: 0s !important;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
4. **Contrast:** Ensure all text passes at least WCAG AA (4.5:1 ratio). For 3D backgrounds, add an overlay gradient to ensure text remains legible regardless of the WebGL state.
|
|
52
|
+
5. **Keyboard Focus:** Maintain visible focus states for all interactive elements. Do not use `outline: none;` without a custom focus-visible style.
|
|
53
|
+
|
|
54
|
+
## Security & Performance Guidelines (Critical)
|
|
55
|
+
To ensure the high-end UIs remain robust and secure, follow these rules:
|
|
56
|
+
1. **Content Security Policy (CSP):** When injecting external WebGL scripts or shaders, ensure they comply with strict CSP headers. Avoid inline `<script>` tags without nonces.
|
|
57
|
+
2. **XSS Protection with DOM Parsing:** Complex SVG morphs and dynamic text-scrambling (e.g. GSAP TextPlugin) often manipulate the DOM. NEVER pass unsanitized user inputs to functions that parse innerHTML or SVG paths. Always use DOMPurify if manipulating SVG definitions directly.
|
|
58
|
+
3. **GPU Memory Leaks:** In Three.js/WebGL applications, explicitly call `dispose()` on Geometries, Materials, and Textures when components unmount (e.g., in a React `useEffect` cleanup). Awwwards sites drop frames if memory leaks occur.
|
|
59
|
+
4. **Debounced Listeners:** Scroll and mousemove listeners used for parallax and 3D interactions must use `requestAnimationFrame` loops or be properly debounced.
|
|
60
|
+
|
|
61
|
+
## Implementation Workflow
|
|
62
|
+
1. **Setup:** Initialize the project (Next.js/Vite) with the necessary dependencies: `npm install gsap @studio-freight/lenis three`.
|
|
63
|
+
2. **Structure:** Build the accessible semantic shell.
|
|
64
|
+
3. **Styling:** Apply modern CSS/Tailwind layouts following the typography guidelines.
|
|
65
|
+
4. **Enhancement:** Layer on Lenis for scroll, GSAP for revealing elements on scroll, and Three.js for background flair.
|