跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
开发与测试

webflow-code-component:component-audit

Audit Webflow Code Components for architecture decisions - prop exposure, state management, slot opportunities, and Shadow DOM compatibility. Focused on Webflow-specific patterns, not generic React best practices.

webflow · 已有 AI 审核记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add webflow/webflow-skills --skill webflow-code-component:component-audit

技能说明


name: webflow-code-component:component-audit description: Audit Webflow Code Components for architecture decisions - prop exposure, state management, slot opportunities, and Shadow DOM compatibility. Focused on Webflow-specific patterns, not generic React best practices. compatibility: Node.js 18+, React 18+, TypeScript, @webflow/webflow-cli metadata: author: webflow version: "2.0"

Component Audit

Audit existing code components for Webflow-specific architecture decisions. This skill focuses on how well components integrate with Webflow Designer, not generic React best practices.

When to Use This Skill

Use when:

  • User wants to improve how their components work in Webflow Designer
  • Reviewing whether the right things are exposed as props vs hardcoded
  • Checking if state management patterns are Webflow-compatible
  • Looking for opportunities to make components more designer-friendly
  • Component isn't rendering or behaving as expected in Webflow

Do NOT use when:

  • Validating before deployment (use pre-deploy-check instead)
  • Creating new components (use component-scaffold instead)
  • Converting a React component (use convert-component instead)
  • Generic code quality review (use a linter)

Core Philosophy

This audit answers three questions:

  1. Designer Control: Are the right things exposed as props for designers to customize?
  2. Webflow Compatibility: Does the component work within Webflow's constraints (Shadow DOM, SSR, isolated React roots)?
  3. Component Architecture: Is this the right level of granularity, or should it be split/combined?

Instructions

Phase 1: Discovery

  1. Find all components:

    • Locate webflow.json
    • Find all .webflow.tsx files
    • Read corresponding React components
  2. Understand intent: Ask user what the components are for and any specific concerns

Phase 2: Analysis

For each component, analyze these Webflow-specific areas:

A. Prop Exposure Analysis

Goal: Identify what designers SHOULD be able to control but currently can't.

Look ForRecommendation
Hardcoded text stringsExpose as props.Text()
Text that designers should edit on canvasExpose as props.RichText()
Hardcoded values from a fixed set of optionsExpose as props.Variant({ options: [...] })
Hardcoded image URLsExpose as props.Image()
Hardcoded link URLsExpose as props.Link()
Hardcoded HTML id attributesExpose as props.Id()
Conditional rendering with booleanExpose as props.Boolean() or props.Visibility()
Internal state that affects appearanceConsider exposing initial value as prop
children not using SlotConvert to props.Slot()

Aliases: props.String = props.Text, props.Children = props.Slot. Treat these as equivalent during audit.

Questions to ask:

  • "What would a designer want to change?"
  • "What requires a code change that shouldn't?"

B. State Management Architecture

Goal: Identify patterns that won't work in Webflow.

Anti-PatternWhy It FailsAlternative
React Context for cross-component stateEach component has isolated React rootUse nano stores, custom events, or URL params
Prop drilling through SlotsSlot children are separate React appsUse nano stores or custom events
Shared state via module-level variablesMay cause SSR issuesUse browser storage or nano stores
Global event listeners without cleanupMemory leaks, SSR issuesUse useEffect with cleanup

Refactoring recommendations:

  • If components need to communicate → suggest cross-component state pattern
  • If using Context internally only → that's fine, document it
  • If components are tightly coupled → suggest decomposition

C. Slot Opportunities

Goal: Identify hardcoded content that should be designer-controlled.

Current PatternBetter Pattern
Hardcoded button inside cardSlot for actions area
Hardcoded icon componentSlot or Image prop
Fixed header/footer structureSlots for header and footer
Hardcoded list itemsConsider if this should be multiple components

When NOT to use Slots:

  • When content has specific behavioral requirements
  • When content needs to interact with component state
  • When the structure is truly fixed and not customizable

D. Shadow DOM Compatibility

Goal: Ensure styles work in isolation.

IssueDetectionFix
Using site/global CSS classesClass names like .container, .btnUse CSS Modules or component-scoped styles
CSS-in-JS not configuredstyled-components/Emotion without decoratorAdd globals.ts with styledComponentsShadowDomDecorator (styled-components) or emotionShadowDomDecorator (Emotion/MUI)
Missing style importsStyles defined but not imported in .webflow.tsxAdd import statement
Relying on inherited stylesExpecting parent styles to cascadeUse explicit styles or CSS variables
Needs tag selectors (h1, p, etc.)Tags not styled inside Shadow DOMEnable applyTagSelectors: true in component options

SSR Note: When using styled-components or Emotion, you must also configure the server renderer in webflow.json for SSR to work correctly:

  • styled-components: "library": { "renderer": { "server": "@webflow/styled-components-utils/server" } }
  • Emotion: "library": { "renderer": { "server": "@webflow/emotion-utils/server" } }

E. SSR Safety

Goal: Identify browser-only code that runs during render.

PatternProblemSolution
window.innerWidth in renderSSR errorUse useEffect or set ssr: false
document.getElementById in renderSSR errorUse useEffect or refs
localStorage.getItem outside useEffectSSR errorWrap in useEffect with useState
阅读完整来源 ↗