|
| 1 | +<!-- AUTOGENERATED by scripts/generate-component-index.js — do not edit by hand. --> |
| 2 | +<!-- Re-run: pnpm run generate:component-index --> |
| 3 | + |
| 4 | +# EDS 2.0 Component Index (`/next`) |
| 5 | + |
| 6 | +This file is the canonical "what already exists" reference for AI coding assistants working in this repo. It is regenerated from the source on every `pnpm run build`. |
| 7 | + |
| 8 | +**If you are an AI assistant about to scaffold a new component: check this file first.** The component you are about to build may already exist. |
| 9 | + |
| 10 | +- Source path: `packages/eds-core-react/src/components/next/<Component>/` |
| 11 | +- Top-level barrel: `packages/eds-core-react/src/components/next/index.ts` |
| 12 | +- Components: 23 • Props documented: 96 • With JSDoc description: 1 |
| 13 | + |
| 14 | +## Components |
| 15 | + |
| 16 | +| Component | Description | Props | Sub-components | asChild | Status | |
| 17 | +| --- | --- | --- | --- | --- | --- | |
| 18 | +| Accordion | — | exclusive | Accordion.Item, Accordion.Header, Accordion.Panel | — | active | |
| 19 | +| Autocomplete | — | allowCustomValue, clearLabel, defaultInputValue, description, helperMessage, id, inputValue, label, loading, loadingText, noOptionsText, onClear, onCustomValueConfirm, onInputChange, onValueChange, optionsFilter, value | — | — | active | |
| 20 | +| Badge | — | emphasis, tone, variant | — | — | active | |
| 21 | +| Banner | — | onDismiss, role, tone | Banner.Icon, Banner.Message, Banner.Actions | — | active | |
| 22 | +| Button | — | asChild, icon, multiline, round, size, tone, variant | — | ✓ | active | |
| 23 | +| Checkbox | — | disabled, helperMessage, indeterminate, indicator, label | — | — | active | |
| 24 | +| Chip | — | dropdown, onDelete, selected, tone, variant | — | — | active | |
| 25 | +| Dialog | — | onOpenChange, open, scrim | Dialog.Header, Dialog.Title, Dialog.Content, Dialog.Actions | — | active | |
| 26 | +| Divider | — | — | — | — | active | |
| 27 | +| Field | — | disabled, position | Field.Label, Field.Description, Field.HelperMessage | — | active | |
| 28 | +| Icon | Icon component for EDS 2.0 | color, data, size, title | — | — | active | |
| 29 | +| Input | — | as, containerClassName, endAdornment, endText, hideErrorIcon, invalid, startAdornment, startText | — | — | active | |
| 30 | +| Link | — | asChild, variant | — | ✓ | active | |
| 31 | +| Menu | — | — | — | — | active | |
| 32 | +| MenuItem | — | active | — | — | active | |
| 33 | +| Radio | — | label | — | — | active | |
| 34 | +| Search | — | clearLabel, description, helperMessage, id, label, onClear | — | — | active | |
| 35 | +| Select | — | description, helperMessage, id, indicator, invalid, label, options, placeholder, readOnly | — | — | active | |
| 36 | +| Slot | — | — | — | — | active | |
| 37 | +| Switch | — | label | — | — | active | |
| 38 | +| TextArea | — | description, helperMessage, id, indicator, invalid, label, labelInfo, maxRows, showCharacterCount | — | — | active | |
| 39 | +| TextField | — | description, helperMessage, id, indicator, label, labelInfo | — | — | active | |
| 40 | +| Tooltip | — | disabled, placement, title | — | — | active | |
| 41 | + |
| 42 | +## Field reference |
| 43 | + |
| 44 | +- **Description** — first paragraph of the JSDoc above the component's `forwardRef` declaration (also tries `<Name>Component` / `<Name>Root` for compound components), with the `<Name>Props` type alias as fallback. `—` means no JSDoc is present yet; consider adding one. |
| 45 | +- **Props** — EDS-defined props only, from the `<Name>Props` type literal. Intersected HTML attributes (`HTMLAttributes<...>`, `InputHTMLAttributes<...>`, etc.) and React-conventional props (`children`, `className`, `style`, `ref`, `key`) are NOT listed — assume the standard DOM props for the underlying element are available. Known limitation: only inline type literals and intersections are walked — props coming from a referenced local type alias (`type FooProps = SharedBase & {...}`) or a union type are not expanded. |
| 46 | +- **Sub-components** — compound sub-components attached via the `Compound<Name>` type pattern (e.g. `Field.Label`, `Banner.Icon`). Standalone components exported from the same directory (e.g. `MenuItem` from `./Menu`) appear as their own rows. |
| 47 | +- **asChild** — `✓` if the component supports the `asChild` polymorphism pattern (see `Slot/README.md`). |
| 48 | +- **Status** — `active` unless the props type carries an `@deprecated` JSDoc tag. |
| 49 | + |
| 50 | +## Out of scope |
| 51 | + |
| 52 | +- Components outside `/next` (legacy `packages/eds-core-react/src/components/`) |
| 53 | +- Other packages (`eds-data-grid-react`, `eds-lab-react`) |
| 54 | +- Per-prop type signatures (names only) |
| 55 | +- Storybook links |
0 commit comments