Maintenance
Contributing
Add discoverable references and examples, review seed coverage, and validate a library upgrade.
On this page
Add a component page and example
Work from the installed, reviewed package. This reference uses local MDX and typed registrations, so changes are reviewed in Git and compiled before publication.
- Read the export’s declarations in
node_modules/@coreux/ui/distand implementation innode_modules/@coreux/ui/src. Verify default values, invalid inputs, semantics, supported appearances, and fixed geometry. - Create a complete default-exported TSX file in
src/examples/component-slug/Default.tsx. Include package imports, data, wrappers, and any required client directive. The file must work after the documented consumer setup, with no site aliases, helper files, or hidden styles. - Write usage, props, constraints, accessibility, setup, and source guidance in
src/content/components/component-slug.mdx. UseSectionHeadingwith a stable ID for every registered section. Prop tables must use the installed declaration helpers and verified implementation defaults. - Import that exact TSX default export and MDX document into
src/lib/catalog.tsor a catalog module it spreads. Register the actual export name, unique slug, category, summary, search terms, package source path, sections, and examples. Each example needs a unique per-page ID, title, description, relative TSX file path, and the matching imported Component. Supply real preview dimensions for fixed artwork. - Map each installed preview seed in
src/content/coverage.jsonto its registered example ID. Mark itincludedorreplaced, and explain any changes. Extra examples need no fictional seed entry. Guides register insrc/lib/guides.ts; patterns use the same complete example contract in their pattern registry. - Run the validation commands below, then open the generated route. Verify navigation, category filtering, search by name and alias, heading links, keyboard controls, mobile containment, and exact code/clipboard parity. Paste a representative copied file into the documented consumer setup.
The registration supplies routes, navigation, previous/next links, catalog entries, and search. Do not maintain a second manual list. tests/registration.spec.ts exercises this workflow by adding a temporary component and guide in an isolated app, building it, and visiting the generated pages.
Regenerate and validate before release
pnpm install --frozen-lockfile
pnpm generate:foundations
pnpm generate:docs
pnpm typecheck
pnpm check:coverage
pnpm lint
pnpm test
pnpm check:releasepnpm build regenerates foundation values and installed package, prop/source, and search fingerprints; renders every standalone example; and prerenders the registered pages. During prerendering, code highlighting and clipboard text are read from the same TSX files that previews import. Search records are rebuilt from current registrations and section titles. Commit reviewed changes to src/generated.
pnpm check:coverage validates construction coverage and rejects stale generated metadata. pnpm check:release is the strict release gate: it also rejects every remaining planned exception. Neither command rewrites files or hides missing coverage. Diagnostics name the missing export, seed, route, heading, duplicate ID, or source file and describe the correction.
For a work in progress only, add an entry with name and a concrete reason to the coverage manifest’s planned array. This temporarily allows a missing component registration or a synthetic construction page during local builds. It never excuses missing files, broken examples, or unaccounted seeds, and it always blocks release. Remove the exception when the reference is complete.
Update the reviewed library revision
- Review the proposed full commit hash against the current documented revision. Compare exports, declarations, source defaults, validation, design rules, fonts, and seed fixtures. Package version alone is not enough to identify this private Git dependency.
- Update the exact
@coreux/uidependency inpackage.jsonusing pnpm, review and commitpnpm-lock.yaml, and record the reviewed revision indocs/site-plan.md. Keep the minimal consumer fixture lockfile consistent with its documented setup. - Update the coverage manifest revision and review every changed export and seed. Classify utilities/constants and tokens with a real documentation destination and reason. Type-only exports are classified separately from runtime components. Deliberate removals require a changelog explanation before updating the reviewed baseline.
- Update authored prop explanations and runtime defaults, TSX examples, guide claims, and changelog upgrade notes. Regenerate metadata, run the full checks, and inspect visual changes before deploying a preview. Release only when strict coverage and browser checks pass.
The checker compares the exact package pin with pnpm’s installed revision and fingerprints the installed declaration and implementation files. A different dependency or edited declaration cannot silently reuse old generated metadata. Source links always target the documented full hash and require repository access.
Review current coverage
The installed API contains 24 components, 37 utilities and runtime constants, 66 types, and 13 foundation token groups. The original baseline is 24 components and 68 seed examples.
All 68 installed seeds have an explicit included or replaced destination. The site has 97 complete example files. Utilities and types are explained in the introduction; runtime constants live with their component’s props; tokens live in the foundation guides.
Inspect all seed example decisions
| Library seed | Decision | Destination and reason |
|---|---|---|
| BarChart/Grouped (repository access required) | included | Grouped Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| BarChart/Stacked (repository access required) | included | Stacked Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| BarChart/SingleSeries (repository access required) | included | SingleSeries Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| BrandWordmark/Wordmark (repository access required) | included | Wordmark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| BrandWordmark/Boxed (repository access required) | included | Boxed Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| Capsule/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| Capsule/WithTrailing (repository access required) | included | WithTrailing Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| Capsule/OnDark (repository access required) | included | OnDark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| Connector/Curved (repository access required) | included | Curved Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| Connector/Straight (repository access required) | included | Straight Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| Connector/Orbital (repository access required) | included | Orbital Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| CrosshairMark/Crosshair (repository access required) | included | Crosshair Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| CrosshairMark/Plus (repository access required) | included | Plus Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| CrosshairMark/OnColor (repository access required) | included | OnColor Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| DataTable/Default (repository access required) | replaced | Default Removes unsupported column format/currency fields and preserves the formatted result with the installed typed cell API. |
| DataTable/WithFooter (repository access required) | replaced | WithFooter Removes unsupported column format/currency fields and preserves the formatted result with the installed typed cell API. |
| DonutChart/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| DonutChart/DirectLabels (repository access required) | included | DirectLabels Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| EyebrowLabel/Plain (repository access required) | included | Plain Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| EyebrowLabel/WithDot (repository access required) | included | WithDot Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| EyebrowLabel/OnDark (repository access required) | included | OnDark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| FramedContent/Circle (repository access required) | included | Circle Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| FramedContent/RoundedSquare (repository access required) | included | RoundedSquare Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| FramedContent/Hexagon (repository access required) | included | Hexagon Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| GroupFrame/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| GroupFrame/Dashed (repository access required) | replaced | Dashed Replaces the unreadable light-field seed with a supported navy field and contrast-safe heading while retaining the dashed boundary. |
| HalftoneCircle/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| HalftoneCircle/OnColor (repository access required) | included | OnColor Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| HalftoneCircle/TightGrain (repository access required) | included | TightGrain Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| HandDrawnUnderline/UnderWord (repository access required) | replaced | UnderWord Uses the bundled The Seasons display font instead of the unavailable Cormorant seed font; the underline API and word emphasis are preserved. |
| HandDrawnUnderline/Thick (repository access required) | included | Thick Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| HandDrawnUnderline/OnDark (repository access required) | included | OnDark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| LineChart/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| LineChart/Compact (repository access required) | included | Compact Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| MarketingHero/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| MarketingHero/NoCta (repository access required) | included | NoCta Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| MiniChart/Bar (repository access required) | included | Bar Preserves the seed chart variant and adds complete text alternatives because the built-in SVG label is generic. |
| MiniChart/Donut (repository access required) | included | Donut Preserves the seed chart variant and adds complete text alternatives because the built-in SVG label is generic. |
| MiniChart/Trend (repository access required) | included | Trend Preserves the seed chart variant and adds complete text alternatives because the built-in SVG label is generic. |
| PanelCard/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| PanelCard/Bucket (repository access required) | included | Bucket Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ProcessSteps/FourStep (repository access required) | included | FourStep Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ProcessSteps/OnDark (repository access required) | included | OnDark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ProgressMeter/Default (repository access required) | included | Default Preserves the seed appearance and value, adding one named progressbar around the hidden unnamed library visual. |
| ProgressMeter/Positive (repository access required) | included | Positive Preserves the seed appearance and value, adding one named progressbar around the hidden unnamed library visual. |
| ProgressMeter/OnDark (repository access required) | included | OnDark Preserves the seed appearance and value, adding one named progressbar around the hidden unnamed library visual. |
| RichTextOverlay/Default (repository access required) | included | Default Preserves the actual seed output and explicitly documents its clipped final-line underline; FirstLineEmphasis supplies an additional visible alternative. |
| RichTextOverlay/WithMarker (repository access required) | included | WithMarker Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| RichTextOverlay/OnDark (repository access required) | included | OnDark Preserves the actual seed output and explicitly documents its clipped final-line underline; FirstLineEmphasis supplies an additional visible alternative. |
| ShortformCover/TextHook (repository access required) | included | text-hook Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ShortformCover/ExpertPov (repository access required) | included | expert-pov Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ShortformCover/DataLed (repository access required) | included | data-led Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ShortformCover/SystemsExplainer (repository access required) | included | systems-explainer Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ShortformCover/CaseStudy (repository access required) | included | case-study Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| ShortformCover/Announcement (repository access required) | included | announcement Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SocialCarouselSlide/Hook (repository access required) | included | hook Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SocialCarouselSlide/StatHeadline (repository access required) | included | stat-headline Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SocialCarouselSlide/StatBreakdown (repository access required) | included | stat-breakdown Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SocialCarouselSlide/Process (repository access required) | included | process Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SocialCarouselSlide/Cta (repository access required) | included | cta Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SpeechBubble/Default (repository access required) | included | Default Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SpeechBubble/TailLeft (repository access required) | included | TailLeft Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| SpeechBubble/OnDark (repository access required) | included | OnDark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| StatBlock/Large (repository access required) | included | Large Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| StatBlock/Small (repository access required) | included | Small Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| StatBlock/OnDark (repository access required) | included | OnDark Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| TechnicalCollage/Blueprint (repository access required) | included | Blueprint Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
| TechnicalCollage/Collage (repository access required) | included | Collage Preserves the seed variant in a standalone TSX file, with complete layout and illustrative content. |
Inspect non-component export classifications
barChartLayouts· utilities- Public runtime contract or geometry helper; documented with its owning component props.
barChartMaximumCategories· utilities- Public runtime contract or geometry helper; documented with its owning component props.
barChartMaximumSeries· utilities- Public runtime contract or geometry helper; documented with its owning component props.
barChartOrientations· utilities- Public runtime contract or geometry helper; documented with its owning component props.
borderTokens· tokens- Public foundation token group; documented as values, not a React component.
capsuleTextLineOptions· utilities- Public runtime contract or geometry helper; documented with its owning component props.
categoricalPalette· tokens- Public foundation token group; documented as values, not a React component.
cn· utilities- Class-name composition helper; documented in onboarding.
connectorLabelMaximumCharacters· utilities- Public runtime contract or geometry helper; documented with its owning component props.
connectorPathVariants· utilities- Public runtime contract or geometry helper; documented with its owning component props.
connectorStrokeStyles· utilities- Public runtime contract or geometry helper; documented with its owning component props.
coreuxPalette· tokens- Public foundation token group; documented as values, not a React component.
dataTableCellTypes· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableColumnAlignments· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableHeaderHeight· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableMaximumColumns· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableMaximumRows· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableMinimumColumns· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableMinimumRows· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableMinimumWidth· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableNumberFormats· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableRowHeight· utilities- Public runtime contract or geometry helper; documented with its owning component props.
dataTableStatusTones· utilities- Public runtime contract or geometry helper; documented with its owning component props.
decorationTokens· tokens- Public foundation token group; documented as values, not a React component.
donutChartMaximumSegments· utilities- Public runtime contract or geometry helper; documented with its owning component props.
donutChartMinimumSegments· utilities- Public runtime contract or geometry helper; documented with its owning component props.
fieldModeTokens· tokens- Public foundation token group; documented as values, not a React component.
foundationTokens· tokens- Public foundation token group; documented as values, not a React component.
frameShapes· utilities- Public runtime contract or geometry helper; documented with its owning component props.
getDataTableGeometry· utilities- Public runtime contract or geometry helper; documented with its owning component props.
groupBoundaryStyles· utilities- Public runtime contract or geometry helper; documented with its owning component props.
groupHeadingMaximumCharacters· utilities- Public runtime contract or geometry helper; documented with its owning component props.
lineChartMaximumPoints· utilities- Public runtime contract or geometry helper; documented with its owning component props.
lineChartMaximumSeries· utilities- Public runtime contract or geometry helper; documented with its owning component props.
lineChartMinimumPoints· utilities- Public runtime contract or geometry helper; documented with its owning component props.
panelSupportingCopyMaximumLines· utilities- Public runtime contract or geometry helper; documented with its owning component props.
panelSurfaces· utilities- Public runtime contract or geometry helper; documented with its owning component props.
panelTitleMaximumLines· utilities- Public runtime contract or geometry helper; documented with its owning component props.
radiusTokens· tokens- Public foundation token group; documented as values, not a React component.
richTextMarkerKinds· utilities- Public runtime contract or geometry helper; documented with its owning component props.
richTextMaximumCharactersPerLine· utilities- Public runtime contract or geometry helper; documented with its owning component props.
semanticColors· tokens- Public foundation token group; documented as values, not a React component.
spacingTokens· tokens- Public foundation token group; documented as values, not a React component.
speechBubbleMaximumCharactersPerLine· utilities- Public runtime contract or geometry helper; documented with its owning component props.
speechBubbleTailAlignments· utilities- Public runtime contract or geometry helper; documented with its owning component props.
speechBubbleTailSides· utilities- Public runtime contract or geometry helper; documented with its owning component props.
strokeTokens· tokens- Public foundation token group; documented as values, not a React component.
structuralColors· tokens- Public foundation token group; documented as values, not a React component.
toneTokens· tokens- Public foundation token group; documented as values, not a React component.
typographyTokens· tokens- Public foundation token group; documented as values, not a React component.
Type-only exports are extracted from the installed declarations: BarChartCategory BarChartDomain BarChartEmphasis BarChartLayout BarChartOrientation BarChartProps BarChartSeries BrandWordmarkProps CapsuleProps ChartDatum ConnectorAnchor ConnectorPathVariant ConnectorProps ConnectorStrokeStyle CrosshairMarkProps DataTableActiveRow DataTableCell DataTableCellType DataTableColumn DataTableColumnAlignment DataTableGeometry DataTableIconCell DataTableNumberCell DataTableNumberFormat DataTableProps DataTableRow DataTableStatusCell DataTableStatusChange DataTableStatusTone DataTableTextCell DataTableValueChange DonutChartEmphasis DonutChartProps DonutChartSegment EyebrowLabelProps FieldMode FrameShape FramedContentProps GroupBoundaryStyle GroupFrameProps HalftoneCircleProps HandDrawnUnderlineProps LineChartDomain LineChartProps LineChartSeries MarketingHeroProps MiniChartProps PanelCardProps PanelSurface ProcessStep ProcessStepsProps ProgressMeterProps RichTextLine RichTextMarker RichTextOverlayProps RichTextSpan SharedTone ShortformCoverProps SocialCarouselSlideProps SpeechBubbleProps SpeechBubbleTailAlignment SpeechBubbleTailSide StatBlockProps TechnicalCollageProps ToneTokens TrendSeries .