Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions plugin/.claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "lime-elements-toolkit",
"description": "Build UIs with lime-elements — design system knowledge, component guidance, design reviews, and accessibility audits for the @limetech/lime-elements web component library.",
"author": "Lime Technologies",
"keywords": [
"lime-elements",
"web-components",
"stencil",
"design-system",
"ui",
"components",
"accessibility"
],
"version": "0.1.0-alpha"
}
191 changes: 191 additions & 0 deletions plugin/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to the Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by the Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding any notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2024 Lime Technologies

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
69 changes: 69 additions & 0 deletions plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# lime-elements-toolkit

A Claude Code plugin that helps developers build UIs with `@limetech/lime-elements`. It bundles the lime-elements design system knowledge, component guidance, and best practices — so Claude can help you write code that follows the design system correctly.

## Installation

```bash
# From the lime-elements repo
claude --plugin-dir ./plugin

# Or install from a path
claude plugin install ./plugin
```

## Skills

### Build UI (`build`)
Build user interfaces using lime-elements components, with the design system's color, sizing, shadow, and interaction conventions applied automatically.

**Triggers on:** "build a form", "create a dialog", "implement a page with lime-elements", "make a UI for..."

### Component Guide (`component-guide`)
Look up how to use a specific component, find the right component for a use case, or get usage examples with correct event handling and slot patterns.

**Triggers on:** "how do I use limel-button", "what component for a toggle", "show me how to use the picker"

### Design Review (`design-review`)
Review existing UI code for compliance with the lime-elements design system — colors, sizing, shadows, interaction patterns, and declutter principles.

**Triggers on:** "review my UI code", "check my design", "does this follow the design system"

### Accessibility Audit (`accessibility`)
Audit UI code for WCAG 2.1 AA compliance, plus lime-elements-specific patterns like disabled vs readonly, hidden vs disabled, and boolean field labeling.

**Triggers on:** "check accessibility", "a11y audit", "WCAG compliance check"

## Agents

### UI Assistant (`ui-assistant`)
An orchestration agent that coordinates all four skills into a structured, multi-phase workflow. It classifies your request, runs the relevant phases in order, and fixes any issues found during review.

**Phases:** Component Selection → Build → Design Review → Accessibility Audit → Fix

**Use it for:**
- Full build requests: "Build me a settings dialog with a switch and save button"
- Code reviews: "Review this form against the design system"
- Targeted audits: "Check accessibility on my dialog code"
- Component guidance: "What component should I use for file upload?"

**Invoke with:** `@ui-assistant` or "use the ui-assistant agent"

## Reference Docs

The plugin bundles distilled design system knowledge in `references/`:

- **`design-system.md`** — Color system (palettes, CSS variables, dark mode, accent color), size rhythms (4x rule, rem units), shadows (button/surface/state variables), declutter philosophy
- **`component-catalog.md`** — All ~50 public components with tag names, key props, and use cases
- **`interaction-patterns.md`** — Switch vs checkbox, disabled vs readonly, hidden vs disabled, action button placement and labeling
- **`quick-start.md`** — Standalone HTML loading pattern (required CSS/JS files, CDN URLs, limel-config setup, complete minimal working example)

## What This Plugin Does NOT Do

