overview

Explain the Rikka toolkit architecture and package boundaries for developers.

6|1|Updated May 31, 2026
One-click install
npx skills add https://github.com/yw662/rikka --skill overview-yw662
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: overview
Source: https://github.com/yw662/rikka/tree/main/skills/overview
Command: npx skills add https://github.com/yw662/rikka --skill overview-yw662

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you quickly understand what Rikka is, how its packages fit together, and when it is the right choice for a project. It gives you the mental model needed to read the rest of the documentation without getting lost in implementation details.

Core Features & Use Cases

  • Project Orientation: Learn the roles of rikka-signal, rikka-dom, rikka-elements, and rikka-site.
  • Architecture Summary: Understand the no-virtual-DOM approach, signals-based reactivity, and native Web Components model.
  • Decision Support: Use it to decide whether Rikka is a good fit for a UI, component library, or full-stack resource-oriented app.
  • Naming and API Rules: Internalize the derivable patterns for attributes, signals, and events before writing code.

Quick Start

Read this overview first so you can understand Rikka’s package structure, design principles, and fit for your project before using any task-specific skill.

Frequently Asked Questions about overview

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is signal-based reactivity and how does it work with real DOM rendering?

Signal-based reactivity manages state updates directly against the real DOM without a virtual DOM layer. Rikka uses this approach to render native Web Components, updating only the specific DOM nodes affected by state changes for efficient UI rendering.

Do I need to understand custom element conventions to use Rikka web components?

Yes, understanding custom element conventions is required. Rikka relies on native Web Components standards for its component model, so familiarity with custom elements, attributes, and signals is necessary before building or evaluating Rikka applications.

How do I decide between using client-side Rikka components and the full-stack server package?

Choose Rikka's client-side components for UI or component library needs, and select the full-stack rikka-site package for resource-oriented applications. The overview helps map these package boundaries to your specific project architecture requirements.

What's the best way to onboard to the Rikka toolkit architecture quickly?

Start by reading the architecture overview to internalize the package structure, naming rules, and design principles. This provides the mental model needed to understand rikka-signal, rikka-dom, rikka-elements, and rikka-site before writing code.

When should I not use a no-virtual-DOM approach for web components?

Rikka's no-virtual-DOM approach requires understanding signal-based reactivity and real DOM rendering. If your team lacks familiarity with custom element conventions or needs a virtual DOM diffing model, Rikka may not be the right fit for your project.

How are attributes, signals, and events named in Rikka APIs?

Rikka APIs follow derivable patterns for naming attributes, signals, and events. Understanding these rules before writing code ensures consistency with the toolkit's internal conventions and reduces integration errors across packages.