The complete API reference, generated from the library’s JSDoc with TypeDoc, is at /api/. Every prop table on the component pages is generated from the same source.
| Import |
Contents |
@yarcl/react |
components, toast, token types, the resolved config |
@yarcl/react/define |
defineConfig and the config types |
@yarcl/react/defaults |
the library’s default config, for spreading |
@yarcl/react/vite |
Vite plugin |
@yarcl/react/webpack |
webpack plugin |
@yarcl/react/rspack |
Rspack plugin |
@yarcl/react/rollup |
Rollup plugin |
@yarcl/react/esbuild |
esbuild plugin |
@yarcl/react/reference |
DesignReference |
@yarcl/react/generate |
generateCss and generateTokensCss for Node build scripts |
| Group |
Exports |
| Buttons |
Button, IconButton, ButtonGroup, SplitButton, ToggleGroup |
| Forms |
Field, Label, Input, NumberInput, ColorPicker, Textarea, Select, Combobox, DatePicker, Checkbox, Radio, RadioGroup, Switch, Slider |
| Navigation |
NavItem, NavSection, TreeView, Stepper |
| Typography |
Text, Heading, Link |
| Layout |
AppLayout, SplitPane, Stack, Inline, Grid, Card, Divider, VisuallyHidden |
| Overlays |
Dialog, Drawer, Popover, Tooltip, HoverCard, Menu, CommandPalette, Toaster, toast |
| Data display |
Avatar, AvatarGroup, Tabs, Accordion, Table (resizable columns and visibility controls), Pagination, Breadcrumb |
| Feedback |
Badge, Alert, Spinner, Skeleton, Progress, EmptyState |
| Type |
Meaning |
Size, Radius, Color, Variant |
keys of sizes, radii, colors, variants in your config |
ComponentSize<'Button'> |
allowed size keys for one component, or every global size when unrestricted |
Spacing, Shadow, Density, TextStyle |
keys of spacing, shadows, density, typography.styles |
Responsive<T> |
scalar value or readonly map of base and configured breakpoint names; see responsive props |
Width, Breakpoint |
keys of widths and breakpoints |
ModalSize |
keys of modalSizes |
TokenProps, VariantProps |
the shared size / radius / color and variant props |
SelectOption |
{ value, label, disabled? } for Select and Combobox |
DateRange |
{ from, to } for DatePicker in range mode |
YarclShape, ColorToken, SizeToken, VariantToken, … |
the config schema, from @yarcl/react/define |
