Design system
GigRadar design system rules. Use when writing or reviewing UI in any GigRadar app (home, dashboard, crm, inbound) — building components, styling anything, picking colors or spacing, or importing from antd.From its SKILL.md
npx -y skills add GigRadar/GigRadar-DesignSystem --skill design-systemAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
11.5 KB, as published. Nobody here has run it
GigRadar Design System
The design system lives in @gigradar/theme and @gigradar/ui. This skill is
the contract for using it. Four apps share these packages — home, dashboard,
crm, and inbound — so a violation in one app is a divergence across the product.
The three rules
1. Import UI from @gigradar/ui
// Correct
import { Button, Badge, Card } from '@gigradar/ui';
// Wrong — bypasses the design system
import { Button } from 'antd';
import { Button } from 'some-other-ui-kit';
@gigradar/ui is the single import surface, so an implementation can be
swapped without touching app code.
Some apps still have antd 4.x in their dependency tree from before the design
system existed. Do not import from it. If a component you need is not exported
from @gigradar/ui yet, say what is missing rather than reaching around the
wrapper — see "When something is missing" below.
2. Never hardcode a color, spacing, radius, font size, or shadow
Every visual value comes from tokens. No exceptions, including "just this once" and "it's only a one-off."
import { color, spacing, radius, textStyle } from '@gigradar/ui';
// Correct
<div style={{ color: color.main.brand, padding: spacing.m, borderRadius: radius.s }} />
// Wrong
<div style={{ color: '#378AFA', padding: 16, borderRadius: 8 }} />
Tokens are reachable from three places, because a React hook cannot reach everywhere:
| Context | How |
|---|---|
| React components | import { color, spacing } from '@gigradar/ui' |
| Non-React code (charts, utils, configs) | import { tokens } from '@gigradar/theme' |
| Stylesheets | var(--gr-color-brand), var(--gr-space-m) |
Charts are the usual place hardcoded hex creeps in. Use tokens there.
3. Additive by default
New variants, new props, new tokens are free — ship them in a minor version.
Removing or renaming anything is a breaking change. It requires:
- Marking the old name
@deprecatedwith a pointer to the replacement - Keeping it working for at least one minor release
- Removing it only in a major version
Four apps consume these packages. One bad push must not break all four.
Tokens
Everything is extracted from the Figma guidebook. Do not invent values.
Colors — semantic groups, not a raw ramp:
color.main—brand,description,background,backgroundAlt,border,highlight,black,whitecolor.status—success,error,warning,info; each has.main,.background,.textcolor.navbar— nav chrome only:text,text2,hover,background,bordercolor.badge—foreground,hover,backgroundcolor.disable—background,backgroundAlt,textcolor.accent—laziza,decrease,schedule,meetingscolor.proposal—sentcolor.stageFlat— the nine CRM pipeline stages, keyed by namecolor.stage— the same nine, grouped byunqualified/pipeline/lostcolor.avatarTone— the avatar initial palette:cyan,magenta,purple,orange,red,volcano, and the rest. Picked from a name byAvatar, so reach for it only when drawing an avatar-like mark by hand.color.integration—slack,telegram; each has.main,.hover,.background,.border
color.integration holds brand colors owned by Slack and Telegram. Use them
only where the service itself is being represented — a channel badge, a
connection card, an integration toggle. They carry no meaning inside GigRadar's
own UI, so never reach for integration.slack.main because a dark purple was
wanted; that is what accent.schedule is for.
Spacing (px): xxs 4, xs 6, s 12, m 16, l 24, xl 32, xxl 64, sxxl 128
Radius (px): xxs 2, xs 6, s 8, m 12, l 24, xl 32, xxl 64, round 9999
The spacing and radius scales share T-shirt names but differ.
sis 12 in spacing and 8 in radius. Do not assume they match.
Border width (px): hairline 0.5, thin 1, medium 1.5, thick 2
thin is the default — card edges, dividers, input outlines. Reach for
medium on a slot or placeholder edge, and thick on a banner that has to
hold its own against a wash behind it. A bare 1px in a border shorthand is
what the lint rule catches.
Typography — use textStyle, which bundles size, weight, letter-spacing,
and line-height:
<span style={{ ...textStyle.mMedium }}>Body text</span>
Available: h1–h4, and l/m/s × Semibold/Medium/Regular.
mRegular (14px) is the default body style.
Shadow — two elevations, chosen by intent rather than depth:
shadow.base— ambient. Cards, panels, surfaces that sit within the page.shadow.popup— tighter. Dropdowns, menus, popovers; a wide spread makes a floating surface read as part of the layout.
Component CSS properties
Every component reads its metrics from a CSS variable with the token as
fallback — height: var(--gr-button-height-medium, 36px). An app can retune a
component without forking it:
.compact-toolbar {
--gr-button-height-medium: 28px;
}
Use a prop for a choice the system offers (size, variant). Use a CSS
variable to retune the system for an app or region. Do not use variables to
make one component impersonate another.
Note: component sizes are the one set of values not extracted from Figma — the guidebook has no component specs. See docs/component-css-properties.md.
CRM stage colors
Pipeline UI must use the stage prop rather than picking colors by hand:
<Badge stage="qualified">Qualified</Badge>
Stages: new, contactLater (unqualified) · interested, booked,
happened, qualified, converted (pipeline) · unreachable,
notInterested (lost).
Legacy antd
GigRadar no longer builds on antd. Some app repos still list antd 4.x as a dependency from before the design system existed.
Do not add new antd usage. Do not reach for theme.useToken() or
ConfigProvider — those are antd APIs and have no role here. Tokens come from
@gigradar/ui or @gigradar/theme, as described above.
When you encounter existing antd usage, leave it alone unless the task is to
migrate it. If you do migrate something, note that our component APIs differ
from antd's — our Button uses variant="primary" where antd used
type="primary", and variant="danger" where antd used a danger boolean.
Deprecations in effect
color.deprecated.errorAlt— usecolor.status.error. Figma had two near-duplicate reds;#FA3737is canonical.
Text input
TextField is the system's single-line input. Use it rather than a bare
<input> or an antd Input — it carries the label, the four drawn states, and
the two behaviours every credential form was otherwise rebuilding:
<TextField label="Client ID" labelIcon={IconClientIdPeopleStroke} placeholder="Input Client ID" />
<TextField label="Secret Key" secret /> // masks the value, adds a reveal control
<TextField label="Client ID" error="Wrong format." /> // flag or message
error takes either a boolean or a node, because an error is the only state a
caller sets deliberately — hover and focus come from the pointer and the
keyboard, so the component owns those.
Render props on higher-level components
Higher-level components — Tooltip, ConfirmTooltip, Pagination — take a
render prop for the part they compose:
// Replace the composed part…
<Tooltip content="Save" renderCard={({ content }) => <MyCard>{content}</MyCard>}>
<Button>Save</Button>
</Tooltip>
// …or call defaultRender() to decorate rather than replace.
<Tooltip content="Save" renderCard={({ defaultRender }) => <Glow>{defaultRender()}</Glow>}>
<Button>Save</Button>
</Tooltip>
The component keeps the parts that are hard to get right — positioning, hover and focus wiring, keyboard handling, ARIA relationships — and hands you the composition.
Low-level components do NOT take render props, on purpose. Button,
Badge, Avatar, Checkbox, Switch, and Spinner are settled decisions:
there is one right way to draw a button. If one of those needs different
markup, that is a new component or a new variant, not a hook into its
internals.
Before reaching for a render prop, check the existing props. A render prop that only reproduces the default is a copy that silently stops tracking the design system when the component changes.
This document is a summary, not the source of truth
The lists above — token groups, CSS properties, deprecations — are a snapshot. The design system ships new versions, so anything enumerated here can be behind what the app actually has installed.
Before claiming a component, prop, or token does not exist, verify it. The installed package is authoritative:
# Every export the installed version actually has
grep "^export" node_modules/@gigradar/ui/dist/index.d.ts
# Same for tokens
grep "^export" node_modules/@gigradar/theme/dist/index.d.ts
Working inside the design system repo itself, read packages/ui/src/index.ts —
that barrel is the single import surface, and a component missing from it does
not exist as far as the apps are concerned.
Saying "there is no DatePicker, ask for one to be added" when DatePicker ships
in the installed version is worse than saying nothing: it is confident, wrong,
and sends the developer to build a duplicate.
Check the installed version is current
A component can exist in the design system and still be absent from the app,
because the app is pinned to an older version. When something is genuinely
missing from node_modules, check whether it is missing from the system or
only from this app:
# What the app has
node -p "require('@gigradar/ui/package.json').version"
# What is published
npm view @gigradar/ui version --registry=https://npm.pkg.github.com
# Or both at once
npm outdated @gigradar/ui
If the app is behind, say so and recommend the upgrade rather than reporting the component as missing:
npm update @gigradar/ui @gigradar/theme # within the caret — patch + minor
npm install @gigradar/ui@latest # crossing a major, deliberate
npm install alone will not do it. The caret range allows the newer version but
package-lock.json pins the exact one, so the lock has to be moved with
npm update.
Check the changelog for breaking changes before crossing a major — that bump means the app has code to change.
npm viewreturning404is an auth failure, not a missing package. GitHub Packages returns404rather than401for private packages the caller cannot see. If you get404 ... does not exist under owner "gigradar", the token is missing, expired, fine-grained instead of classic, or lacksread:packages. Do not conclude the package was unpublished.
When something is missing
If a component, variant, or token you need does not exist, do not work around it with a hardcoded value or a one-off local component. Say what is missing and what you would add. The design system is meant to grow — additions are cheap, divergence is not.
Verify first. Check the installed package's exports, then check whether the
app is simply behind a published version — see the two sections above. "It does
not exist" is a claim about the system; make sure it is not really a claim about
this app's node_modules.