SESL Material/com.google.android.material.tabs/TabLayout

TabLayout

open class TabLayout : HorizontalScrollView

(SESL Variant) TabLayout provides a horizontal layout to display tabs.

Population of the tabs to display is done through Tab instances. You create tabs via newTab. From there you can change the tab's label or icon via setText and setIcon respectively. To display the tab, you need to add it to the layout via one of the addTab methods. For example:

TabLayout tabLayout = ...;
tabLayout.addTab(tabLayout.newTab().setText("Tab 1"));
tabLayout.addTab(tabLayout.newTab().setText("Tab 2"));
tabLayout.addTab(tabLayout.newTab().setText("Tab 3"));

You should add a listener via addOnTabSelectedListener to be notified when any tab's selection state has been changed.

You can also add items to TabLayout in your layout through the use of TabItem. An example usage is like so:

<com.google.android.material.tabs.TabLayout
        android:layout_height="wrap_content"
        android:layout_width="match_parent">

    <com.google.android.material.tabs.TabItem
            android:text="@string/tab_text"/>

    <com.google.android.material.tabs.TabItem
            android:icon="@drawable/ic_android"/>

</com.google.android.material.tabs.TabLayout>

ViewPager integration

If you're using a androidx.viewpager.widget.ViewPager together with this layout, you can call setupWithViewPager to link the two together. This layout will be automatically populated from the PagerAdapter's page titles.

This view also supports being used as part of a ViewPager's decor, and can be added directly to the ViewPager in a layout resource file like so:

<androidx.viewpager.widget.ViewPager
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.google.android.material.tabs.TabLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_gravity="top" />

</androidx.viewpager.widget.ViewPager>

For more information, see the component developer guidance and design guidelines.

Constructors

TabLayout

constructor(@NonNull context: Context)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

Types

BaseOnTabSelectedListener

interface ~~BaseOnTabSelectedListener~~<T : TabLayout.Tab?>

Callback interface invoked when a tab's selection state changes.

LabelVisibility

annotation class LabelVisibility

Mode

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class Mode

OnTabSelectedListener

interface OnTabSelectedListener : TabLayout.BaseOnTabSelectedListener<T>

Callback interface invoked when a tab's selection state changes.

Tab

open class Tab

A tab in this layout.

TabGravity

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class TabGravity

TabIndicatorAnimationMode

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class TabIndicatorAnimationMode

TabIndicatorGravity

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class TabIndicatorGravity

TabLayoutOnPageChangeListener

open class TabLayoutOnPageChangeListener : ViewPager.OnPageChangeListener

A ViewPager.OnPageChangeListener class which contains the necessary calls back to the provided TabLayout so that the tab position is kept in sync.

TabView

inner class TabView : LinearLayout

A LinearLayout containing Tab instances for use with TabLayout.

ViewPagerOnTabSelectedListener

open class ViewPagerOnTabSelectedListener : TabLayout.OnTabSelectedListener

A TabLayout.OnTabSelectedListener class which contains the necessary calls back to the provided ViewPager so that the tab position is kept in sync.

Properties

GRAVITY_CENTER

val GRAVITY_CENTER: Int = 1

Gravity used to lay out the tabs in the center of the TabLayout.

GRAVITY_FILL

val GRAVITY_FILL: Int = 0

Gravity used to fill the TabLayout as much as possible.

GRAVITY_START

val GRAVITY_START: Int = 2

Gravity used to lay out the tabs aligned to the start of the TabLayout.

INDICATOR_ANIMATION_MODE_ELASTIC

val INDICATOR_ANIMATION_MODE_ELASTIC: Int = 1

Indicator animation mode used to translate the selected tab indicator by growing and then shrinking the indicator, making the indicator look like it is stretching while translating between destinations.

INDICATOR_ANIMATION_MODE_FADE

val INDICATOR_ANIMATION_MODE_FADE: Int = 2

Indicator animation mode used to switch the selected tab indicator from one tab to another by sequentially fading it out from the current destination and in at its new destination.

INDICATOR_ANIMATION_MODE_LINEAR

val INDICATOR_ANIMATION_MODE_LINEAR: Int = 0

Indicator animation mode used to translate the selected tab indicator between two tabs using a linear motion.

INDICATOR_GRAVITY_BOTTOM

val INDICATOR_GRAVITY_BOTTOM: Int = 0

Indicator gravity used to align the tab selection indicator to the bottom of the .

INDICATOR_GRAVITY_CENTER

val INDICATOR_GRAVITY_CENTER: Int = 1

Indicator gravity used to align the tab selection indicator to the center of the .

INDICATOR_GRAVITY_STRETCH

val INDICATOR_GRAVITY_STRETCH: Int = 3

Indicator gravity used to stretch the tab selection indicator across the entire height of the TabLayout.

INDICATOR_GRAVITY_TOP

val INDICATOR_GRAVITY_TOP: Int = 2

Indicator gravity used to align the tab selection indicator to the top of the .

MODE_AUTO

val MODE_AUTO: Int = 2

Auto-sizing tabs behave like MODE_FIXED with GRAVITY_CENTER while the tabs fit within the TabLayout's content width.

MODE_FIXED

val MODE_FIXED: Int = 1

Fixed tabs display all tabs concurrently and are best used with content that benefits from quick pivots between tabs.

MODE_SCROLLABLE

val MODE_SCROLLABLE: Int = 0

Scrollable tabs display a subset of tabs at any given moment, and can contain longer tab labels and a larger number of tabs.

SESL_MODE_FIXED_AUTO

val SESL_MODE_FIXED_AUTO: Int = 11

Auto-sizing tabs behave like MODE_FIXED with GRAVITY_FILL while the tabs fit within the TabLayout's content width.

SESL_MODE_WEIGHT_AUTO

val SESL_MODE_WEIGHT_AUTO: Int = 12

Auto-sizing tabs behave like MODE_FIXED with GRAVITY_FILL while the tabs fit within the TabLayout's content width.

TAB_LABEL_VISIBILITY_LABELED

val TAB_LABEL_VISIBILITY_LABELED: Int = 1

This mode is set by default.

TAB_LABEL_VISIBILITY_UNLABELED

val TAB_LABEL_VISIBILITY_UNLABELED: Int = 0

If a tab is instantiated with setText, and this mode is set, the text will be saved and utilized for the content description, but no visible labels will be created.

tabGravity

open var tabGravity: Int

tabIconTint

@get:Nullable

open var tabIconTint: ColorStateList

tabIndicatorAnimationMode

open var tabIndicatorAnimationMode: Int

tabIndicatorGravity

open val tabIndicatorGravity: Int

tabSelectedIndicator

@NonNull

@get:NonNull