design-system/com.savantarch.design

Package-level declarations

Types

Android-specific contract for design system image assets. Image keys generated or defined on Android must implement this interface to resolve to theme attributes.

AndroidDsStrings

interface AndroidDsStrings : DsStrings

Android-specific contract for design system string assets. String keys generated or defined on Android must implement this interface to resolve to theme attributes.

CornerFamily

enum CornerFamily : Enum<CornerFamily>

Defines the style family of a corner.

DsColors

interface DsColors

Core design system color interface containing the standard set of Material 3 color properties. Implementing enums or classes provide ARGB hex values as Longs (e.g. 0xFF6200EE).

DsImages

interface DsImages

Interface for application graphics assets/images. Client enum keys should implement this interface.

DsShapes

interface DsShapes

Core design system shapes interface containing the standard Material 3 corner scale.

DsStrings

interface DsStrings

Interface for application localized string keys. Client enum keys should implement this interface.

DsThemeMode

enum DsThemeMode : Enum<DsThemeMode>

Defines the application's supported theme mode choices.

DsTypography

interface DsTypography

Core design system typography interface containing the standard Material 3 text style tokens.

FontSpec

data class FontSpec(val fontSize: Double, val lineHeight: Double)

A platform-agnostic text style/font token declaring target font size and line height. These are compiled to standard Android text appearances and Apple system fonts.

IosDsImages

interface IosDsImages : DsImages

iOS-specific contract for design system image assets. Image keys generated or defined on iOS must implement this interface to resolve to bundle asset names.

IosDsStrings

interface IosDsStrings : DsStrings

iOS-specific contract for design system string assets. String keys generated or defined on iOS must implement this interface to resolve to bundle localization keys.

ShapeAppearance

data class ShapeAppearance(val family: CornerFamily, val topLeft: Double, val topRight: Double, val bottomRight: Double, val bottomLeft: Double)

A platform-agnostic shape appearance specification declaring corner family and corner sizes. These are compiled to standard Android shapes and Apple corner radii.

Properties

bodyLargeFont

val DsTypography.bodyLargeFont: UIFont

bodyMediumFont

val DsTypography.bodyMediumFont: UIFont

bodySmallFont

val DsTypography.bodySmallFont: UIFont

displayLargeFont

val DsTypography.displayLargeFont: UIFont

displayMediumFont

val DsTypography.displayMediumFont: UIFont

displaySmallFont

val DsTypography.displaySmallFont: UIFont

headlineLargeFont

val DsTypography.headlineLargeFont: UIFont

headlineMediumFont

val DsTypography.headlineMediumFont: UIFont

headlineSmallFont

val DsTypography.headlineSmallFont: UIFont

labelLargeFont

val DsTypography.labelLargeFont: UIFont

labelMediumFont

val DsTypography.labelMediumFont: UIFont

labelSmallFont

val DsTypography.labelSmallFont: UIFont

localized

val DsStrings.localized: String

Resolves and loads the localized string value for this DsStrings directly on iOS.

titleLargeFont

val DsTypography.titleLargeFont: UIFont

titleMediumFont

val DsTypography.titleMediumFont: UIFont

titleSmallFont

val DsTypography.titleSmallFont: UIFont

uiImage

val DsImages.uiImage: UIImage

Resolves and loads this DsImages key to a native iOS UIImage instance from our bundle.

Functions

DsImage

@Composable

actual fun DsImage(image: DsImages, contentDescription: String?, modifier: Modifier, tint: Color?, backgroundColor: Color?)

Composable function to display a synchronous vector/raster image across Android and iOS.

@Composable

expect fun DsImage(image: DsImages, contentDescription: String?, modifier: Modifier = Modifier, tint: Color? = null, backgroundColor: Color? = null)

Composable function to display a synchronous vector/raster image across Android and iOS.

actual fun DsImage(image: DsImages, contentDescription: String?, modifier: ERROR CLASS: Symbol not found for Modifier, tint: ERROR CLASS: Symbol not found for androidx.compose.ui.graphics.Color??, backgroundColor: ERROR CLASS: Symbol not found for androidx.compose.ui.graphics.Color??)

formatWithArgs

fun String.formatWithArgs(vararg args: Any): String

Extension function to format a Swift/Kotlin String using Cocoa's NSString engine.

getDesignSystemBundle

fun NSBundle.getDesignSystemBundle(): NSBundle

Locates and returns the design system resource bundle (design-system.bundle) within this bundle, falling back to the receiver bundle if not found.

getDrawableIdFromAttr

fun Context.getDrawableIdFromAttr(attr: Int): Int

Resolves a theme-dependent drawable resource ID from the specified theme attribute.

getStringFromAttr

fun Context.getStringFromAttr(attr: Int): String

Resolves a dynamic theme-dependent string resource ID from the specified theme attribute.

fun Context.getStringFromAttr(attr: Int, vararg formatArgs: Any): String

Resolves a dynamic theme-dependent string resource ID from the specified theme attribute and formats it with the provided arguments.

isPlatformInDarkTheme

actual fun isPlatformInDarkTheme(): Boolean

Returns true if the host operating system platform is currently configured in dark theme.

expect fun isPlatformInDarkTheme(): Boolean

Returns true if the host operating system platform is currently configured in dark theme.

actual fun isPlatformInDarkTheme(): Boolean

Returns true if the host operating system platform is currently configured in dark theme.

loadImage

fun NSBundle.loadImage(imageName: String, tintColor: UIColor?): UIImage

Loads an image from this bundle by its name, configured with template or original rendering modes based on whether a tint color is specified.

loadTemplateImage

fun NSBundle.loadTemplateImage(imageName: String): UIImage

Loads a template image from this bundle by its name, configured with template rendering mode to allow tinting filters.

resolveImageFromBundle

fun NSBundle.resolveImageFromBundle(imageName: String): UIImage?

Resolves a native iOS UIImage by its name from this bundle, falling back to the main application bundle.

stringResource

@Composable

actual fun stringResource(dsStrings: DsStrings): String

Composable function to load a localized string synchronously.

@Composable

actual fun stringResource(dsStrings: DsStrings, vararg formatArgs: Any): String

Composable function to load a localized string synchronously and format it with arguments.

@Composable

expect fun stringResource(dsStrings: DsStrings): String

Composable function to load a localized string synchronously.

@Composable

expect fun stringResource(dsStrings: DsStrings, vararg formatArgs: Any): String

Composable function to load a localized string synchronously and format it with arguments.

actual fun stringResource(dsStrings: DsStrings): String

Composable function to load a localized string synchronously.

fun stringResource(key: String): String

Loads a localized string synchronously from the design system bundle using the specified key.

actual fun stringResource(dsStrings: DsStrings, vararg formatArgs: Any): String

Composable function to load a localized string synchronously and format it with arguments.

fun stringResource(key: String, vararg formatArgs: Any): String

Loads a localized string synchronously from the design system bundle using the specified key and formats it with the provided arguments.

toCGFloat

fun Double.toCGFloat(): CGFloat

Converts this Double value to a platform-native CGFloat.

toCoilModel

@Composable

actual fun DsImages.toCoilModel(): Any

Resolves the DsImages asset to a platform-specific model suitable for third-party image loading libraries (such as Coil, Kamel, etc.) without introducing direct library dependencies into the design system.

@Composable

expect fun DsImages.toCoilModel(): Any

actual fun DsImages.toCoilModel(): Any

toColor

fun Long.toColor(): Color

Converts an ARGB hex Long (e.g. 0xFFFFFFFF) directly to a Compose Color.

toColorScheme