agentleFS
saleorsaleor/saleor-dashboard/.claude/skills/saleor-dashboard-microcopy/SKILL.md

saleor-dashboard-microcopy

Skill1.1k starsChanged 8 days agoBSD-3-ClauseView on GitHub

Patterns for helper text, card subheaders, and inline links in Saleor Dashboard. Use when adding or styling hints below section titles, explanatory copy above form fields, microcopy with navigation links, replacing buttons with guidance text, or “Fixed at creation” helpers under locked identity fields. Covers DashboardCard.Subtitle, MicrocopyLink, and FixedAtCreationField copy — not accent Link or body paragraphs.

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 3 mentionsMar 2026: 5 mentionsApr 2026: 0 mentionsMay 2026: 1 mentionJun 2026: 33 mentionsJul 2026: 3 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 2 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the saleor/saleor-dashboard repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about saleor/saleor-dashboard

The biggest 5 of 50 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 50

Talked about on GitHub (50 times).

On GitHub · 50

45 more on GitHub

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use MicrocopyLink (src/components/MicrocopyLink.tsx), not @dashboard/components/Link.

    line 75
  2. Very specific:

    Put the link target in values ({link}, {taxSettingsLink}, etc.).

    line 120

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Saleor Dashboard Microcopy

Secondary explanatory copy under a title or field: subheaders, hints, helper text. Distinct from card titles, labels, and primary @dashboard/components/Link (accent navigation).

Subheader / hint text

Match Order Value and Order Weight card subtitles:

import { DashboardCard } from "@dashboard/components/Card";
import { FormattedMessage } from "react-intl";

<DashboardCard.Subtitle fontSize={3} color="default2">
  <FormattedMessage {...messages.hint} />
</DashboardCard.Subtitle>;
DoDon't
DashboardCard.Subtitle + fontSize={3} + color="default2"Bare <FormattedMessage /> in card content (inherits wrong size/color)
Same style for all paragraphs in a hint blockText size={2} or size={3} alone (drifts from card subtitle token)
CardSpacer between hint and the control belowSmaller gray Text for some lines and body text for others in the same block

Placement

  • Under DashboardCard.Title (in DashboardCard.Header): subtitle directly below title in a column Box — see OrderValue, OrderWeight.
  • Above a field inside DashboardCard.Content: subtitle before Multiselect / inputs — see ChannelsSection, WarehousesSection.
  • Below a field: subtitle after the control — see ShippingMethodTaxes tax-class hint.
  • Fixed at creation: helper under a locked FixedAtCreationField — Fixed at creation. To {goal}, {alternative}. See saleor-dashboard-entity-detail (channel currency, attribute type). Not a disabled Combobox.
  • Entity detail DetailSettingsCard: long leading copy in the card’s intro row (bordered band below header), not in the tinted title band — see Payment gateways, collection SEO. Short Complete/Incomplete status can live in intro too.

Reference files

  • src/shipping/components/OrderValue/OrderValue.tsx
  • src/shipping/components/OrderWeight/OrderWeight.tsx
  • src/shipping/components/ShippingZoneSettingsCard/ChannelsSection.tsx
  • src/shipping/components/ShippingZoneSettingsCard/WarehousesSection.tsx
  • src/shipping/components/ShippingMethodTaxes/ShippingMethodTaxes.tsx
  • src/shipping/components/ShippingMethodTaxes/ShippingMethodTaxes.tsx
  • src/channels/components/ChannelPaymentGatewaysSection/ChannelPaymentGatewaysSection.tsx
  • src/collections/components/CollectionDetailsPage/CollectionDetailsPage.tsx (SEO intro)

Optional labels

Mark optional sections/fields without brackets or title-case noise.

DoDon't
DetailSettingsCardTitle + optional prop → DetailSettingsOptionalLabel"Background Image (optional)" in the title string
commonMessages.optionalField for field helper text (Optional, no parens)"(Optional)" in helper text
Text size={2} color="default2" beside the title (baseline-aligned)Same size/weight as the section title
import { DetailSettingsCardTitle } from "@dashboard/components/DetailSettingsCard/DetailSettingsCard";

<DetailSettingsCardTitle optional>
  <FormattedMessage defaultMessage="Background image" />
</DetailSettingsCardTitle>;

Inline links inside hints

Use MicrocopyLink (src/components/MicrocopyLink.tsx), not @dashboard/components/Link.

import { MicrocopyLink } from "@dashboard/components/MicrocopyLink";
import { sectionNames } from "@dashboard/intl";
import { warehouseListUrl } from "@dashboard/warehouses/urls";

<DashboardCard.Subtitle fontSize={3} color="default2">
  <FormattedMessage
    {...messages.createWarehouseHint}
    values={{
      link: (
        <MicrocopyLink to={warehouseListUrl()}>
          <FormattedMessage {...sectionNames.warehouses} />
        </MicrocopyLink>
      ),
    }}
  />
</DashboardCard.Subtitle>;

MicrocopyLink rules

PropertyValueWhy
ColorinheritSame gray as parent subtitle (default2) — not accent blue
Size__fontSize="inherit"Same size as surrounding sentence — not default Text size
WeightfontWeight="medium"Only visual difference from body of hint
Decorationnone; textDecoration={{ hover: "underline" }}Underline on hover only

When to use which link

ComponentUse for
MicrocopyLinkLinks embedded in hint/subtitle sentences (inherit color; underline on hover)
Link color="secondary"In-component / card / sidebar navigation — prefer this (default1, underline on hover; not accent blue)
Link (default primary)Rare emphasis where accent blue is intentional (legacy tables/actions)
ChannelDisplay / ChannelDetailsLinkChannel name + globe icon (read-only or link to channel details) — see styles skill
InternalLink / RouterLink in custom TextAvoid — duplicate styling; extend MicrocopyLink or use Link color="secondary"

Hover is required for every interactive link: underline and/or color change. See saleor-dashboard-styles → Interactive affordances.

i18n

  • Define copy in defineMessages with description for translators.
  • Put the link target in values ({link}, {taxSettingsLink}, etc.); keep URL helpers in the component (warehouseListUrl(), taxClassesListUrl()).
  • Reuse sectionNames.* for configuration area names when linking to settings sections.

UX guidance (hints vs modals)

When backend rules make in-context creation fragile (e.g. warehouse must share a channel with the shipping zone), prefer hint + link to configuration over an inline create modal on the same page. State the constraint in subtitle copy; link to the list/create flow where the entity is fully configured.

Checklist

  • Hint uses DashboardCard.Subtitle fontSize={3} color="default2"
  • All hint paragraphs in the same block use the same subtitle wrapper
  • Inline links use MicrocopyLink with inherit color/size
  • No accent-colored links inside gray hint text
  • CardSpacer between hint blocks and form controls
  • Optional sections use DetailSettingsCardTitle optional, not “(optional)” in the title
  • Create-time identity uses FixedAtCreationField + “Fixed at creation. …” helper — not a disabled Combobox
  • Messages extracted with defineMessages + FormattedMessage

Related skills

  • saleor-dashboard-entity-detail — entity detail surfaces vs Configuration
  • Layout/spacing/tokens: saleor-dashboard-styles
  • Detail page structure: saleor-dashboard-detail-pages

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.