com.facebook.litho.annotations

Annotation Type PropDefault

@Retention(value=CLASS)
public @interface PropDefault

PropDefault can be used for setting the default value of an optional Prop in a LayoutSpec or MountSpec. The field must be a constant (i.e. static final) with the same name and type as the Prop.

For example:

 @LayoutSpec
 class SomeSpec {

   @PropDefault
   static final String name = "John Doe";  // default value for name

   @OnCreateLayout
   static Component onCreateLayout(
     ComponentContext c,
     @Prop(optional = true) String name) {

     return Text.create(c)
       .text(title.getTitle())
       .textSizeSp(16)
       .marginDip(YogaEdge.BOTTOM, 4)
       .build();
   }
 }

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	resId Sets an Android resource as the default value of the Prop.
ResType	resType Declares that the default value must be a resource of the specified ResType.

Element Detail

resType

public abstract ResType resType

Declares that the default value must be a resource of the specified ResType.

For example:

 @LayoutSpec
 class SomeSpec {

   @PropDefault(resType = ResType.STRING, resId = R.string.default_name)
   static final String name = null;

 }

Returns:

A valid resource type.

Default:

com.facebook.litho.annotations.ResType.NONE

resId

public abstract int resId

Sets an Android resource as the default value of the Prop.

Returns:

An Android resource id.

Default:

0