Skip to content

API Reference

This section provides technical reference documentation for Katalyst's public APIs.

What this section is

  • Function signatures and type definitions
  • Props tables for components
  • Return types and parameters
  • Minimal code examples (one per API)

How it differs from other sections

SectionPurpose
PrimitivesExplains why and when to use hooks
PatternsShows how to combine hooks for common workflows
ComponentsDescribes component purpose and usage patterns
API ReferenceDocuments what the API is (signatures, types, props)

When to use this section

Use the API Reference when you:

  • Need exact function signatures
  • Want to check available parameters or options
  • Need to understand return types
  • Are looking for type definitions

For conceptual understanding, start with Primitives or Patterns.

Contents

Hooks API

Components API