Skip to content

AI-COMPONENT-INDEX.md

Latest commit

 

History

History
55 lines (45 loc) · 4.33 KB

AI-COMPONENT-INDEX.md

File metadata and controls

55 lines (45 loc) · 4.33 KB
Raw

EDS 2.0 Component Index (/next)

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.

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.

  • Source path: packages/eds-core-react/src/components/next/<Component>/
  • Top-level barrel: packages/eds-core-react/src/components/next/index.ts
  • Components: 23 • Props documented: 96 • With JSDoc description: 1

Components

Component Description Props Sub-components asChild Status
Accordion — exclusive Accordion.Item, Accordion.Header, Accordion.Panel — active
Autocomplete — allowCustomValue, clearLabel, defaultInputValue, description, helperMessage, id, inputValue, label, loading, loadingText, noOptionsText, onClear, onCustomValueConfirm, onInputChange, onValueChange, optionsFilter, value — — active
Badge — emphasis, tone, variant — — active
Banner — onDismiss, role, tone Banner.Icon, Banner.Message, Banner.Actions — active
Button — asChild, icon, multiline, round, size, tone, variant — ✓ active
Checkbox — disabled, helperMessage, indeterminate, indicator, label — — active
Chip — dropdown, onDelete, selected, tone, variant — — active
Dialog — onOpenChange, open, scrim Dialog.Header, Dialog.Title, Dialog.Content, Dialog.Actions — active
Divider — — — — active
Field — disabled, position Field.Label, Field.Description, Field.HelperMessage — active
Icon Icon component for EDS 2.0 color, data, size, title — — active
Input — as, containerClassName, endAdornment, endText, hideErrorIcon, invalid, startAdornment, startText — — active
Link — asChild, variant — ✓ active
Menu — — — — active
MenuItem — active — — active
Radio — label — — active
Search — clearLabel, description, helperMessage, id, label, onClear — — active
Select — description, helperMessage, id, indicator, invalid, label, options, placeholder, readOnly — — active
Slot — — — — active
Switch — label — — active
TextArea — description, helperMessage, id, indicator, invalid, label, labelInfo, maxRows, showCharacterCount — — active
TextField — description, helperMessage, id, indicator, label, labelInfo — — active
Tooltip — disabled, placement, title — — active

Field reference

  • 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.
  • 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.
  • 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.
  • asChild — ✓ if the component supports the asChild polymorphism pattern (see Slot/README.md).
  • Status — active unless the props type carries an @deprecated JSDoc tag.

Out of scope

  • Components outside /next (legacy packages/eds-core-react/src/components/)
  • Other packages (eds-data-grid-react, eds-lab-react)
  • Per-prop type signatures (names only)
  • Storybook links