[Navigation Rail] Added Navigation Rail component to the library.

PiperOrigin-RevId: 355235369

Author: raajkumars

catalog/java/io/material/catalog/navigationrail/NavigationRailDemoFragment.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2020 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.material.catalog.navigationrail;
+
+import io.material.catalog.R;
+
+import android.os.Bundle;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+import androidx.annotation.Nullable;
+import io.material.catalog.feature.DemoFragment;
+
+/** A fragment that displays the main Navigation Rail demo for the Catalog app. */
+public class NavigationRailDemoFragment extends DemoFragment {
+
+  @Override
+  public View onCreateDemoView(LayoutInflater layoutInflater,
+      @Nullable ViewGroup viewGroup,
+      @Nullable Bundle bundle) {
+    return layoutInflater.inflate(R.layout.nav_rail_main_demo, viewGroup, false);
+  }
+}

catalog/java/io/material/catalog/navigationrail/NavigationRailFragment.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2020 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.material.catalog.navigationrail;
+
+import io.material.catalog.R;
+
+import androidx.fragment.app.Fragment;
+import androidx.annotation.Nullable;
+import dagger.Provides;
+import dagger.android.ContributesAndroidInjector;
+import dagger.multibindings.IntoSet;
+import io.material.catalog.application.scope.ActivityScope;
+import io.material.catalog.application.scope.FragmentScope;
+import io.material.catalog.feature.Demo;
+import io.material.catalog.feature.DemoLandingFragment;
+import io.material.catalog.feature.FeatureDemo;
+
+/** A landing fragment that links to Navigation Rail demos for the Catalog app. */
+public class NavigationRailFragment extends DemoLandingFragment {
+
+  @Override
+  public int getTitleResId() {
+    return R.string.cat_nav_rail_title;
+  }
+
+  @Override
+  public int getDescriptionResId() {
+    return R.string.cat_nav_rail_description;
+  }
+
+  @Override
+  public Demo getMainDemo() {
+    return new Demo() {
+      @Nullable
+      @Override
+      public Fragment createFragment() {
+        return new NavigationRailDemoFragment();
+      }
+    };
+  }
+
+  /** The Dagger module for {@link NavigationRailFragment} dependencies. */
+  @dagger.Module
+  public abstract static class Module {
+    @FragmentScope
+    @ContributesAndroidInjector
+    abstract NavigationRailFragment contributeInjector();
+
+    @IntoSet
+    @Provides
+    @ActivityScope
+    static FeatureDemo provideFeatureDemo() {
+      return new FeatureDemo(R.string.cat_nav_rail_title, R.drawable.ic_bottomnavigation) {
+        @Override
+        public Fragment createFragment() {
+          return new NavigationRailFragment();
+        }
+      };
+    }
+  }
+}

catalog/java/io/material/catalog/navigationrail/res/layout/nav_rail_main_demo.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Copyright 2020 The Android Open Source Project
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  -->
+
+<androidx.constraintlayout.widget.ConstraintLayout
+  xmlns:android="http://schemas.android.com/apk/res/android"
+  xmlns:app="http://schemas.android.com/apk/res-auto"
+  android:layout_width="match_parent"
+  android:layout_height="match_parent" >
+
+  <TextView
+    android:layout_width="wrap_content"
+    android:layout_height="wrap_content"
+    android:text="Navigation Rail Coming Soon"
+    app:layout_constraintStart_toStartOf="parent"
+    app:layout_constraintEnd_toEndOf="parent"
+    app:layout_constraintTop_toTopOf="parent"
+    app:layout_constraintBottom_toBottomOf="parent"/>
+</androidx.constraintlayout.widget.ConstraintLayout>

catalog/java/io/material/catalog/navigationrail/res/values/strings.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  Copyright 2020 The Android Open Source Project
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  -->
+<resources>
+  <string name="cat_nav_rail_title">Navigation Rail</string>
+  <string name="cat_nav_rail_description">
+    Navigation Rails make it easy to explore and switch between top-level views in a single
+    tap. This navigational element resides at the bottom of the screen, and provides direct access
+    for three to five destinations within an app.
+  </string>
+</resources>

