Skip to main content

IconProps

interface IconProps extends OmitSVGProps'svg'

Properties​

alignContent​

Inherited from Omit.alignContent

alignItems​

Inherited from Omit.alignItems

alignSelf​

Inherited from Omit.alignSelf

anchor​

Inherited from Omit.anchor

anchorX​

Inherited from Omit.anchorX

anchorY​

Inherited from Omit.anchorY

antialiased​

Inherited from Omit.antialiased

basis​

basis?: SignalValueFlexBasis
Inherited from Omit.basis

bottom​

The position of the bottom edge of this node.

This shortcut property will set the node's position so that the bottom edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.bottom

bottomLeft​

The position of the bottom left corner of this node.

This shortcut property will set the node's position so that the bottom left corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.bottomLeft

bottomRight​

The position of the bottom right corner of this node.

This shortcut property will set the node's position so that the bottom right corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.bottomRight

bowing​

Controls the curve deviation from a straight line.

A value of 0 will cause lines to be perfectly straight. Higher values introduce more curvature.

Inherited from Omit.bowing

cache​

Inherited from Omit.cache

cachePadding​

Controls the padding of the cached canvas used by this node.

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from Omit.cachePadding

cachePaddingBottom​

Controls the padding of the cached canvas used by this node.

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from Omit.cachePaddingBottom

cachePaddingLeft​

Controls the padding of the cached canvas used by this node.

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from Omit.cachePaddingLeft

cachePaddingRight​

Controls the padding of the cached canvas used by this node.

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from Omit.cachePaddingRight

cachePaddingTop​

Controls the padding of the cached canvas used by this node.

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from Omit.cachePaddingTop

children​

children?: SignalValueComponentChildren
Inherited from Omit.children

clip​

clip?: SignalValueboolean
Inherited from Omit.clip

color​

The color of the icon

Provide the color in one of the following formats:

  • named color like red, darkgray, …
  • hexadecimal string with # like #bada55, #141414 Value can be either RGB or RGBA: #bada55, #bada55aa (latter is partially transparent) The shorthand version (e.g. #abc for #aabbcc is also possible.)

columnGap​

Inherited from Omit.columnGap

composite​

Inherited from Omit.composite

compositeOperation​

compositeOperation?: SignalValueGlobalCompositeOperation
Inherited from Omit.compositeOperation

direction​

direction?: SignalValueFlexDirection
Inherited from Omit.direction

fill​

fill?: SignalValuePossibleCanvasStyle
Inherited from Omit.fill

fillShaders​

fillShaders?: PossibleShaderConfig
Inherited from Omit.fillShaders

filters​

Inherited from Omit.filters

fontFamily​

Inherited from Omit.fontFamily

fontSize​

Inherited from Omit.fontSize

fontStyle​

Inherited from Omit.fontStyle

fontWeight​

Inherited from Omit.fontWeight

gap​

Inherited from Omit.gap

grow​

Inherited from Omit.grow

height​

Inherited from Omit.height

icon​

The identifier of the icon.

You can find identifiers on Icônes. They can look like this:

  • mdi:language-typescript
  • ph:anchor-simple-bold
  • ph:activity-bold

justifyContent​

Inherited from Omit.justifyContent

key​

key?: string
Inherited from Omit.key

layout​

layout?: LayoutMode
Inherited from Omit.layout

layoutChildren​

layoutChildren?: LayoutMode

Whether this node lays out its own children with flex. When null (the default), falls back to layout.

Inherited from Omit.layoutChildren

layoutSelf​

layoutSelf?: LayoutMode

Whether this node participates in its parent's flex layout. When null (the default), falls back to layout.

Inherited from Omit.layoutSelf

left​

The position of the left edge of this node.

This shortcut property will set the node's position so that the left edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.left

letterSpacing​

Inherited from Omit.letterSpacing

lineCap​

lineCap?: SignalValueCanvasLineCap
Inherited from Omit.lineCap

lineDash​

Inherited from Omit.lineDash

lineDashOffset​

Inherited from Omit.lineDashOffset

lineHeight​

Inherited from Omit.lineHeight

lineJoin​

lineJoin?: SignalValueCanvasLineJoin
Inherited from Omit.lineJoin

lineWidth​

Inherited from Omit.lineWidth

margin​

Inherited from Omit.margin

marginBottom​

Inherited from Omit.marginBottom

marginLeft​

Inherited from Omit.marginLeft

marginRight​

Inherited from Omit.marginRight

marginTop​

Inherited from Omit.marginTop

maxHeight​

maxHeight?: SignalValueLengthLimit
Inherited from Omit.maxHeight

maxWidth​

maxWidth?: SignalValueLengthLimit
Inherited from Omit.maxWidth

middle​

The position of the center of this node.

This shortcut property will set the node's position so that the center ends up in the given place. If present, overrides the NodeProps.position property. When anchor is not set, this will be the same as the NodeProps.position.

