<!-- Documentation snapshot: package 5.0.0-rc.2; channel latest; archived channel latest; base revision f4243b8334cafe0bd1b06eba85d87e2310cb3618; local changes false; original source SHA-256 3f287a77eeb0aa0467ff9ee18fc502d4f5bc28425a4e372529a8c06358b6117f; reading source revision f4243b8334cafe0bd1b06eba85d87e2310cb3618; publication edits /docs/publication.json. -->

# API reference

These references target **5.0.0-rc.2**. Use the page for the class or contract you need. Class pages define supported APIs and link shared contracts; task guides show how to use them.

## Core classes

| Class | Reference scope |
| --- | --- |
| [View](/docs/api/view.md) | Construction, rendering, UI bindings, named Regions, lifecycle, ownership, and extension points. |
| [Region](/docs/api/region.md) | Showing, replacing, detaching and emptying Views; element configuration and lifecycle. |
| [Application](/docs/api/application.md) | Preparation, lifecycle results/cancellation, restart, child Applications, root ownership, state and Radio bindings. |
| [CollectionView](/docs/api/collection-view.md) | Collection observation, sorting/filtering, empty presentation, child lookup/ownership, rendering and lifecycle. |
| [Behavior](/docs/api/behavior.md) | Host composition, reusable local interaction, UI/data bindings, forwarded events, and teardown. |
| [MnObject](/docs/api/mnobject.md) | Nonvisual objects, construction, state/Radio bindings, and synchronous destruction. |

## Shared class contracts

These behaviors apply across several classes. Class pages link to the relevant contracts.

- [Common class methods](/docs/api/shared/common.md): construction, extension, options and binding helpers.
- [Events](/docs/api/shared/events.md): subscription methods, notification arguments and cleanup.
- [Errors and diagnostics](/docs/api/errors.md): error properties, diagnostic codes, and installed lookup.
- [State](/docs/api/shared/state.md): creating, borrowing, observing and disposing state.
- [Rendering and View bindings](/docs/api/shared/view-bindings.md): templates, UI, DOM/entity events and child event forwarding shared by View and CollectionView.

## Runtime configuration

[Runtime configuration](/docs/api/runtime.md) covers defaults, configuration scope, setters, and isolated class families.

## Provider interfaces

Use these contracts when implementing or adapting an integration. For configuration with supplied packages, start with the [setup guide](/docs/integrations/setup.md).

- [Rendering and DOM providers](/docs/api/providers/dom.md): Renderer, DomApi, and EventDelegator authoring contracts.
- [Data and state providers](/docs/api/providers/data.md): reading, identity, collection notifications, subscriptions, and disposal.

## Companion packages

[@mnjs/data: Model and Collection](/docs/packages/data.md) is an optional observable data solution. Its reference covers operations, events, identity, disposal, and exported types. API access and persistence require a separate solution. Marionette can use another data layer through its core provider contracts.

[@mnjs/radio: channels and requests](/docs/packages/radio.md) covers channel registries, events, replies, cleanup, logging, and standalone use.

[@mnjs/utils: shared utilities](/docs/packages/utils.md) covers standalone component methods, callbacks, object helpers, and exports. Shared Events and class methods remain at their canonical references.

[@mnjs/adapters](/docs/packages/adapters.md) covers optional data and DOM integrations, their imports, configuration, observation, and cleanup.

## Integration and task guides

[Renderer and data setup](/docs/integrations/setup.md) connects Lit and `@mnjs/data` to Marionette. Integration guides explain configuration and use; package references define the APIs supplied by each package.

[Check and debug an application](/docs/tooling.md) covers consumer lint, declaration checks, and diagnostic lookup. [Practical TypeScript](/docs/guides/typescript.md) covers options, handlers, state and lifecycle results. [Migration](/docs/guides/migration.md) and [consumer testing](/docs/guides/testing.md) provide upgrade and verification paths.

[Existing UI](/docs/guides/existing-ui.md) and [navigation](/docs/guides/routing.md) cover mounting and destination ownership. [Lists](/docs/guides/lists.md), [imperative controls](/docs/guides/widgets.md), [accessibility/rendering](/docs/guides/accessibility-rendering.md), and [production](/docs/guides/production.md) provide further task paths.

Class pages link to the relevant [shared configuration contracts](/docs/api/shared/view-bindings.md#class-configuration); Region documents its own DOM setter.

For a first runnable result, use the [quick start](/docs/quick-start.md). For composition guidance, see [architecture](/docs/architecture.md).

Detailed coverage still pending: a complete custom immutable-store integration. The [provider contracts](/docs/api/providers/data.md) describe the integration boundary. Application lifecycle details include [destination binding order](/docs/api/application.md#destination-binding-order) and [restart from start completion](/docs/api/application.md#restart-from-start-completion).


[Canonical source](/docs/markdown/docs/api.md) · [Source identity](/docs/manifest.json)