lib/build.gradle

@@ -59,6 +59,7 @@ def srcDirs = [
   'com/google/android/material/math',
   'com/google/android/material/menu',
   'com/google/android/material/navigation',
+  'com/google/android/material/navigationrail',
   'com/google/android/material/progressindicator',
   'com/google/android/material/radiobutton',
   'com/google/android/material/resources',

lib/java/com/google/android/material/dialog/res/values/themes_base_bridge.xml

@@ -61,6 +61,7 @@
     <item name="materialButtonOutlinedStyle">@style/Widget.MaterialComponents.Button.OutlinedButton</item>
     <item name="materialButtonToggleGroupStyle">@style/Widget.MaterialComponents.MaterialButtonToggleGroup</item>
     <item name="materialCardViewStyle">@style/Widget.MaterialComponents.CardView</item>
+    <item name="navigationRailStyle">@style/Widget.MaterialComponents.NavigationRailView</item>
     <item name="sliderStyle">@style/Widget.MaterialComponents.Slider</item>
 
     <!-- Type styles -->
@@ -141,6 +142,7 @@
     <item name="materialButtonOutlinedStyle">@style/Widget.MaterialComponents.Button.OutlinedButton</item>
     <item name="materialButtonToggleGroupStyle">@style/Widget.MaterialComponents.MaterialButtonToggleGroup</item>
     <item name="materialCardViewStyle">@style/Widget.MaterialComponents.CardView</item>
+    <item name="navigationRailStyle">@style/Widget.MaterialComponents.NavigationRailView</item>
     <item name="sliderStyle">@style/Widget.MaterialComponents.Slider</item>
 
     <!-- Type styles -->

lib/java/com/google/android/material/navigation/res-public/values/public.xml

@@ -19,7 +19,6 @@
 <resources>
   <public name="navigationViewStyle" type="attr"/>
 
-  <public name="headerLayout" type="attr"/>
   <public name="itemBackground" type="attr"/>
   <public name="itemHorizontalPadding" type="attr"/>
   <public name="itemTextAppearance" type="attr"/>

lib/java/com/google/android/material/navigation/res/values/attrs.xml

@@ -80,7 +80,7 @@
     <attr name="itemBackground" format="reference"/>
     <attr name="itemTextAppearance" format="reference"/>
     <!-- Layout resource to inflate as the header -->
-    <attr name="headerLayout" format="reference"/>
+    <attr name="headerLayout"/>
     <!-- Horizontal padding (left and right) of navigation items, around the icon & text -->
     <attr name="itemHorizontalPadding" format="dimension"/>
     <!-- Padding between the icon and the text for navigation items that display an icon  -->

lib/java/com/google/android/material/navigationrail/NavigationRailItemView.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.material.navigationrail;
+
+import com.google.android.material.R;
+
+import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP;
+
+import android.content.Context;
+import androidx.annotation.DimenRes;
+import androidx.annotation.LayoutRes;
+import androidx.annotation.NonNull;
+import androidx.annotation.RestrictTo;
+import com.google.android.material.navigation.NavigationBarItemView;
+
+/** @hide For internal use only. */
+@RestrictTo(LIBRARY_GROUP)
+final class NavigationRailItemView extends NavigationBarItemView {
+  public NavigationRailItemView(@NonNull Context context) {
+    super(context);
+  }
+
+  @Override
+  @LayoutRes
+  protected int getItemLayoutResId() {
+    return R.layout.mtrl_navigation_rail_item;
+  }
+
+  @Override
+  @DimenRes
+  protected int getItemDefaultMarginResId() {
+    return R.dimen.mtrl_navigation_rail_margin;
+  }
+}

lib/java/com/google/android/material/navigationrail/NavigationRailMenuView.java

@@ -0,0 +1,127 @@
+/*
+ * Copyright (C) 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.material.navigationrail;
+
+import static android.view.ViewGroup.LayoutParams.WRAP_CONTENT;
+import static androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP;
+import static com.google.android.material.navigationrail.NavigationRailView.DEFAULT_MENU_GRAVITY;
+import static java.lang.Math.min;
+
+import android.content.Context;
+import androidx.appcompat.view.menu.MenuBuilder;
+import android.view.Gravity;
+import android.view.View;
+import android.view.ViewGroup;
+import android.widget.FrameLayout;
+import androidx.annotation.NonNull;
+import androidx.annotation.RestrictTo;
+import com.google.android.material.navigation.NavigationBarItemView;
+import com.google.android.material.navigation.NavigationBarMenuView;
+
+/** @hide For internal use only. */
+@RestrictTo(LIBRARY_GROUP)
+public class NavigationRailMenuView extends NavigationBarMenuView {
+
+  private final FrameLayout.LayoutParams layoutParams =
+      new FrameLayout.LayoutParams(WRAP_CONTENT, WRAP_CONTENT);
+
+  public NavigationRailMenuView(@NonNull Context context) {
+    super(context);
+
+    layoutParams.gravity = DEFAULT_MENU_GRAVITY;
+    setLayoutParams(layoutParams);
+  }
+
+  @Override
+  protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
+    int childHeightSpec = makeSharedHeightSpec(widthMeasureSpec, heightMeasureSpec);
+
+    int childCount = getChildCount();
+    int maxWidth = 0;
+    int totalHeight = 0;
+    for (int i = 0; i < childCount; i++) {
+      final View child = getChildAt(i);
+      if (child.getVisibility() != GONE) {
+        child.measure(widthMeasureSpec, childHeightSpec);
+        ViewGroup.LayoutParams params = child.getLayoutParams();
+        params.width = child.getMeasuredWidth();
+        params.height = child.getMeasuredHeight();
+        totalHeight += params.height;
+        if (params.width > maxWidth) {
+          maxWidth = params.width;
+        }
+      }
+    }
+
+    // Set view to use a fixed width, but wrap all item heights
+    setMeasuredDimension(
+        View.resolveSizeAndState(
+            maxWidth,
+            MeasureSpec.makeMeasureSpec(maxWidth, MeasureSpec.EXACTLY),
+            /* childMeasuredState= */ 0),
+        View.resolveSizeAndState(
+            totalHeight,
+            MeasureSpec.makeMeasureSpec(totalHeight, MeasureSpec.EXACTLY),
+            /* childMeasuredState= */ 0));
+  }
+
+  @Override
+  protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
+    final int count = getChildCount();
+    final int width = right - left;
+    int used = 0;
+    for (int i = 0; i < count; i++) {
+      final View child = getChildAt(i);
+      if (child.getVisibility() != GONE) {
+        int childHeight = child.getMeasuredHeight();
+        child.layout(/* l= */ 0, used, width, childHeight + used);
+        used += childHeight;
+      }
+    }
+  }
+
+  @Override
+  @NonNull
+  protected NavigationBarItemView createNavigationBarItemView(@NonNull Context context) {
+    return new NavigationRailItemView(context);
+  }
+
+  private int makeSharedHeightSpec(int parentWidthSpec, int parentHeightSpec) {
+    MenuBuilder menu = getMenu();
+    int visibleCount = menu.getVisibleItems().size();
+    int maxHeight = MeasureSpec.getSize(parentHeightSpec);
+    int maxAvailable = maxHeight / (visibleCount == 0 ? 1 : visibleCount);
+
+    return MeasureSpec.makeMeasureSpec(
+        min(MeasureSpec.getSize(parentWidthSpec), maxAvailable), MeasureSpec.EXACTLY);
+  }
+
+  void setMenuGravity(int gravity) {
+    if (layoutParams.gravity != gravity) {
+      layoutParams.gravity = gravity;
+      setLayoutParams(layoutParams);
+    }
+  }
+
+  int getMenuGravity() {
+    return layoutParams.gravity;
+  }
+
+  boolean isTopGravity() {
+    return (layoutParams.gravity & Gravity.VERTICAL_GRAVITY_MASK) == Gravity.TOP;
+  }
+}