Jetpack Composeでカスタムレイアウトを作る

以下の動画を見てまとめていたのですが、カスタムレイアウトの作り方だけで一つの記事になりそうだったので、その中で出てきたカスタムレイアウトの作り方について書いておきます。普段はConstraintLayoutでなんとかなると思うので、Jetpack Composeの中のコードを読むときに役立つ知識になりそうです。
https://youtu.be/DDd6IOlH3io

alpha1での情報なので、今後変更される可能性があります。

## カスタムレイアウトを作るには `@Composable fun Layout()`の使い方。

**Layoutブロック使うとカスタムレイアウトを作れます。実際に以下のようなレイアウトをサンプルで作っています。**

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/27388/c88915ad-4310-7d22-3a9d-725d51db1fde.png)
https://youtu.be/DDd6IOlH3io?t=869 より 

実際のコードはここにあります。
https://github.com/android/compose-samples/blob/34a75fb3672622a3fb0e6a78adc88bbc2886c28f/Jetsnack/app/src/main/java/com/example/jetsnack/ui/home/search/Categories.kt#L102

肝心のレイアウトを作る関数の宣言はこうなっており、Modifierと子要素をかけるchildrenがあり、最後にmeasureBlockというのがあります。

```kotlin
fun Layout(
    /*crossinline*/
    children: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    /*noinline*/
    measureBlock: MeasureBlock
)
```


メジャーブロックは3つのステップで作ることができます。
1. それぞれのアイテムのmeasureを呼び出す。
2. layout()を呼ぶ。
3. それぞれのアイテムを置く(placeを呼び出す)。

コードの外観

```kotlin
Layout(
  modifier = ...,
  children = {
      Text(
          text = category.name,
          ...
       )
       SnackImage(
          ...
       )
  }
) { measurables: List<Measurable>, 
    constraints: Constraints->
  // 1. それぞれのアイテムのmeasureを呼び出す。
  // 2. layout()を呼ぶ。
  // 3. それぞれのアイテムを置く(placeを呼び出す)。
}
```

## MeasureBlockの引数について

#### 引数で渡ってくる `constraints: Constraints` とはなにか？
AndroidエンジニアにはおなじみのConstraintLayoutとは何も関係なく、maxやminのWidthやHeightが取得できるだけで、このViewの大きさの上限と下限がわかるだけのオブジェクトです。

#### 引数で渡ってくる `measurables: List<Measurable>` とはなにか？
このリストの一つ一つの要素がUIのコンポーネントのmeasureを呼べるmeasurableになっている。
例えばここでmeasurables[0]は`Text`に対応して、measurables[1]は`SnackImage`に対応する。
このMeasurableに対して `Measurable#measure()`を呼び出すと `Placeable` を返す。

## 一番シンプルな例

一番左上にすべての物を置く例がこちらになります。

以下の流れを行っています。

1. それぞれのアイテムのmeasureを呼び出す。
2. layout()を呼ぶ。
3. それぞれのアイテムを置く(placeを呼び出す)。

```kotlin
Layout(
  modifier = ...,
  children = {
      Text(
          text = category.name,
          ...
       )
       SnackImage(
          ...
       )
  }
) { measurables: List<Measurable>, 
    constraints: Constraints->
    // 1. それぞれのアイテムのmeasureを呼び出す。
    val placeables = measurables.map {
        it.measure(constraints)
    }
    // 2. layout()を呼ぶ。
    layout(
            width = constraints.maxWidth,
            height = constraints.maxHeight
    ) {
        placeables.forEach {
            // 3. それぞれのアイテムを置く(placeを呼び出す)。
            it.place(
                    x = 0,
                    y = 0
            )
        }
    }
}
```

placeable.place()関数は、うまくKotlin DSLの機能を使っておりlayout()のブロックの中でしか呼べなくなっています。

## Jetpack Composeのサンプルではどうやっているか？

以下のように実際に行っているようです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/27388/c88915ad-4310-7d22-3a9d-725d51db1fde.png)

https://github.com/android/compose-samples/blob/34a75fb3672622a3fb0e6a78adc88bbc2886c28f/Jetsnack/app/src/main/java/com/example/jetsnack/ui/home/search/Categories.kt#L102 より

コードの中にコメントとして解説を入れてみました。

