> For the complete documentation index, see [llms.txt](https://docs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akinon.com/akinon-ui/ui-protocol.md).

# UI Protocol

- [Usage](https://docs.akinon.com/akinon-ui/ui-protocol/usage.md): UI Protocol is Akinon's micro-frontend communication framework, enabling seamless data exchange and interaction between host applications and embedded micro-frontends.
- [Quick Start](https://docs.akinon.com/akinon-ui/ui-protocol/quick-start.md): Create and run your first UI Protocol client application in under 5 minutes.
- [ACC Integration](https://docs.akinon.com/akinon-ui/ui-protocol/acc-integration.md): Register and configure your UI Protocol client application in Akinon Commerce Cloud (ACC).
- [Shell Application](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application.md)
- [Introduction](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/introduction.md): AppShell is the core library for building shell (host) applications in the UI Protocol ecosystem.
- [Configuration](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/configuration.md)
- [Data Sharing](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/configuration/data-sharing.md): AppShell's data sharing feature allows you to share your main application's data with micro-frontend applications.
- [Actions](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/configuration/actions.md): The AppShell library enables seamless interaction between the shell and its micro-frontends through a robust action system.
- [Navigation](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/configuration/navigation.md): AppShell's navigation helpers allow micro-frontend applications to trigger navigation in the main application.
- [i18n](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/i18n.md): Akilocale wraps i18next, react-i18next, and i18next-http-backend, providing a consistent and pre-configured way to translate texts in both shell and client applications.
- [useAppShell](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/useappshell.md): The primary hook for accessing the shell context. It provides access to registered apps, configurations, navigation, and iframe references.
- [Components](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/components.md)
- [API Reference](https://docs.akinon.com/akinon-ui/ui-protocol/shell-application/api-reference.md): Complete API reference for the @akinon/app-shell package, including components, hooks, and type definitions.
- [Client Application](https://docs.akinon.com/akinon-ui/ui-protocol/client-application.md)
- [Introduction](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/introduction.md): This library provides a React context and hooks for enabling inter-app communication, navigation, and other essential functionalities.
- [Configuration](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/configuration.md)
- [Actions](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/configuration/actions.md): Client applications can invoke actions defined in the shell application.
- [Navigation](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/configuration/navigation.md): This allows micro-frontends to redirect users to different routes managed by the shell without direct access to the shell's router.
- [i18n](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/i18n.md)
- [useAppClient](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/useappclient.md)
- [API Reference](https://docs.akinon.com/akinon-ui/ui-protocol/client-application/api-reference.md)
- [Examples](https://docs.akinon.com/akinon-ui/ui-protocol/examples.md): This section provides complete working examples for different UI Protocol application types.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.akinon.com/akinon-ui/ui-protocol.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.