FAQs

This FAQ addresses common questions about the Akinon UI ecosystem, its architecture, and how to use its public npm packages.

What is Akinon UI?

Akinon UI is the umbrella term for all user interface technologies, component libraries, and architectural standards developed by Akinon. It includes the UI Kit, UI Protocol, and application frameworks for building modern, consistent, and scalable web applications.

What is the difference between UI Kit and UI Protocol?

• UI Kit is a reusable component library published on npm, providing ready-to-use, design-consistent UI elements for any frontend project.

• UI Protocol is the architectural standard and set of integration rules that define how UI Kit, Shell App, Client App, and plugin/fullpage concepts work together. UI Protocol ensures seamless interoperability and a unified developer experience.

Can I use Akinon UI Kit in my own project?

Yes. The Akinon UI Kit is published on npm and can be installed in any compatible React project. It is designed for easy integration and theming.

What is a Shell App?

A Shell App is the main host application in the Akinon UI Protocol architecture. It manages navigation, layout, and micro-frontend integration, and serves as the container for Client Apps, plugins, and fullpage apps.

What is a Client App?

A Client App is an independent application or module that runs inside the Shell App. It typically provides a specific business function or page and can be rendered as a fullpage or plugin.

What is the difference between a Fullpage and a Plugin?

• Fullpage: A Client App rendered as a full viewport page, usually representing a standalone workflow or application.

• Plugin: A smaller app or component rendered in a specific area (e.g., sidebar, panel) of the Shell App, without taking over the entire screen.

What is a Hybrid App?

A Hybrid App is a Client App that can function as both a fullpage and a plugin, adapting to different roles as needed. This enables flexible integration and reuse within the Shell App.

Is the Akinon UI Protocol open source?

The UI Kit and related npm packages are public, but the full UI Protocol architecture, Shell App, and integration code may not be open source. Public documentation covers all npm-available components and their usage.

How do I get support or report issues?

For support requests or to report issues related to public npm packages, please use our service desk: https://omniplatform.atlassian.net/servicedesk/customer/portal/16

---

If you have a question not covered here, please refer to the relevant package documentation or reach out to the maintainers.