Console SDK
The Console UI SDK enables developers to seamlessly incorporate Console UI components like authentication flows, headers, sidebars, and modals into their applications. These components provide end users with a consistent and intuitive navigation and content access experience. The SDK offers dedicated integration support for popular JavaScript frameworks like React.JS and Vue.js. For React.JS, developers can use the console-ui-react package that contains React components and hooks for all core Console UI features. Similarly, the console-ui-vue package provides Vue.js single file components to integrate Console UI. Both React.JS and Vue.js packages fully support the latest framework versions and features. The components render Console UI markup while abstracting away the complexity, allowing developers to focus on building application logic while using the Console UI SDK to handle presentation responsibilities. The packages also include theming and customization support for modifying styles and appearances. With easy-to-use React and Vue integrations, the Console UI SDK makes it simple for developers to enhance their apps with modern interface components. By handling cross-browser compatibility, accessibility, and responsive behaviors, it accelerates the development and delivering highly polished JavaScript applications.
You can integrate the Console using the following methods:
Before you start the integration process, ensure that you have the following systems installed:
- Access to the OS1 Developer Portal to obtain your Client ID and App ID. Refer to the section Obtain credentials.
- Ensure that the app adheres to the limits set by the Console UI regarding the number of injectable controls and user preferences.
- The Console UI may have specific requirements for responsiveness and performance that should be considered during development.
Refer to the official documentation or GitHub repository for additional examples of integrating with the Console UI.