Repository Structure

This is a quick breakdown of what is where in the repository.

/docs/

This directory holds the Jekyll files for the GitHub pages you are now reading.

/lib/

A number of external libraries can be found in this sub-folder. Roughly, they can be split into two categories

  • Fetched libraries: These libraries are hosted on jCenter. The corresponding sub-folder of /lib/ will only contain a BUCK file, with the command to fetch the library.
  • Bundled libraries: These libraries are included in their completeness. This is the proper buck way of doing things. However, they vastly increase the size of the repository and are thus only included when absolutely necessary.

/sample-barebones/

The source for the finished product of the barebones tutorial is found here. If you change the tutorial, you must update the code here.

/sample-barebones-kotlin/

This folder contains - you guess it! - a Kotlin version of the previous barebones sample to demonstrate how to use Litho and Kotlin together.

/sample-codelab/

The source for the codelab tutorial is found here. The codelab has 3 parts:

  • /examples/: This has an Activity with a step-by-step introduction to the features of Litho. Each element points to a ComponentSpec which builds on the last and uses new features.
  • / (root): This is a "Hello world" Activity, rendered using Components. This can be used in presentations or labs to learn Litho.
  • /end/: This is an approximate end state for the lab built from the root.

/sample/

Under this directory is found code for the Litho sample app. This includes the playground, which you should use for all testing/bug reporting.

/sample-kotlin/

This directory contains a Kotlin version of the previous sample project.

/litho-*/

Litho is split into several sub-project so end users can pick and choose the parts of the framework they want to use. The available projects are as follows:

  • litho-annotations is a pure Java library containing the annotations necessary to use the processor with.
  • litho-core contains the core framework code.
  • litho-fresco contains components for the use with the Fresco image library.
  • litho-it contains integration tests for the framework. It is necessary to have a separate project for this as it to avoid circular dependencies.
  • litho-it-powermock contains integration tests for the framework that utilize PowerMock. Check out the README inside to learn more.
  • litho-instrumentation-tests contains instrumentation tests for the framework. They require a device (or emulator) to run.
  • litho-processor contains the stand-alone annotation processor.
  • litho-testing contains utilities to test Litho components.
  • litho-widget contains several mount specs for commonly used Android widgets.
  • litho-sections-core contains the Java code for the Sections framework, including the com.facebook.litho.sections.common namespace.
  • litho-sections-annotations has annotations for use with the Sections processor.
  • litho-sections-processor is a pure Java library containing the annotation necessary to use processor for Sections with.
  • litho-sections-widget contains Sections-specific widgets like the RecyclerCollectionComponentSpec.

/LITHO_DEFS and /BUCK

These files define how to build Litho. The BUCK file is the input to buck, and the /LITHO_DEFS file contains some constants needed for buck to find targets inside the repository. It is imported in /BUCK.

Edit this page