Project 5 Documentation

Comprehensive guides, API references, and technical specifications to help you build with Project 5.

← Back to Home

Getting Started

Installation


# Using NPM
npm install @project5/core

# Or via CDN
<script src="https://cdn.project5.dev/core.js"></script>

Project 5 is framework-agnostic and can be used in any modern JS environment. The core package provides the foundational components, while optional plugins extend functionality for common UI patterns.

Basic Usage

import { Project5 } from '@project5/core'

Project5.init({
  theme: 'dark',
  debugMode: true
})

This initializes the library with a dark theme and enables debug logging for development purposes.

API Reference

Core Methods

  • init() Initialize the library with configuration
  • destroy() Clean up instances and listeners
  • getConfig() Retrieve current configuration

Configuration

{
  theme: string = 'system',
  debugMode: boolean = false,
  i18n: object = { },
  plugins: Array<Plugin> = []
}

Configure the library with theme preferences, internationalization options, and plugin integrations.

Technical Architecture

Core Principles

  • Modular architecture with plugin ecosystem
  • State-driven design with reactivity hooks
  • Shadow DOM isolation for components

Supported Features

Responsive Layouts

Accessibility (A11Y)

TypeScript Support

Custom Themes