Skip to content

web.instructions.md

Latest commit

 

History

History
36 lines (25 loc) · 1.3 KB

web.instructions.md

File metadata and controls

36 lines (25 loc) · 1.3 KB
Raw
applyTo wled00/data/**

Web UI Coding Conventions

Formatting

  • Indent HTML and JavaScript with tabs
  • Indent CSS with tabs

JavaScript Style

  • camelCase for functions and variables: gId(), selectedFx, currentPreset
  • Abbreviated helpers are common: d for document, gId() for getElementById()

Key Files

  • index.htm — main interface
  • index.js — functions that manage / update the main interface
  • settings*.htm — configuration pages
  • *.css — stylesheets (inlined during build)
  • common.js — helper functions

Reuse shared helpers from common.js whenever possible instead of duplicating utilities in page-local scripts.

Accessibility & Interaction

The WLED web UI targets commonly used browser/platform combinations: desktop browsers on Mac and PC (primarily pointer-driven, touch rare), and touch-only devices (phones, tablets). If possible, keep the UI accessible to users with disabilities. Full keyboard operability is not a strict requirement - adding keyboard shortcuts should be a case-by-case decision.

Build Integration

Files in this directory are processed by tools/cdata.js into generated headers (wled00/html_*.h, wled00/js_*.h). Run npm run build after any change. Never edit generated headers directly.