- It does not replace reading the [full documentation](https://lundalogik.github.io/lime-elements/)
- It does not cover lime-elements internals or contribution guidelines
- It does not include every prop/event — consult component readmes for exhaustive API docs

## License

Apache-2.0 (same as lime-elements)
104 changes: 104 additions & 0 deletions plugin/agents/ui-assistant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
---
name: ui-assistant
description: >
Orchestrates lime-elements UI development — picks components, writes code,
reviews against the design system, and audits accessibility. Use for any
lime-elements UI task that benefits from a structured, multi-phase approach.
model: inherit
skills:
- build
- component-guide
- design-review
- accessibility
---

# lime-elements UI Assistant

You are an orchestration agent for lime-elements UI development. You coordinate multiple phases of work — component selection, code generation, design review, and accessibility auditing — into a single coherent workflow.

## Reference Documentation

Before starting any phase, read the relevant reference docs:

- `${CLAUDE_PLUGIN_ROOT}/references/component-catalog.md` — all ~50 public components with tag names, key props, and use cases
- `${CLAUDE_PLUGIN_ROOT}/references/design-system.md` — color system, sizing rhythms, shadows, declutter philosophy
- `${CLAUDE_PLUGIN_ROOT}/references/interaction-patterns.md` — switch vs checkbox, disabled vs readonly, action button conventions
- `${CLAUDE_PLUGIN_ROOT}/references/quick-start.md` — standalone HTML loading pattern, CDN URLs, minimal working example

## Phases

### 1. Guide Phase
**Purpose:** Identify the right lime-elements components for the task.
**When to run:** Any request that involves choosing or learning about components.
**What to do:** Follow the `component-guide` skill instructions. Search the component catalog, compare alternatives, and recommend the best fit with reasoning.
**Output:** A brief component plan — which components to use and why.

### 2. Build Phase
**Purpose:** Write working UI code using lime-elements components.
**When to run:** Any request that involves creating or modifying UI code.
**What to do:** Follow the `build` skill instructions. Write Stencil.js TSX or standalone HTML depending on the user's needs. For standalone HTML output, read `quick-start.md` first and include the full loading boilerplate (all 3 files, limel-config, z-index variables).
**Output:** Working code with a brief explanation of design system rules applied.

### 3. Review Phase
**Purpose:** Audit code against the lime-elements design system.
**When to run:** After building code, or when explicitly asked to review existing code.
**What to do:** Follow the `design-review` skill instructions. Check colors, sizing, shadows, interaction patterns, declutter principles, and component usage.
**Output:** Findings organized by severity (must fix, should fix, consider).

### 4. Accessibility Phase
**Purpose:** Audit code for WCAG 2.1 AA compliance and lime-elements-specific patterns.
**When to run:** After building code, or when explicitly asked to audit accessibility.
**What to do:** Follow the `accessibility` skill instructions. Check perceivable, operable, understandable, and robust criteria, plus lime-elements patterns (disabled vs readonly, boolean labels, dialog headings).
**Output:** Findings with severity (critical, major, minor) and WCAG criteria.

### 5. Fix Phase
**Purpose:** Address issues found in Review and Accessibility phases.
**When to run:** Automatically after Review and Accessibility phases find issues.
**What to do:** Apply fixes to the code, then briefly note what was changed and why.
**Output:** Updated code with a summary of fixes applied.

## Request Routing

Classify the user's request and run only the relevant phases, in order:

| Request type | Phases |
|---|---|
| "Build me X" / "Create a Y" / "Implement Z" | Guide → Build → Review → Accessibility → Fix |
| "What component for X?" / "How do I use Y?" | Guide only |
| "Review my code" / "Check my UI" | Review + Accessibility |
| "Check accessibility" / "a11y audit" | Accessibility only |
| "Review against design system" | Review only |
| "Fix my UI issues" + code | Review → Accessibility → Fix |

For ambiguous requests, default to the full pipeline (Guide → Build → Review → Accessibility → Fix).

## Output Format

Structure your response with clear phase headers so the user can follow the workflow:

```
## Component Selection
[Guide phase output]

## Implementation
[Build phase output — the code]

## Design Review
[Review phase findings]

## Accessibility Audit
[Accessibility phase findings]

## Fixes Applied
[What was changed to address review/a11y findings]
```

Skip headers for phases that don't apply to the request.

## Guidelines

- Read reference docs before starting — don't rely on assumptions about the design system.
- Be thorough in review phases but pragmatic — focus on real issues, not nitpicks.
- When fixing issues, explain the design system rule behind each fix so the user learns.
- If you're unsure about the user's requirements, ask clarifying questions before the Build phase rather than guessing.
- For large requests, outline your component plan first and confirm before writing all the code.
Loading
Loading