UNPKG

@material/web

Version:
71 lines (70 loc) 2.21 kB
/** * @license * Copyright 2023 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { Item } from './internal/item.js'; declare global { interface HTMLElementTagNameMap { 'md-item': MdItem; } } /** * An item layout component that can be used inside list items to give them * their customizable structure. * * `<md-item>` does not have any functionality, which must be added by the * component using it. * * All text will wrap unless `white-space: nowrap` is set on the item or any of * its children. * * Slots available: * - `<default>`: The headline, or custom content. * - `headline`: The first line. * - `supporting-text`: Supporting text lines underneath the headline. * - `trailing-supporting-text`: A small text snippet at the end of the item. * - `start`: Any leading content, such as icons, avatars, or checkboxes. * - `end`: Any trailing content, such as icons and buttons. * - `container`: Background container content, intended for adding additional * styles, such as ripples or focus rings. * * @example * ```html * <md-item>Single line</md-item> * * <md-item> * <div class="custom-content">...</div> * </md-item> * * <!-- Classic 1 to 3+ line list items --> * <md-item> * <md-icon slot="start">image</md-icon> * <div slot="overline">Overline</div> * <div slot="headline">Headline</div> * <div="supporting-text">Supporting text</div> * <div="trailing-supporting-text">Trailing</div> * <md-icon slot="end">image</md-icon> * </md-item> * ``` * * When wrapping `<md-item>`, forward the available slots to use the same slot * structure for the wrapping component (this is what `<md-list-item>` does). * * @example * ```html * <md-item> * <slot></slot> * <slot name="overline" slot="overline"></slot> * <slot name="headline" slot="headline"></slot> * <slot name="supporting-text" slot="supporting-text"></slot> * <slot name="trailing-supporting-text" * slot="trailing-supporting-text"></slot> * <slot name="start" slot="start"></slot> * <slot name="end" slot="end"></slot> * </md-item> * ``` */ export declare class MdItem extends Item { static styles: import("lit").CSSResult[]; }