Remote Compose Storybook Русский GitHub

RemoteBasicIcon

A heart built with RemoteImageVector.Builder and path { }.

RemoteBasicIcon: the document drawn by the Remote Compose player
Open the live, interactive demo →

Change its controls, read the remote document it produces and the diff after every change.

What it is

A small vector icon that stays sharp at any size and can be recoloured.

Good for

  • Action icons
  • Status symbols that change colour

Code

The story's source with androidx.compose.remote imports. CI compiles every snippet on this site against AndroidX.

import androidx.compose.remote.creation.compose.capture.RemoteImageVector
import androidx.compose.remote.creation.compose.capture.path
import androidx.compose.remote.creation.compose.layout.RemoteAlignment
import androidx.compose.remote.creation.compose.layout.RemoteArrangement
import androidx.compose.remote.creation.compose.layout.RemoteBox
import androidx.compose.remote.creation.compose.layout.RemoteComposable
import androidx.compose.remote.creation.compose.layout.RemoteRow
import androidx.compose.remote.creation.compose.layout.RemoteText
import androidx.compose.remote.creation.compose.modifier.RemoteModifier
import androidx.compose.remote.creation.compose.modifier.size
import androidx.compose.remote.creation.compose.shaders.RemoteBrush
import androidx.compose.remote.creation.compose.shaders.solidColor
import androidx.compose.remote.creation.compose.state.RemoteStrokeCap
import androidx.compose.remote.creation.compose.state.RemoteStrokeJoin
import androidx.compose.remote.creation.compose.state.rc
import androidx.compose.remote.creation.compose.state.rdp
import androidx.compose.remote.creation.compose.state.rf
import androidx.compose.remote.creation.compose.state.rs
import androidx.compose.remote.foundation.icon.RemoteBasicIcon
import androidx.compose.runtime.Composable
import androidx.compose.ui.graphics.Color

@Composable
@RemoteComposable
fun BasicIcon(tint: Color, size: Int, strokeWidth: Float) {
    // A vector icon built from path commands, tinted at play time.
    val heart =
        RemoteImageVector.Builder(
                viewportWidth = 24f.rf,
                viewportHeight = 24f.rf,
                tintColor = Color.White.rc,
                name = "Heart",
            )
            .path(
                fill = RemoteBrush.solidColor(Color.White.rc),
                stroke = RemoteBrush.solidColor(Color.White.rc),
                strokeLineWidth = strokeWidth.rf,
                strokeLineCap = RemoteStrokeCap.Round,
                strokeLineJoin = RemoteStrokeJoin.Round,
            ) {
                moveTo(12f.rf, 21f.rf)
                cubicTo(5f.rf, 15f.rf, 2f.rf, 11f.rf, 2f.rf, 7.5f.rf)
                cubicTo(2f.rf, 4.5f.rf, 4.5f.rf, 2f.rf, 7.5f.rf, 2f.rf)
                cubicTo(9.3f.rf, 2f.rf, 11f.rf, 3f.rf, 12f.rf, 4.5f.rf)
                cubicTo(13f.rf, 3f.rf, 14.7f.rf, 2f.rf, 16.5f.rf, 2f.rf)
                cubicTo(19.5f.rf, 2f.rf, 22f.rf, 4.5f.rf, 22f.rf, 7.5f.rf)
                cubicTo(22f.rf, 11f.rf, 19f.rf, 15f.rf, 12f.rf, 21f.rf)
                close()
            }
            .build()
    RemoteRow(
        verticalAlignment = RemoteAlignment.CenterVertically,
        horizontalArrangement = RemoteArrangement.spacedBy(12.rdp),
    ) {
        RemoteBasicIcon(
            imageVector = heart,
            contentDescription = "Favourite".rs,
            modifier = RemoteModifier.size(size.rdp),
            tint = tint.rc,
        )
        RemoteBox(contentAlignment = RemoteAlignment.Center) { RemoteText("RemoteBasicIcon".rs) }
    }
}

API

foundation.icon.RemoteBasicIcon

