Przejdź do treści
Biblioteka skilli
Programowanie · Budowanie i kod

add-component

/add-component

Dodaje nowy komponent lub podczęść do rejestru VelvetKit w repozytorium, z kompletem plików.

Repozytorium
velvetkit ↗
Licencja
MIT
Ostatnia zmiana repozytorium
09.11.2026

Ocena i bezpieczeństwo

92/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść27 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 09.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Dodaje nowy komponent lub podczęść do rejestru VelvetKit w repozytorium, z kompletem plików.

Oryginalny opis (EN)

Add a new component to the VelvetKit registry, or add a sub-part to an existing one. Use when asked to build, add or scaffold a UI component in this repo (not in an app that has installed VelvetKit — that's a different skill).

Jak działa

SKILL.md bez nagłówków drugiego poziomu · 75 linii, 500 słów

Podgląd SKILL.md
---
name: add-component
description: Add a new component to the VelvetKit registry, or add a sub-part to an existing one. Use when asked to build, add or scaffold a UI component in this repo (not in an app that has installed VelvetKit — that's a different skill).
---

Read `AGENTS.md` first — it has the registry's auto-discovery rules
(`UI::ClassName` references, `ui--name` controller strings) that this skill's
steps depend on, and the file-layout conventions for compound components.

For a new component named `thing` (swap in the real name throughout):

1. **Catalog entry.** Add to `registry/components.yml`, alphabetically, with
   only a `description:` — one sentence, same voice as its neighbors (read a
   few nearby entries first).

2. **Component files.**
   `registry/app/components/ui/thing.rb` + `thing.html.erb`. Find the
   sibling component closest in shape to what you're building and copy its
   structure — the `variants()` DSL, `cn()` usage, `data:`/`aria:` hash
   style, slot helpers (`renders_one`) — rather than inventing a new shape.
   Good references: `alert.rb` (simple, variants + icon + dismiss),
   `banner.rb` (dismiss button + action slot), `sheet/content.rb` (a `side:`-
   style variant with enter/exit animation), `toast.rb` +
   `toast/viewport.rb` (a component with a client-triggerable JS path).
   A compound component (more than one renderable piece) gets a `thing/`
   subdirectory instead of a flat file — `thing/sub_part.rb` becomes
   `UI::Thing::SubPart`.

3. **Stimulus controller**, only if the component needs JS behavior:
   `registry/app/javascript/controllers/ui/thing_controller.ts`, wired from
   the template with `data: { controller: "ui--thing" }`. Match the style of
   a controller doing something similar — `banner_controller.ts` for a
   one-line dismiss, `tooltip_controller.ts` for timers/cleanup in
   `connect()`/`disconnect()`, `dialog_controller.ts` for native-element
   delegation. Don't reach for a new npm package unless the behavior is
   genuinely hard (positioning math, calendar logic) — most components here
   are plain Stimulus, no dependency.

4. **i18n.** Any string the component renders (button labels, aria-labels,
   placeholders) goes in `registry/config/locales/velvetkit.en.yml` under a
   new `ui.thing:` key, read with
   `t("ui.thing.the_key", default: "The literal default")`.

5. **Test.** `registry/test/components/ui/thing_test.rb`. Copy the
   boilerplate from an existing test file verbatim (`require "test_helper"`,
   `ViewComponent::TestCase`, `def setup_fixtures(*); end` / `def
   teardown_fixtures(*); end`), then write real assertions: container
   renders, each variant's classes, each slot, dismiss/close wiring if any,
   `class:`/html-attribute passthrough. A compound component's sub-part gets
   its own test file at `registry/test/components/ui/thing/sub_part_test.rb`.

6. **Lookbook preview.** `registry/test/components/previews/ui/thing_preview.rb`
   — this is the component's documentation, there's no separate guide page
   to write. A `# @label Playground` method with `@param` annotations for the
   main knobs, plus a few `render_with_template` methods backed by
   `thing_preview/some_demo.html.erb` files for fixed scenarios (all
   variants side by side, a dismissible example, etc.).

7. **Release note.** Nothing to write in `CHANGELOG.md`: the release task
   lists the component with its `components.yml` description from step 1,
   so make that sentence read well on its own. Open the PR from a `feat/`
   branch titled `Thing: what it is` — see "Releases and CHANGELOG.md" in
   `AGENTS.md`.

8. **Verify.**
   ```
   bundle exec rubocop registry/app/components/ui/thing.rb registry/test/components/ui/thing_test.rb …
   bundle exec rake test
   ```
   Then, if you need to see it rendered: from `site/`, run
   `bin/rails generate velvetkit:add thing --force --skip-tests --skip-previews --skip-packages --quiet`
   to sync the docs app's copy, and check it at `localhost:3000/lookbook` —
   see "Where things live" in `AGENTS.md` for why this sync step is needed
   after every edit, not just the first time.

Don't stop at "it renders" — actually exercise what you built (click the
dismiss button, trigger the auto-dismiss timer, check both light and dark)
before calling it done.

Wersje

RepozytoriumWynikLicencja
Ta strona · kitforge-tech/velvetkit92MIT
MandalorianBatman/austere-axi100MIT
jpicklyk/task-orchestrator100MIT
carsonhung/gamifiedUI100Apache-2.0
mnabaci/Roastpilot86GPL-3.0

Migawka bazy z 13.11.2026 · wersja paczki 79054312f5d4 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 90frontend-component
    Dodaje lub zmienia komponent UI w stosie frontendowym, np. nowy widżet, element wielokrotnego użytku, sekcję strony albo stan lub wariant, zgodnie z konwencjami komponentów repozytorium.
  • 100content-sdk-app-router-component-scaffold
    Tworzy nowy komponent Sitecore w aplikacji Content SDK App Router: układ plików, interfejs właściwości i wybór serwera albo klienta.
  • 95frontend-component
    Tworzy komponent React lub Vue z TypeScriptem, testami i stylami.
  • 100hyperframes-registry
    Instaluje i podłącza bloki oraz komponenty z rejestru HyperFrames do kompozycji i opisuje tworzenie nowego bloku do wniesienia do projektu, od pomysłu po pull request.
  • 100create-cc-component
    Buduje nowy komponent Lit <cc-*> w repozytorium z linku do Figmy: komponent, historie, testy, rejestrację, sprawdzenie wizualne i przegląd kodu z poprawkami.
  • 100content-sdk-pages-router-component-scaffold
    Tworzy nowy komponent Sitecore w aplikacji Content SDK Pages Router: układ plików, interfejs właściwości i wpis w mapie komponentów.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.