dcarlsson 8bd429a410 Add documentation for new MaterialCardView class
PiperOrigin-RevId: 181376638
2018-01-11 11:14:32 -05:00

2.9 KiB

Material Card

Material Card is a customizable component based on CardView from the Android Support Library. MaterialCardView provides all of the features of CardView and also includes an unelevated card style and parameters for an outline stroke on the card. The stroke outline should be used for unelevated cards and requires width and color values.

Design & API Documentation

Usage

The MaterialCardView component provides an in-progress implementation of Material Design's card component. It will continue to receive new features and updates.

The majority of these updates will be style-based with additional options for the layout of content inside of a card (for example: dividers, images, actions, and text treatments). Updates will also include functionality for card behavior in groups of cards.

Example code of how to include the component in your layout is listed here for reference. Note that the margins around the card (its "gutters") need to be listed in the layout of the card and cannot be included in a style tag.

<android.support.design.card.MaterialCardView
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_marginLeft="@dimen/mtrl_card_spacing"
    android:layout_marginTop="@dimen/mtrl_card_spacing"
    android:layout_marginRight="@dimen/mtrl_card_spacing"
    android:minHeight="200dp">
  <TextView
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="@string/demo_card_text"/>
</android.support.design.card.MaterialCardView>

See the summary for CardView for standard attributes that can be changed for a CardView.

The following additional attributes can be changed for a Material card:

  • strokeColor: Color of the stroke path for a card. A stroke will not be drawn unless a strokeColor is provided, regardless of the strokeWidth attribute value.
  • strokeWidth: Size of the stroke path for a card. The default is 0.