Inherited from Omit.middle

minHeight​

minHeight?: SignalValueLengthLimit
Inherited from Omit.minHeight

minWidth​

minWidth?: SignalValueLengthLimit
Inherited from Omit.minWidth

morpher​

morpher?: PathMorpher
Inherited from Omit.morpher

opacity​

Inherited from Omit.opacity

padding​

Inherited from Omit.padding

paddingBottom​

Inherited from Omit.paddingBottom

paddingLeft​

Inherited from Omit.paddingLeft

paddingRight​

Inherited from Omit.paddingRight

paddingTop​

Inherited from Omit.paddingTop

position​

Inherited from Omit.position

ratio​

Inherited from Omit.ratio

ref​

Inherited from Omit.ref

The position of the right edge of this node.

This shortcut property will set the node's position so that the right edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.right

rotation​

Inherited from Omit.rotation

rough​

Enable rough.js rendering.

Inherited from Omit.rough

roughDisableMultiStroke​

Whether to disable multi-stroke rendering.

By default, Rough.js renders strokes with multiple lines for a more sketchy appearance. Set to true to use a single stroke.

Inherited from Omit.roughDisableMultiStroke

roughDisableMultiStrokeFill​

Whether to disable multi-stroke fill.

By default, Rough.js renders fills with multiple passes. Set to true to use a single fill pass.

Inherited from Omit.roughDisableMultiStrokeFill

roughFillStyle​

roughFillStyle?: SignalValueRoughFillStyle

Fill style for the shape.

Inherited from Omit.roughFillStyle

roughFillWeight​

Thickness of the lines used for filling.

Only applicable for hachure, cross-hatch, and similar fill styles.

Inherited from Omit.roughFillWeight

roughHachureAngle​

Angle of the hachure lines in degrees.

Only applicable for hachure and cross-hatch fill styles.

Inherited from Omit.roughHachureAngle

roughHachureGap​

Gap between hachure lines in pixels.

Only applicable for hachure, cross-hatch, and similar fill styles.

Inherited from Omit.roughHachureGap

roughness​

Numerical value indicating how rough the drawing is.

A value of 0 will produce a smooth shape, while higher values introduce more irregularity. Typical range is 0-10.

Inherited from Omit.roughness

roughSeed​

Seed for the random number generator.

Using the same seed produces consistent results, which is useful for reproducible animations.

Inherited from Omit.roughSeed

rowGap​

Inherited from Omit.rowGap

scale​

Inherited from Omit.scale

scaleX​

Inherited from Omit.scaleX

scaleY​

Inherited from Omit.scaleY

shaders​

shaders?: PossibleShaderConfig
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from Omit.shaders

shadowBlur​

Inherited from Omit.shadowBlur

shadowColor​

Inherited from Omit.shadowColor

shadowOffset​

Inherited from Omit.shadowOffset

shadowOffsetX​

Inherited from Omit.shadowOffsetX

shadowOffsetY​

Inherited from Omit.shadowOffsetY

shrink​

Inherited from Omit.shrink

size​

Inherited from Omit.size

skew​

Inherited from Omit.skew

skewX​

Inherited from Omit.skewX

skewY​

Inherited from Omit.skewY

spawner​

spawner?: SignalValueComponentChildren

Deprecated

Use children instead.

Inherited from Omit.spawner

stroke​

stroke?: SignalValuePossibleCanvasStyle
Inherited from Omit.stroke

strokeFirst​

Inherited from Omit.strokeFirst

strokeShaders​

strokeShaders?: PossibleShaderConfig
Inherited from Omit.strokeShaders

textAlign​

Inherited from Omit.textAlign

textDirection​

textDirection?: SignalValueCanvasDirection
Inherited from Omit.textDirection

textWrap​

Inherited from Omit.textWrap

top​

The position of the top edge of this node.

This shortcut property will set the node's position so that the top edge ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.top

topLeft​

The position of the top left corner of this node.

This shortcut property will set the node's position so that the top left corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.topLeft

topRight​

The position of the top right corner of this node.

This shortcut property will set the node's position so that the top right corner ends up in the given place. If present, overrides the NodeProps.position property.

Inherited from Omit.topRight

translate​

Inherited from Omit.translate

translateX​

Inherited from Omit.translateX

translateY​

Inherited from Omit.translateY

verticalAlign​

verticalAlign?: SignalValueVerticalAlign
Inherited from Omit.verticalAlign

width​

Inherited from Omit.width

wordBreak​

Inherited from Omit.wordBreak

wrap​

wrap?: SignalValueFlexWrap
Inherited from Omit.wrap

x​

x?: SignalValuenumber
Inherited from Omit.x

y​

y?: SignalValuenumber
Inherited from Omit.y

zIndex​

Inherited from Omit.zIndex