AdmiralSymbols - admiral-team/admiralui-ios GitHub Wiki

Overview

A set of icons and fonts used in the AdmiralUIKit and AdmiralSwiftUI libraries. You can also use the AdmiralUIResources library separately in your project. The AssetSymbol enum represents individual symbols and is used to access specific symbols within the library. Each symbol is defined as a static property of the AssetSymbol enum, with a unique name assigned to it.

Symbols

In iOS development, Symbols refer to a set of graphical elements or icons that are provided by the iOS system. These symbols 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.

Symbols are vector-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 Symbols are categorized into different groups based on their usage, such as navigation, actions, media playback, communication, and more. Each symbol is represented by a unique name and can be accessed using the system's APIs.

Developers can leverage Symbols 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 AdmiralSymbols 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 AdmiralSymbols

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

Example

In this example, the AdmiralSymbols library is being used to access a specific symbol called "info" from the "Service" category and "Outline" style. The symbol is then converted into a Swift UIImage using the .swiftUIImage property.

AdmiralSymbols.AssetSymbol.Service.Outline.info.swiftUIImage