@material/grid-list

@material/grid-list

Version 4.0.0
Published 4 years ago
181 kB
6 dependencies
MIT license

Install

npm i @material/grid-list

yarn add @material/grid-list

pnpm add @material/grid-list

Overview

The Material Components for the web grid list component

Index

Namespaces

@material/grid-list
@material/grid-list/adapter
- MDCGridListAdapter
@material/grid-list/component
- MDCGridList
@material/grid-list/constants
- strings
@material/grid-list/foundation
- MDCGridListFoundation

Namespaces

namespace @material/grid-list

module '@material/grid-list' {}

variable strings

const strings: { TILES_SELECTOR: string; TILE_SELECTOR: string };

Copyright 2016 Google Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

class MDCGridList

class MDCGridList extends MDCComponent<MDCGridListFoundation> {}

method attachTo

static attachTo: (root: Element) => MDCGridList;

method getDefaultFoundation

getDefaultFoundation: () => MDCGridListFoundation;

class MDCGridListFoundation

class MDCGridListFoundation extends MDCFoundation<MDCGridListAdapter> {}

constructor

constructor(adapter?: Partial<MDCGridListAdapter>);

property defaultAdapter

static readonly defaultAdapter: MDCGridListAdapter;

property strings

static readonly strings: { TILES_SELECTOR: string; TILE_SELECTOR: string };

method alignCenter

alignCenter: () => void;

method destroy

destroy: () => void;

method init

init: () => void;

interface MDCGridListAdapter

interface MDCGridListAdapter {}

Defines the shape of the adapter expected by the foundation. Implement this adapter for your framework of choice to delegate updates to the component in your framework of choice. See architecture documentation for more details. https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md

method deregisterResizeHandler

deregisterResizeHandler: (handler: EventListener) => void;

method getNumberOfTiles

getNumberOfTiles: () => number;

method getOffsetWidth

getOffsetWidth: () => number;

method getOffsetWidthForTileAtIndex

getOffsetWidthForTileAtIndex: (index: number) => number;

method registerResizeHandler

registerResizeHandler: (handler: EventListener) => void;

method setStyleForTilesElement

setStyleForTilesElement: (
    property: Exclude<keyof CSSStyleDeclaration, 'length' | 'parentRule'>,
    value: string | null
) => void;

namespace @material/grid-list/adapter

module '@material/grid-list/adapter' {}

interface MDCGridListAdapter

interface MDCGridListAdapter {}

Defines the shape of the adapter expected by the foundation. Implement this adapter for your framework of choice to delegate updates to the component in your framework of choice. See architecture documentation for more details. https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md

method deregisterResizeHandler

deregisterResizeHandler: (handler: EventListener) => void;

method getNumberOfTiles

getNumberOfTiles: () => number;

method getOffsetWidth

getOffsetWidth: () => number;

method getOffsetWidthForTileAtIndex

getOffsetWidthForTileAtIndex: (index: number) => number;

method registerResizeHandler

registerResizeHandler: (handler: EventListener) => void;

method setStyleForTilesElement

setStyleForTilesElement: (
    property: Exclude<keyof CSSStyleDeclaration, 'length' | 'parentRule'>,
    value: string | null
) => void;

namespace @material/grid-list/component

module '@material/grid-list/component' {}

class MDCGridList

class MDCGridList extends MDCComponent<MDCGridListFoundation> {}

method attachTo

static attachTo: (root: Element) => MDCGridList;

method getDefaultFoundation

getDefaultFoundation: () => MDCGridListFoundation;

namespace @material/grid-list/constants

module '@material/grid-list/constants' {}

variable strings

const strings: { TILES_SELECTOR: string; TILE_SELECTOR: string };

Copyright 2016 Google Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

namespace @material/grid-list/foundation

module '@material/grid-list/foundation' {}

class MDCGridListFoundation

class MDCGridListFoundation extends MDCFoundation<MDCGridListAdapter> {}

constructor

constructor(adapter?: Partial<MDCGridListAdapter>);

property defaultAdapter

static readonly defaultAdapter: MDCGridListAdapter;

property strings

static readonly strings: { TILES_SELECTOR: string; TILE_SELECTOR: string };

method alignCenter

alignCenter: () => void;

method destroy

destroy: () => void;

method init

init: () => void;

Package Files (1)

dist/mdc.gridList.d.ts

Dependencies (6)

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@material/grid-list.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@material/grid-list)

HTML

<a href="https://www.jsdocs.io/package/@material/grid-list"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 year ago.
Package analyzed in 1317 ms.
Missing or incorrect documentation? Open an issue for this package.