MR
Mayur Rathi
@github
⭐ 34.1k GitHub stars

Lwc

Lwc是一款code方向的AI技能,核心价值是Guidelines and best practices for developing Lightning Web Components (LWC) on Salesforce Platform,可用于解决开发者在code领域的实际问题,帮助用户提升效率、自动化重复任务或优化工作流。

Guidelines and best practices for developing Lightning Web Components (LWC) on Salesforce Platform.

Last verified on: 2026-05-30
mkdir -p ./skills/lwc && curl -sfL https://raw.githubusercontent.com/github/awesome-copilot/main/skills/lwc/SKILL.md -o ./skills/lwc/SKILL.md

Run in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).

Skill Content

# LWC Development


General Instructions


- Each LWC should reside in its own folder under `force-app/main/default/lwc/`.

- The folder name should match the component name (e.g., `myComponent` folder for the `myComponent` component).

- Each component folder should contain the following files:

- `myComponent.html`: The HTML template file.

- `myComponent.js`: The JavaScript controller file.

- `myComponent.js-meta.xml`: The metadata configuration file.

- Optional: `myComponent.css` for component-specific styles.

- Optional: `myComponent.test.js` for Jest unit tests.


Core Principles


1. Use Lightning Components Over HTML Tags

Always prefer Lightning Web Component library components over plain HTML elements for consistency, accessibility, and future-proofing.


#### Recommended Approach

html
<!-- Use Lightning components -->
<lightning-button label="Save" variant="brand" onclick={handleSave}></lightning-button>
<lightning-input type="text" label="Name" value={name} onchange={handleNameChange}></lightning-input>
<lightning-combobox label="Type" options={typeOptions} value={selectedType}></lightning-combobox>
<lightning-radio-group name="duration" label="Duration" options={durationOptions} value={duration} type="radio"></lightning-radio-group>

#### Avoid Plain HTML

html
<!-- Avoid these -->
<button onclick={handleSave}>Save</button>
<input type="text" onchange={handleNameChange} />
<select onchange={handleTypeChange}>
    <option value="option1">Option 1</option>
</select>

2. Lightning Component Mapping Guide


| HTML Element | Lightning Component | Key Attributes |

|--------------|-------------------|----------------|

| `<button>` | `<lightning-button>` | `variant`, `label`, `icon-name` |

| `<input>` | `<lightning-input>` | `type`, `label`, `variant` |

| `<select>` | `<lightning-combobox>` | `options`, `value`, `placeholder` |

| `<textarea>` | `<lightning-textarea>` | `label`, `max-length` |

| `<input type="checkbox">` | `<lightning-input type="checkbox">` | `checked`, `label` |

| `<input type="radio">` | `<lightning-radio-group>` | `options`, `type`, `name` |

| `<input type="toggle">` | `<lightning-input type="toggle">` | `checked`, `variant` |

| Custom pills | `<lightning-pill>` | `label`, `name`, `onremove` |

| Icons | `<lightning-icon>` | `icon-name`, `size`, `variant` |


3. Lightning Design System Compliance


#### Use SLDS Utility Classes

Always use Salesforce Lightning Design System utility classes with the `slds-var-` prefix for modern implementations:


html
<!-- Spacing -->
<div class="slds-var-m-around_medium slds-var-p-top_large">
    <div class="slds-var-m-bottom_small">Content</div>
</div>

<!-- Layout -->
<div class="slds-grid slds-wrap slds-gutters_small">
    <div class="slds-col slds-size_1-of-2 slds-medium-size_1-of-3">
        <!-- Content -->
    </div>
</div>

<!-- Typography -->
<h2 class="slds-text-heading_medium slds-var-m-bottom_small">Section Title</h2>
<p class="slds-text-body_regular">Description text</p>

#### SLDS Component Patterns

html
<!-- Card Layout -->
<article class="slds-card slds-var-m-around_medium">
    <header class="slds-card__header">
        <h2 class="slds-text-heading_small">Card Title</h2>
    </header>
    <div class="slds-card__body slds-card__body_inner">
        <!-- Card content -->
    </div>
    <footer class="slds-card__footer">
        <!-- Card actions -->
    </footer>
</article>

<!-- Form Layout -->
<div class="slds-form slds-form_stacked">
    <div class="slds-form-element">
        <lightning-input label="Field Label" value={fieldValue}></lightning-input>
    </div>
</div>

4. Avoid Custom CSS


#### Use SLDS Classes

html
<!-- Color and theming -->
<div class="slds-theme_success slds-text-color_inverse slds-var-p-around_small">
    Success message
</div>

<div class="slds-theme_error slds-text-color_inverse slds-var-p-around_small">
    Error message
</div>

<div class="slds-theme_warning slds-text-co

🎯 Best For

  • UI designers
  • Product designers
  • Claude users
  • GitHub Copilot users
  • Software engineers

💡 Use Cases

  • Generating component mockups
  • Creating design system tokens
  • Code quality improvement
  • Best practice enforcement

📖 How to Use This Skill

  1. 1

    Install the Skill

    Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.

  2. 2

    Load into Your AI Assistant

    Open Claude or GitHub Copilot and reference the skill. Paste the SKILL.md content or use the system prompt tab.

  3. 3

    Apply Lwc to Your Work

    Open your project in the AI assistant and ask it to apply the skill. Start with a small module to verify the output quality.

  4. 4

    Review and Refine

    Review AI suggestions before committing. Run tests, check for regressions, and iterate on the skill output.

❓ Frequently Asked Questions

Does this work with Figma?

Some design skills integrate with Figma plugins. Check the Works With section for supported tools.

Is Lwc compatible with Cursor and VS Code?

Yes — this skill works with any AI coding assistant including Cursor, VS Code with Copilot, and JetBrains IDEs.

Do I need specific dependencies for Lwc?

Check the install command and Works With section. Most code skills only require the AI assistant and your codebase.

How do I install Lwc?

Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/lwc/SKILL.md, ready to use.

Can I customize this skill for my team?

Absolutely. Edit the SKILL.md file to add team-specific instructions, examples, or workflows.

⚠️ Common Mistakes to Avoid

Skipping usability testing

AI-generated designs should be validated with real users before development.

Skipping validation

Always test AI-generated code changes, even for simple refactors.

Missing dependency updates

Check if the skill requires updated dependencies or new packages.

🔗 Related Skills