# Native Federation

> Native Federation is a browser-native implementation of Module Federation for building Micro Frontends using web standards (ESM + Import Maps). It provides a shared API across build tools (esbuild, Angular CLI, Vite) and a runtime that wires remotes into a host via a generated import map.

This file indexes the full Native Federation documentation for LLMs and AI coding tools. Each link points to a standalone markdown version of the corresponding docs page, mirroring the site's folder structure. Tools that need a narrower context can skip the "Optional" section at the bottom.

The ecosystem is split into four layers:

- **Core** (`@softarc/native-federation`) — the tooling-agnostic builder that consumes a `federation.config.js` and produces a `remoteEntry.json` plus an import map.
- **Runtime** (`@softarc/native-federation-runtime`) — loads the import map in the browser and resolves remote modules.
- **Adapters** — wire the core into a specific build tool (esbuild, Vite, Angular CLI).
- **Orchestrator** (`@softarc/native-federation-orchestrator`) — optional host-side layer for version negotiation across many remotes.

## Getting Started

- [Overview](https://native-federation.com/docs/getting-started.md): switchboard linking to every section's getting-started page
- [Architecture Overview](https://native-federation.com/docs/architecture.md): how hosts, remotes, the builder, and the runtime fit together
- [The Mental Model](https://native-federation.com/docs/mental-model.md): core concepts for reasoning about Native Federation
- [Terminology](https://native-federation.com/docs/terminology.md): glossary of host, remote, shared, exposed, import map, etc.
- [Coming from Module Federation?](https://native-federation.com/docs/example.md): the original webpack Module Federation plugin example, migrated to Native Federation
- [v3 vs v4](https://native-federation.com/docs/v3-vs-v4.md): what changed between majors
- [Migration to v4](https://native-federation.com/docs/migration.md): upgrade steps from v3

## Orchestrator

- [Overview](https://native-federation.com/docs/orchestrator/index.md): what the orchestrator solves and when to use it
- [Getting Started](https://native-federation.com/docs/orchestrator/getting-started.md)
- [Architecture](https://native-federation.com/docs/orchestrator/architecture.md): internal design and extension points
- [Configuration](https://native-federation.com/docs/orchestrator/configuration.md): every config option
- [Version Resolver](https://native-federation.com/docs/orchestrator/version-resolver.md): how shared-dependency version conflicts are resolved

## Core (@softarc/native-federation)

- [Overview](https://native-federation.com/docs/core/index.md): what the core package does and its public surface
- [Getting Started](https://native-federation.com/docs/core/getting-started.md): install, minimal config, wire the builder
- [federation.config.mjs](https://native-federation.com/docs/core/configuration.md): every option on `withNativeFederation`
- [Sharing Dependencies](https://native-federation.com/docs/core/sharing.md): `share`, `shareAll`, secondary entry points
- [Build Process](https://native-federation.com/docs/core/build-process.md): the `federationBuilder` lifecycle including watch mode
- [Caching](https://native-federation.com/docs/core/caching.md): how the builder caches shared bundles
- [Build Adapters](https://native-federation.com/docs/core/build-adapters.md): the `NFBuildAdapter` contract
- [Build Artifacts](https://native-federation.com/docs/core/artifacts.md): `remoteEntry.json` and the generated import map
- [API Reference](https://native-federation.com/docs/core/api-reference.md): exported functions and types

## Runtime

- [Overview](https://native-federation.com/docs/runtime/index.md)
- [Getting Started](https://native-federation.com/docs/runtime/getting-started.md)
- [initFederation](https://native-federation.com/docs/runtime/init-federation.md): bootstrap the host
- [loadRemoteModule](https://native-federation.com/docs/runtime/load-remote-module.md): resolve and import a remote module at runtime
- [The Import Map](https://native-federation.com/docs/runtime/import-map.md): how the runtime builds and injects the import map
- [API Reference](https://native-federation.com/docs/runtime/api-reference.md)

## Adapters

- [Overview](https://native-federation.com/docs/adapters/index.md): which adapters exist and when to use each
- [Build Your Own](https://native-federation.com/docs/adapters/build-your-own.md): implement `NFBuildAdapter` for a new bundler

## esbuild Adapter

- [Overview](https://native-federation.com/docs/adapters/esbuild/index.md)
- [Getting Started](https://native-federation.com/docs/adapters/esbuild/getting-started.md)
- [Builder](https://native-federation.com/docs/adapters/esbuild/builder.md)
- [Adapter Configuration](https://native-federation.com/docs/adapters/esbuild/configuration.md)
- [React & CJS Interop](https://native-federation.com/docs/adapters/esbuild/react-interop.md): working with CommonJS and React ecosystems

## Angular Adapter

- [Overview](https://native-federation.com/docs/angular-adapter/index.md)
- [Getting Started](https://native-federation.com/docs/angular-adapter/getting-started.md)
- [Builder](https://native-federation.com/docs/angular-adapter/builder.md): the Angular CLI builder
- [Schematics](https://native-federation.com/docs/angular-adapter/schematics.md): `ng add` and generators
- [Angular Config](https://native-federation.com/docs/angular-adapter/configuration.md)
- [Runtime](https://native-federation.com/docs/angular-adapter/runtime.md): Angular-specific runtime helpers
- [SSR & Hydration](https://native-federation.com/docs/angular-adapter/ssr.md)
- [I18N](https://native-federation.com/docs/angular-adapter/i18n.md): Angular internationalization integration
- [Localization](https://native-federation.com/docs/angular-adapter/localization.md)
- [Custom Builder](https://native-federation.com/docs/angular-adapter/custom-builder.md)
- [Migration to v4](https://native-federation.com/docs/angular-adapter/migration-v4.md)

## Guides

- [SSR & Hydration](https://native-federation.com/docs/ssr-hydration.md): general SSR patterns
- [Native & Module Federation](https://native-federation.com/docs/native-and-module-federation.md): interop and differences
- [Component Libs](https://native-federation.com/docs/component-libs.md): sharing component libraries

## Reference

- [FAQ](https://native-federation.com/docs/faq.md): common questions and pitfalls