UNPKG

@c8y/options

Version:

Cumulocity application options

26 lines (13 loc) • 2.25 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
**`@c8y/options` Package Overview** The `@c8y/options` package plays a crucial role in configuring and customizing Cumulocity applications. At the heart of this package lies the `ApplicationOptions` interface, which serves as a comprehensive blueprint for defining various aspects of your application. Here's what it offers: 1. **Application Metadata**: Allows you to specify essential details about your application, such as its name, context path, key, version, description, author, and license. 2. **Hybrid App Support**: Enables you to indicate whether your application is a hybrid one, utilizing both Angular and AngularJS simultaneously. 3. **Branding and Styling**: Provides options to customize the look and feel of your application, including paths to branding entry files, custom CSS variables, and favicon URLs. 4. **Localization**: Supports the addition and override of languages available in the application, as well as the inclusion of custom translations. 5. **Documentation and Support**: Allows you to configure documentation links, support URLs, and guide templates to assist your application's users. 6. **UI Customization**: Offers a wide range of options to tailor the user interface, such as hiding the app switcher, header, or powered-by information, enabling breadcrumbs, and adjusting the layout of tabs and navigators. 7. **Feature Toggles**: Provides flags to enable or disable specific features like storage limitation, cloud sensor wizard, newsletter subscription, and more. 8. **Integration Options**: Allows integration with third-party services and tools, such as specifying a Gainsight key for product experience tracking. 9. **Plugin and Package Support**: Facilitates the development of packages and the integration of plugins, including the definition of version matrices for managing dependencies. 10. **Map Configuration**: Enables customization of map layers, default zoom levels, and center positions, as well as the configuration of geocoding services. The `@c8y/options` package, with its `ApplicationOptions` interface, offers a flexible and extensive set of configuration options to tailor your Cumulocity application to your specific needs, making it a powerful tool in your development arsenal.