KSVG Compose/hu.oandras.ksvg.compose

Package-level declarations

Functions

fun KsvgAnimatedImage(svg: SVG?, contentDescription: String?, modifier: Modifier = Modifier, renderOptions: RenderOptions? = null, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)

Displays an animated SVG document (SMIL <animate> family).

@Composable

fun KsvgAnimatedImage(assetPath: String, contentDescription: String?, modifier: Modifier = Modifier, renderOptions: RenderOptions? = null, dispatcher: CoroutineDispatcher = Dispatchers.IO, loggerContext: LoggerContext = AndroidLoggerContext, externalFileResolver: ExternalFileResolver? = null, isInternalEntitiesEnabled: Boolean = true, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)

Displays an animated SVG loaded from the assets folder.

KsvgCanvas

@Composable

fun KsvgCanvas(svg: SVG?, modifier: Modifier = Modifier, renderOptions: RenderOptions? = null, contentDescription: String? = null)

Renders a static SVG document directly into the Compose canvas, without an intermediate Drawable.

KsvgImage

@Composable

fun KsvgImage(svg: SVG?, contentDescription: String?, modifier: Modifier = Modifier, renderOptions: RenderOptions? = null, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)

Displays a static SVG document.

@Composable

fun KsvgImage(assetPath: String, contentDescription: String?, modifier: Modifier = Modifier, renderOptions: RenderOptions? = null, parseAnimations: Boolean = false, dispatcher: CoroutineDispatcher = Dispatchers.IO, loggerContext: LoggerContext = AndroidLoggerContext, externalFileResolver: ExternalFileResolver? = null, isInternalEntitiesEnabled: Boolean = true, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Fit, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)

Displays a static SVG loaded from the assets folder (e.g., "visual/a_link.svg").

rememberSvgAsset

@Composable

fun rememberSvgAsset(assetPath: String, parseAnimations: Boolean = false, dispatcher: CoroutineDispatcher = Dispatchers.IO, loggerContext: LoggerContext = AndroidLoggerContext, externalFileResolver: ExternalFileResolver? = null, isInternalEntitiesEnabled: Boolean = true): SVG?

Loads and parses an SVG asset on a background thread, caching the parsed document across recompositions.