AdmiralImages - admiral-team/admiralui-ios GitHub Wiki

Overview

A set of images divided into different categories. To access images you should import AdmiralImages library. The AdmiralImages enum represents individual images and is used to access specific image within the library. Each image is defined as a static property of the AdmiralImages enum, with a unique name assigned to it.

Images

AdmiralImages supporting targets lower than iOS 13, iPadOS 13, or macOS 10.15. These images are designed to represent common actions, objects, and concepts used in user interfaces. They serve as a visual language that helps maintain consistency and familiarity across different iOS applications.

Images are pdf-based and scalable, which means they can be resized without losing clarity or quality. They are designed to adapt to various display sizes and resolutions, ensuring a consistent user experience across different devices.

iOS Images are categorized into different groups based on their usage, such as navigation, actions, media playback, communication, and more. Each image is represented by a unique name and can be accessed using the system's APIs.

Developers can leverage Images in their iOS applications by using system-provided APIs to incorporate these graphical elements into their user interfaces. This allows them to create visually appealing and intuitive interfaces while adhering to the design guidelines and aesthetics of the iOS platform.

Setup

To use the AdmiralImages library in your iOS project, you need to add the appropriate import statement at the beginning of your Swift file. Here's the import statement you should include:

import AdmiralImages

Ensure that you have properly installed and integrated the AdmiralImages library into your project before adding the import statement. Additionally, make sure to import AdmiralImages in any Swift file where you intend to use the library's symbols or functionality.

Example

In this example, the AdmiralImages library is being used to access a specific symbol called headsetSolid from the Communication category and Solid style. The symbol is then converted into a Swift UIImage using the .swiftUIImage property.

AdmiralImages.Asset.Communication.Solid.headsetSolid.swiftUIImage