svg-to-compose/dev.tonholo.s2c.parser/ParserConfig

ParserConfig

data class ParserConfig(val pkg: String, val theme: String, val optimize: Boolean, val receiverType: String?, val addToMaterial: Boolean, val kmpPreview: Boolean, val noPreview: Boolean, val makeInternal: Boolean, val minified: Boolean, val exclude: Regex? = null, val silent: Boolean = false, val keepTempFolder: Boolean = false, val formatConfig: FormatConfig? = null, val formatOverrides: FormatConfig.Overrides? = null)(source)

Configuration parameters for the Parser class.

Constructors

ParserConfig

constructor(pkg: String, theme: String, optimize: Boolean, receiverType: String?, addToMaterial: Boolean, kmpPreview: Boolean, noPreview: Boolean, makeInternal: Boolean, minified: Boolean, exclude: Regex? = null, silent: Boolean = false, keepTempFolder: Boolean = false, formatConfig: FormatConfig? = null, formatOverrides: FormatConfig.Overrides? = null)

Properties

addToMaterial

val addToMaterial: Boolean

if true, icons will be added to the Material-UI icon set E.g:

exclude

val exclude: Regex?

regex to exclude some icons from the parsing

formatConfig

val formatConfig: FormatConfig?

optional formatting configuration for code emission. When null, the processor will attempt to resolve formatting from .editorconfig.

formatOverrides

val formatOverrides: FormatConfig.Overrides?

optional partial overrides applied on top of the resolved FormatConfig. Use this to let CLI flags override individual fields while still inheriting unspecified values from .editorconfig.

keepTempFolder

val keepTempFolder: Boolean

if true, the dev.tonholo.s2c.Processor won't request to delete the temp folder. Useful when running parallel execution.

kmpPreview

val kmpPreview: Boolean

if true, a KMP compatible @Preview Composable function will be generated for the parsed icon.

makeInternal

val makeInternal: Boolean

if true, the generated icon will be set as internal, hiding it from outside modules

minified

val minified: Boolean

if true, minifies the output removing all generated comments and inlining the path functions parameters

noPreview

val noPreview: Boolean

if true, no @Preview Composable function will be generated for the parsed icon.

optimize

val optimize: Boolean

if true, executes an SVG/AVG optimization before generating the Compose Icon code

pkg

val pkg: String

The package name that the generated code is going to be in

receiverType

val receiverType: String?

The type of the class or object that will be used as a receiver for the extension Icon property in the generated code.

silent

val silent: Boolean

if true, no console output will be displayed.

theme

val theme: String

The Compose theme. If the full qualifier is not provided, you'll need to add the import to your code after generated. E.g: dev.tonholo.myapp.theme.MyAppTheme