FoundryKit

API

Public type exports from @foundrykit/types.

API

import type {
  AdditionalImports,
  AnimationConfig,
  BlockConfig,
  CLIConfig,
  ComponentCategory,
  ComponentConfig,
  ComponentData,
  ComponentFile,
  ComponentFileType,
  ComponentMeta,
  ComponentPreview,
  ComponentVariant,
  ComponentVariantPreview,
  Config,
  DependencyResolution,
  LocalCache,
  RegistryComponent,
  RegistryData,
  RegistryError,
  RegistryIndex,
  RegistryQuery,
  SearchResult,
  SearchSection,
  SpecialDependency,
} from '@foundrykit/types';

Highlights

  • Config models the FoundryKit project config file shape consumed by the CLI.
  • ComponentMeta, ComponentData, and related registry types model registry payloads and dependency resolution.
  • SearchResult and SearchSection are shared with the search UI exposed by Components.
  • ComponentConfig, BlockConfig, and AnimationConfig describe the registry-side metadata used to generate component data.

On this page