Saleor Dashboard Microcopy
Designsaleor-dashboard-microcopySaleor Dashboard Microcopy is an Agent Skill for design published in the saleor/saleor-dashboard repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
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, or replacing buttons with guidance text. Covers DashboardCard.Subtitle and MicrocopyLink — not accent Link or body paragraphs.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/saleor/saleor-dashboard/blob/HEAD/.claude/skills/saleor-dashboard-microcopy/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/saleor-dashboard-microcopy, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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>;
| Do | Don't |
|---|---|
DashboardCard.Subtitle + fontSize={3} + color="default2" | Bare <FormattedMessage /> in card content (inherits wrong size/color) |
| Same style for all paragraphs in a hint block | Text size={2} or size={3} alone (drifts from card subtitle token) |
CardSpacer between hint and the control below | Smaller gray Text for some lines and body text for others in the same block |
Placement
- Under
DashboardCard.Title(inDashboardCard.Header): subtitle directly below title in a columnBox— seeOrderValue,OrderWeight. - Above a field inside
DashboardCard.Content: subtitle beforeMultiselect/ inputs — seeChannelsSection,WarehousesSection. - Below a field: subtitle after the control — see
ShippingMethodTaxestax-class hint.
Reference files
src/shipping/components/OrderValue/OrderValue.tsxsrc/shipping/components/OrderWeight/OrderWeight.tsxsrc/shipping/components/ShippingZoneSettingsCard/ChannelsSection.tsxsrc/shipping/components/ShippingZoneSettingsCard/WarehousesSection.tsxsrc/shipping/components/ShippingMethodTaxes/ShippingMethodTaxes.tsx
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
| Property | Value | Why |
|---|---|---|
| Color | inherit | Same gray as parent subtitle (default2) — not accent blue |
| Size | __fontSize="inherit" | Same size as surrounding sentence — not default Text size |
| Weight | fontWeight="medium" | Only visual difference from body of hint |
| Decoration | none; textDecoration={{ hover: "underline" }} | Underline on hover only |
When to use which link
| Component | Use for |
|---|---|
MicrocopyLink | Links embedded in hint/subtitle sentences |
@dashboard/components/Link | Standalone navigation, tables, actions (accent color OK) |
InternalLink / RouterLink in custom Text | Avoid — duplicate styling; extend MicrocopyLink if a variant is needed |
i18n
- Define copy in
defineMessageswithdescriptionfor 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
MicrocopyLinkwith inherit color/size - No accent-colored links inside gray hint text
-
CardSpacerbetween hint blocks and form controls - Messages extracted with
defineMessages+FormattedMessage
Related skills
- Layout/spacing/tokens:
saleor-dashboard-styles - Detail page structure:
saleor-dashboard-detail-pages