c91e4b3566
Summary: Addresses issue #523 Closes https://github.com/facebook/yoga/pull/529 Differential Revision: D4953973 Pulled By: emilsjolander fbshipit-source-id: b6e64f30ad615ba65152f19e775bd6c890e6c6b6
85 lines
3.7 KiB
Markdown
85 lines
3.7 KiB
Markdown
---
|
|
docid: android
|
|
title: Android
|
|
layout: docs
|
|
permalink: /docs/api/android/
|
|
---
|
|
|
|
To include the java bindings and `.so` libraries, add to your build:
|
|
|
|
```java
|
|
compile 'com.facebook.yoga:yoga:1.2.0'
|
|
```
|
|
|
|
There is an easy interface to Yoga called `YogaLayout`. This is a view group that lays out its children using Yoga. We recommend looking at the sample app for details on its usage. However, as an overview you can simply define XML layouts such as:
|
|
|
|
```xml
|
|
<?xml version="1.0" encoding="utf-8" ?>
|
|
<YogaLayout
|
|
xmlns:android="http://schemas.android.com/apk/res/android"
|
|
xmlns:yoga="http://schemas.android.com/apk/res-auto"
|
|
android:layout_width="match_parent"
|
|
android:layout_height="match_parent"
|
|
yoga:yg_alignItems="stretch"
|
|
>
|
|
<YogaLayout
|
|
android:layout_width="match_parent"
|
|
android:layout_height="wrap_content"
|
|
android:background="@drawable/sample_children_background"
|
|
yoga:yg_marginHorizontal="10dp"
|
|
yoga:yg_marginTop="5dp"
|
|
yoga:yg_flexDirection="row"
|
|
yoga:yg_alignItems="center"
|
|
>
|
|
<ImageView
|
|
android:layout_width="50dp"
|
|
android:layout_height="50dp"
|
|
android:src="@drawable/ic_launcher"
|
|
yoga:yg_flex="0"
|
|
/>
|
|
<TextView
|
|
android:layout_width="match_parent"
|
|
android:layout_height="wrap_content"
|
|
android:text="@string/child_1_text"
|
|
android:textColor="@color/children_text"
|
|
yoga:yg_flex="1"
|
|
yoga:yg_marginStart="8dp"
|
|
/>
|
|
</YogaLayout>
|
|
</YogaLayout>
|
|
```
|
|
|
|
Note that there are some caveats, such as requiring the custom `YogaLayoutViewFactory` in order to have tags `YogaLayout` instead of `com.facebook.samples.yoga.YogaLayout`.
|
|
|
|
To include this in your project, add to your build:
|
|
|
|
```java
|
|
compile 'com.facebook.yoga.android:yoga-layout:1.2.0'
|
|
```
|
|
|
|
## layout\_width and layout\_height
|
|
|
|
If either are set to an actual size (in px or dp etc) then this is taken as a default for `yoga:yg_height` or `yoga:ygWidth`. Otherwise they are ignored.
|
|
|
|
## VirtualYogaLayout
|
|
|
|
Sometimes you will nest `YogaLayout`s within `YogaLayout`s in order to get your layout to be perfect, but some of the `YogaLayout`s are just there to control position: they don't render or anything. If so, then they are unnecessary (since Yoga stores the view hierarchy itself) and `VirtualYogaLayout` is a ViewGroup that fixes this. It will never get drawn, but all its children will be placed appropriately.
|
|
|
|
## RTL locales
|
|
|
|
RTL locales are supported by default. That is, unless you explicitly set the `yoga:yg_direction="ltr|rtl|inherit"` attribute on a view, it will obtain the locale direction At runtime_. This means that the layout will rearrange properly, even if the locale changes while your app is running!
|
|
|
|
## Attributes
|
|
|
|
The list of all attributes can be found in [attrs.xml](https://github.com/facebook/yoga/blob/master/android/src/main/res/values/attrs.xml), but logically map from the Yoga properties.
|
|
|
|
## Auto margins
|
|
|
|
You can specify `margin_left="auto"` (or `margin_right` etc.) for auto values. This is in addition to the dimensions you can speicfy, such as `margin_left="20dp"`.
|
|
|
|
## Invalidation (_temporary_)
|
|
|
|
If you change any attribute of a view that will change its measure size, you must invalidate it. Do this by calling `YogaLayout#invalidate(View)` on any `YogaLayout` further up the tree. Obviously it is most efficient to call it on the view's parent (if it is a `YogaLayout`, but in case this is impractical, you can call it on the root of the tree.
|
|
|
|
This is a temporary solution. Ideally, the view should invalidate itself whenever an attribute (text, font etc.) that will alter its size changes. This will be automatic once we find a good way to hook into the Android invalidation system.
|