Getting started
What the kit is, how to install it, and the pieces every application sets up once: the theme and translation providers, the API client, and the hooks, utilities and constants the components share.
Overview
The following pages are available:
| Page | Description |
|---|---|
| Welcome | What the kit is, how it is installed and the providers every application mounts. |
| Installation and setup | Everything a React application needs to do once, before any component of this kit renders correctly: install it, mount two providers, and know which import forms exist. |
| Catalogue | Every component this package ships, what it is for, and how it is imported. |
| Structure | @onlyoffice/apps-ui-kit is a standalone repository. |
| Themes | The UI Kit ships with Base (light) and Dark themes. |
| Translation | The UI Kit uses i18next and react-i18next for internationalization. |
| Agent skills | The ui-kit skill teaches an AI coding agent to build screens with this kit in your own React app: which component fits the job, what its props are called, how to install and theme it, and a check it runs on the result. |
| API | The UI Kit uses ApiProvider to give components access to the ONLYOFFICE Apps REST API. |
| Types and roles | What a person may do in ONLYOFFICE Apps depends on two separate things. |
| Hooks | Eleven hooks, barrelled in hooks/index.ts and re-exported from the package root. |
| Utils | utils/ holds the non-visual half of the library: 32 modules of date maths, device detection, URL and file helpers, cookie access, email parsing and the small generic helpers the components lean on. |
| Constants | Three small modules carry the values and the vocabulary the rest of the library is written in. |