```kotlin
    Layout(
        modifier = modifier
        // レイアウトのアスペクト比を設定しておく、これがconstraintsに反映されると思われる
            .aspectRatio(1.45f)
            .drawShadow(elevation = 3.dp, shape = CategoryShape)
            .clip(CategoryShape)
            .horizontalGradientBackground(gradient)
            .clickable { /* todo */ },
        children = {
            Text(
                text = category.name,
                style = MaterialTheme.typography.subtitle1,
                color = JetsnackTheme.colors.textSecondary,
                modifier = Modifier
                    .padding(4.dp)
                    .padding(start = 8.dp)
            )
            SnackImage(
                imageUrl = category.imageUrl,
                modifier = Modifier.fillMaxSize()
            )
        }
    ) { measurables, constraints ->
        // 文字の割合を設定する (55%)
        val textWidth = (constraints.maxWidth * CategoryTextProportion).toInt()
        // 横を固定の大きさでConsntraintを渡してmeasure()する
        val textPlaceable = measurables[0].measure(Constraints.fixedWidth(textWidth))

        // 画像が大きい場合はそのサイズをそのまま使って、小さい場合はConstraintの最大サイズを使う
        // アイテムより大きく表示される(がアイテムの大きさで切り抜かれる)
        val imageSize = max(MinImageSize.toIntPx(), constraints.maxHeight)
        // 縦横の大きさを固定でConstraintを渡してmeasure()する
        val imagePlaceable = measurables[1].measure(Constraints.fixed(imageSize, imageSize))
        // おそらくここでModifierに渡したaspectRatioを使って、レイアウトを行って大きさを決定する。
        layout(
            width = constraints.maxWidth,
            height = constraints.minHeight
        ) {
            // テキストを左に置く
            textPlaceable.place(
                x = 0,
                y = (constraints.maxHeight - textPlaceable.height) / 2 // 中央に設置
            )
            // テキストの横幅をxとして指定することで左に置く、画像は外まではみ出すが、クリップされる
            imagePlaceable.place(
                x = textWidth,
                y = (constraints.maxHeight - imagePlaceable.height) / 2 // 中央に設置
            )
        }
    }
}
```

## 他の例

![scroll.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/27388/f05e6d45-6571-51f4-d13c-9169d0e38b44.gif)

スクロールで伸縮するのもこのLayout()で実現できるようです。

```kotlin
@Composable
private fun Image(
    imageUrl: String,
    scroll: Float
) {
    val collapseRange = with(DensityAmbient.current) { (MaxTitleOffset - MinTitleOffset).toPx() }
    val collapseFraction = (scroll / collapseRange).coerceIn(0f, 1f)

    CollapsingImageLayout(
        collapseFraction = collapseFraction,
        modifier = HzPadding.then(Modifier.statusBarsPadding())
    ) {
        SnackImage(
            imageUrl = imageUrl,
            modifier = Modifier.fillMaxSize()
        )
    }
}

@Composable
private fun CollapsingImageLayout(
    collapseFraction: Float,
    modifier: Modifier = Modifier,
    image: @Composable () -> Unit
) {
    Layout(
        modifier = modifier,
        children = image
    ) { measurables, constraints ->
        check(measurables.size == 1)

        val imageMaxSize = min(ExpandedImageSize.toIntPx(), constraints.maxWidth)
        val imageMinSize = max(CollapsedImageSize.toIntPx(), constraints.minWidth)
        val imageWidth = lerp(imageMaxSize, imageMinSize, collapseFraction)
        // **measureを呼ぶ**
        val imagePlaceable = measurables[0].measure(Constraints.fixed(imageWidth, imageWidth))
        
        // lerpは直線上にある２つのベクトル間を補間する関数らしい
        val imageY = lerp(MinTitleOffset, MinImageOffset, collapseFraction).toIntPx()
        val imageX = lerp(
            (constraints.maxWidth - imageWidth) / 2, // centered when expanded
            constraints.maxWidth - imageWidth, // right aligned when collapsed
            collapseFraction
        )
        // **layoutを呼ぶ**
        layout(
            width = constraints.maxWidth,
            height = imageY + imageWidth
        ) {
        // **placeを呼ぶ**
            imagePlaceable.place(imageX, imageY)
        }
    }
}
```

## どのようにスクロールと連動させるか？

ScrollStateを作成し、Body()、ScrollableColumn()にわたすことで、スクロールの変化を渡せるようになるようです。

```kotlin
@Composable
fun SnackDetail(
...
) {
...
    Stack(Modifier.fillMaxSize()) {
        val scroll = rememberScrollState(0f) // ← ここでScrollStateを作成
...
        Body(related, scroll)
...
        Image(snack.imageUrl, scroll.value)
...
    }

private fun Body(
    related: List<SnackCollection>,
    scroll: ScrollState
) {
    Column {
...
        ScrollableColumn(scrollState = scroll) {
...
```

## 他にもいろいろある

他にも `JetsnackBottomNavLayout` などで以下のような動きなども実装されています。
![bottonnav.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/27388/e813c5cc-4ac1-4f63-5640-06d8bfeb2493.gif)

ここに載っているので確認してみてください。
https://github.com/android/compose-samples/tree/master/Jetsnack#features

# まとめ
Layout()はわかりやすいですが、原始的な仕組みになるので、自分で高さの大きさの計算などは行わないといけません。
おそらく今後スクロールでうまく動かせるようなライブラリやうまくBottomNavigationなどをうまく動かしたりできるようなComposeのComponentなどが追加されていくと思いますが、
今後中のコードを読んだりするときに役立ったり、自分で頑張って実装するときの参考になりそうです。