atomik/com.kevinschildhorn.atomik.atomic.atoms/FigmaTextAtom

FigmaTextAtom

class FigmaTextAtom( val type: AtomType = AtomType.TEXT, val subComponents: List<Atom> = emptyList(), val width: Int? = null, val height: Int? = null, val constraintX: AtomikConstraintX, val constraintY: AtomikConstraintY, val textColor: AtomikColor, val typography: AtomikTypographyType, val fontFamily: AtomikFontFamily? = null, val padding: Int? = null, val paddingHorizontal: Int? = padding, val paddingVertical: Int? = padding, val paddingLeft: Int? = paddingHorizontal, val paddingRight: Int? = paddingHorizontal, val paddingTop: Int? = paddingVertical, val paddingBottom: Int? = paddingVertical) : FigmaBaseAtom, TextAtom, PaddingAtom

Represents an Atom with all of the properties found in a Figma Text atom

This atom contains the components that are configurable in a Figma file, for a component that has text.

Constructors

fun FigmaTextAtom( type: AtomType = AtomType.TEXT, subComponents: List<Atom> = emptyList(), width: Int? = null, height: Int? = null, constraintX: AtomikConstraintX, constraintY: AtomikConstraintY, textColor: AtomikColor, typography: AtomikTypographyType, fontFamily: AtomikFontFamily? = null, padding: Int? = null, paddingHorizontal: Int? = padding, paddingVertical: Int? = padding, paddingLeft: Int? = paddingHorizontal, paddingRight: Int? = paddingHorizontal, paddingTop: Int? = paddingVertical, paddingBottom: Int? = paddingVertical)

Functions

fun <T : AtomInterface> asAtom(): T?

Checks to see if this Atom implements a certain AtomInterface and if it does returns the interface

inline fun <T : AtomInterface> subAtom(): T?

Finds a subComponent matching a specified AtomInterface if it exists

Properties

open override val constraintX: AtomikConstraintX

the constraint in the X Axis (horizontal)

open override val constraintY: AtomikConstraintY

the constraint in the Y Axis (vertical)

open override val fontFamily: AtomikFontFamily? = null

the fontFamily associated with the text

hasSubComponents

val hasSubComponents: Boolean

Checks to see if the Atom has any subcomponents. Returns boolean

open override val height: Int? = null

the height of the UI (in dp / pt)

open override val padding: Int? = null

the horizontal padding of the atom (in dp/pt)

open override val paddingBottom: Int?

the padding on the bottom of the atom (in dp/pt)

paddingHorizontal

open override val paddingHorizontal: Int?

the horizontal padding of the atom (in dp/pt)

open override val paddingLeft: Int?

the padding on the left of the atom (in dp/pt)

open override val paddingRight: Int?

the padding on the right of the atom (in dp/pt)

open override val paddingTop: Int?

the padding on the top of the atom (in dp/pt)

paddingVertical

open override val paddingVertical: Int?

the vertical padding of the atom (in dp/pt)

open override val subComponents: List<Atom>

the components related to this atom, as mentioned in description

open override val textColor: AtomikColor

the color of the text

open override val type: AtomType

the Type of atom being displayed, such as button or text

open override val typography: AtomikTypographyType

the typography associated with the text

open override val width: Int? = null

the width of the UI (in dp / pt)