building-blocks（积木）

Building Blocks

This skill guides you through creating new AEM Edge Delivery blocks or modifying existing ones, following Content Driven Development (CDD) principles. Blocks are the reusable building blocks of AEM sites - each transforms authored content into rich, interactive experiences through JavaScript decoration and CSS styling. This skill covers the complete development process: understanding content models, implementing decoration logic, applying styles, and maintaining code quality standards.

Related Skills

• content-driven-development: MUST be invoked before using this skill to ensure content and content models are ready
• block-collection-and-party: Use to find similar blocks for patterns
• testing-blocks: Automatically invoked after implementation for comprehensive testing

When to Use This Skill

This skill should ONLY be invoked from the content-driven-development skill during Phase 2 (Implementation).

If you are not already following the CDD process:

• STOP - Do not proceed with this skill
• Invoke the content-driven-development skill first
• The CDD skill will ensure test content and content models are ready before implementation

This skill handles:

• Creating new block files and structure
• Implementing JavaScript decoration
• Adding CSS styling
• Code quality and testing

Prerequisites

REQUIRED before using this skill:

• ✅ Test content must exist (in CMS or local drafts)
• ✅ Content model must be defined
• ✅ Test content URL must be available

Information needed:

1. Block name: What should the block be called?
2. Content model: The defined structure authors will use
3. Test content URL: Path to test content for development

Process Overview

1. Verify Prerequisites (CDD completed)
2. Find Similar Blocks (for patterns and reuse)
3. Create or Modify Block Structure (files and directories)
4. Implement JavaScript Decoration (DOM transformation)
5. Add CSS Styling (scoped, responsive styles)
6. Test the Implementation (local testing, linting)
7. Document Block (developer and author-facing docs)

Detailed Process

1. Verify Prerequisites

Before proceeding, confirm with the user:

"Do you have:

• ✅ Test content created (URL or path)?
• ✅ Content model defined?

If not, we need to use the content-driven-development skill first."

If prerequisites are not met, STOP and invoke the content-driven-development skill.

If prerequisites are met, get the test content URL from the user and proceed to step 2.

2. Find Similar Blocks

For new blocks or major modifications:

1. Search the codebase for similar blocks that might provide useful patterns or code we can re-use
2. Use the block-collection-and-party skill to find relevant reference blocks

Review the implementation patterns in similar blocks to inform your approach.

For minor modifications to existing blocks: Skip to step 3.

3. Create or Modify Block Structure

For new blocks:

1. Create directory: blocks/{block-name}/
2. Create files: {block-name}.js and {block-name}.css
3. Use the boilerplate structure (or reference templates in resources/ if helpful):

- JS file exports a default decorate(block) function (can be async if needed) - CSS file targets the .{block-name} class

For existing blocks:

1. Locate the existing block directory in blocks/{block-name}/
2. Review the current implementation before making changes
3. Understand the existing decoration logic and styles

4. Implement JavaScript Decoration

Follow patterns and conventions in resources/js-guidelines.md:

• Use DOM APIs to transform the initial block HTML structure
• Keep decoration logic focused and single-purpose
• Handle variants appropriately (check block.classList for variant classes)
• Follow established patterns from similar blocks

Read resources/js-guidelines.md for detailed examples, code standards, and best practices.

5. Add CSS Styling

Follow patterns and conventions in resources/css-guidelines.md:

• All CSS selectors must be scoped to the block (start with .{block-name})
• Use BEM-like naming within the block scope
• Leverage CSS custom properties for theming
• Write mobile-first responsive styles
• Keep specificity low
• Follow established patterns from similar blocks

Read resources/css-guidelines.md for detailed examples, code standards, and best practices.

6. Test the Implementation

After implementation is complete, invoke the testing-blocks skill:

The testing-blocks skill will guide you through:

• Writing unit tests for any logic-heavy utilities
• Browser testing to validate block behavior
• Taking screenshots for validation and PR documentation
• Running linting and fixing issues
• Verifying GitHub checks pass

Provide the testing-blocks skill with:

• Block name being tested
• Test content URL (from CDD process)
• Any variants that need testing

Return to this skill after testing is complete to proceed to step 7.

7. Document Block

Blocks require two types of documentation:

Developer Documentation

• Most blocks are simple and self-contained and only need code comments for documentation
• If a block is especially complex (has many variants, or especially complex code) consider adding a brief README.md in the block folder
• Keep any README documentation very brief so it can be consumed at a glance

Author-Facing Documentation

Author-facing documentation helps content authors understand how to use the block in the CMS. This documentation typically exists as draft/library content in the CMS itself, not in the codebase.

When author documentation is needed:

Almost all blocks should have author-facing documentation. The only exceptions are:

• Deprecated blocks that should no longer be used but can't be removed yet
• Special-purpose blocks used very infrequently on a need-to-know basis
• Auto-blocked blocks that shouldn't be used directly by authors

Maintaining author documentation:

Author documentation must be kept in sync with the block implementation:

• Update when variants are added, removed, or modified
• Update when the content structure changes
• Update when block behavior or functionality changes

Where author documentation lives:

Different projects use different approaches for author documentation:

1. Sidekick Library (Google Drive/SharePoint authoring):

- Uses https://github.com/adobe/franklin-sidekick-library - Check for /tools/sidekick/library.html in the codebase - If present, guide user to add/update block documentation in the library

1. Document Authoring (DA) Library:

- Uses https://docs.da.live/administrators/guides/setup-library - Different implementation than Sidekick Library - If in use, guide user to update block documentation in DA library

1. Universal Editor (UE) projects:

- Often skip dedicated author documentation libraries - May use inline help or other mechanisms

1. Simple documentation pages:

- Some projects maintain documentation under /drafts or /docs - Pages contain authoring guides and block examples

What to include in author documentation:

The specific content of author documentation varies by project. As an agent:

1. Identify that author documentation needs to be created or updated
2. Determine which documentation approach the project uses (check for /tools/sidekick/library.html as a signal)
3. Guide the user on what aspects of the block should be documented based on the changes made
4. Provide specific guidance based on the project's documentation approach

Reference Materials

• resources/js-guidelines.md
• resources/css-guidelines.md