void RemoteBasicIcon(RemoteImageVector imageVector, RemoteString? contentDescription, optional RemoteModifier modifier, optional RemoteColor tint)

creation.compose.capture.RemoteImageVector

class RemoteImageVector
  RemoteImageVector.Companion Companion
  RemoteImageVector.Builder(RemoteDp defaultWidth, RemoteDp defaultHeight, RemoteFloat viewportWidth, RemoteFloat viewportHeight, RemoteColor tintColor, optional String name, optional RemoteBlendMode tintBlendMode, optional boolean autoMirror)
  RemoteImageVector.Builder(RemoteFloat viewportWidth, RemoteFloat viewportHeight, RemoteColor tintColor, optional String name, optional RemoteBlendMode tintBlendMode, optional boolean autoMirror)
  RemoteImageVector build()

creation.compose.vector.RemotePathScope

class RemotePathScope
  RemotePathScope()
  void addArc(RemoteOffset topLeft, RemoteSize size, RemoteFloat startAngle, RemoteFloat sweepAngle)
  void addArc(RemoteSize size, RemoteFloat startAngle, RemoteFloat sweepAngle)
  void addArc(RemoteFloat left, RemoteFloat top, RemoteFloat right, RemoteFloat bottom, RemoteFloat startAngle, RemoteFloat sweepAngle)
  void addCircle(RemoteOffset center, RemoteFloat radius)
  void addCircle(RemoteFloat centerX, RemoteFloat centerY, RemoteFloat radius)
  void addOval(RemoteOffset topLeft, RemoteSize size)
  void addOval(RemoteSize size)
  void addOval(RemoteFloat left, RemoteFloat top, RemoteFloat right, RemoteFloat bottom)
  void addPath(RemotePathScope path)
  void addRect(RemoteOffset topLeft, RemoteSize size)
  void addRect(RemoteSize size)
  void addRect(RemoteFloat left, RemoteFloat top, RemoteFloat right, RemoteFloat bottom)
  void addRoundRect(RemoteOffset topLeft, RemoteSize size, RemoteOffset cornerRadius)
  void addRoundRect(RemoteOffset topLeft, RemoteSize size, RemoteFloat radiusX, optional RemoteFloat radiusY)
  void addRoundRect(RemoteSize size, RemoteOffset cornerRadius)
  void addRoundRect(RemoteSize size, RemoteFloat radiusX, optional RemoteFloat radiusY)
  void addRoundRect(RemoteFloat left, RemoteFloat top, RemoteFloat right, RemoteFloat bottom, RemoteFloat radiusX, optional RemoteFloat radiusY)
  void arcTo(RemoteOffset topLeft, RemoteSize size, RemoteFloat startAngle, RemoteFloat sweepAngle, optional boolean forceMoveTo)
  void arcTo(RemoteFloat horizontalEllipseRadius, RemoteFloat verticalEllipseRadius, RemoteFloat theta, RemoteBoolean isMoreThanHalf, RemoteBoolean isPositiveArc, RemoteFloat x1, RemoteFloat y1)
  void arcTo(RemoteFloat left, RemoteFloat top, RemoteFloat right, RemoteFloat bottom, RemoteFloat startAngle, RemoteFloat sweepAngle, optional boolean forceMoveTo)
  void arcToRelative(RemoteFloat a, RemoteFloat b, RemoteFloat theta, RemoteBoolean isMoreThanHalf, RemoteBoolean isPositiveArc, RemoteFloat dx1, RemoteFloat dy1)
  void close()
  void conicTo(RemoteOffset control, RemoteOffset end, RemoteFloat weight)
  void conicTo(RemoteFloat x1, RemoteFloat y1, RemoteFloat x2, RemoteFloat y2, RemoteFloat weight)
  void conicToRelative(RemoteOffset controlOffset, RemoteOffset endOffset, RemoteFloat weight)
  void conicToRelative(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2, RemoteFloat weight)
  void cubicTo(RemoteOffset control1, RemoteOffset control2, RemoteOffset end)
  void cubicTo(RemoteFloat x1, RemoteFloat y1, RemoteFloat x2, RemoteFloat y2, RemoteFloat x3, RemoteFloat y3)
  void curveTo(RemoteOffset control1, RemoteOffset control2, RemoteOffset end)
  void curveTo(RemoteFloat x1, RemoteFloat y1, RemoteFloat x2, RemoteFloat y2, RemoteFloat x3, RemoteFloat y3)
  void curveToRelative(RemoteOffset control1Offset, RemoteOffset control2Offset, RemoteOffset endOffset)
  void curveToRelative(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2, RemoteFloat dx3, RemoteFloat dy3)
  void horizontalLineTo(RemoteFloat x)
  void horizontalLineToRelative(RemoteFloat dx)
  void lineTo(RemoteOffset point)
  void lineTo(RemoteFloat x, RemoteFloat y)
  void lineToRelative(RemoteOffset offset)
  void lineToRelative(RemoteFloat dx, RemoteFloat dy)
  void moveTo(RemoteOffset point)
  void moveTo(RemoteFloat x, RemoteFloat y)
  void moveToRelative(RemoteOffset offset)
  void moveToRelative(RemoteFloat dx, RemoteFloat dy)
  void quadTo(RemoteOffset control, RemoteOffset end)
  void quadTo(RemoteFloat x1, RemoteFloat y1, RemoteFloat x2, RemoteFloat y2)
  void quadToRelative(RemoteOffset controlOffset, RemoteOffset endOffset)
  void quadToRelative(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2)
  void quadraticTo(RemoteOffset control, RemoteOffset end)
  void quadraticTo(RemoteFloat x1, RemoteFloat y1, RemoteFloat x2, RemoteFloat y2)
  void reflectiveCurveTo(RemoteFloat x1, RemoteFloat y1, RemoteFloat x2, RemoteFloat y2)
  void reflectiveCurveToRelative(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2)
  void reflectiveQuadTo(RemoteFloat x1, RemoteFloat y1)
  void reflectiveQuadToRelative(RemoteFloat dx1, RemoteFloat dy1)
  void relativeArcTo(RemoteFloat a, RemoteFloat b, RemoteFloat theta, RemoteBoolean isMoreThanHalf, RemoteBoolean isPositiveArc, RemoteFloat dx1, RemoteFloat dy1)
  void relativeConicTo(RemoteOffset controlOffset, RemoteOffset endOffset, RemoteFloat weight)
  void relativeConicTo(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2, RemoteFloat weight)
  void relativeCubicTo(RemoteOffset control1Offset, RemoteOffset control2Offset, RemoteOffset endOffset)
  void relativeCubicTo(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2, RemoteFloat dx3, RemoteFloat dy3)
  void relativeCurveTo(RemoteOffset control1Offset, RemoteOffset control2Offset, RemoteOffset endOffset)
  void relativeCurveTo(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2, RemoteFloat dx3, RemoteFloat dy3)
  void relativeHorizontalLineTo(RemoteFloat dx)
  void relativeHorizontalTo(RemoteFloat dx)
  void relativeLineTo(RemoteOffset offset)
  void relativeLineTo(RemoteFloat dx, RemoteFloat dy)
  void relativeMoveTo(RemoteOffset offset)
  void relativeMoveTo(RemoteFloat dx, RemoteFloat dy)
  void relativeQuadTo(RemoteOffset controlOffset, RemoteOffset endOffset)
  void relativeQuadTo(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2)
  void relativeQuadraticTo(RemoteOffset controlOffset, RemoteOffset endOffset)
  void relativeQuadraticTo(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2)
  void relativeReflectiveCurveTo(RemoteFloat dx1, RemoteFloat dy1, RemoteFloat dx2, RemoteFloat dy2)
  void relativeReflectiveQuadTo(RemoteFloat dx1, RemoteFloat dy1)
  void relativeVerticalLineTo(RemoteFloat dy)
  void relativeVerticalTo(RemoteFloat dy)
  void verticalLineTo(RemoteFloat y)
  void verticalLineToRelative(RemoteFloat dy)

Reference

More in Content