@material/toolbar

@material/toolbar

Version 2.3.0
Published 4 years ago
678 kB
7 dependencies
MIT license

Install

npm i @material/toolbar

yarn add @material/toolbar

pnpm add @material/toolbar

Overview

The Material Components for the web toolbar component

Namespaces

module '@material/toolbar' {}

const cssClasses: {
    FIXED: string;
    FIXED_AT_LAST_ROW: string;
    FIXED_LASTROW: string;
    FLEXIBLE_DEFAULT_BEHAVIOR: string;
    FLEXIBLE_MAX: string;
    FLEXIBLE_MIN: string;
    TOOLBAR_ROW_FLEXIBLE: string;
};

Copyright 2017 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.

const numbers: {
    MAX_TITLE_SIZE: number;
    MIN_TITLE_SIZE: number;
    TOOLBAR_MOBILE_BREAKPOINT: number;
    TOOLBAR_ROW_HEIGHT: number;
    TOOLBAR_ROW_MOBILE_HEIGHT: number;
};

const strings: {
    CHANGE_EVENT: string;
    FIRST_ROW_SELECTOR: string;
    ICON_SELECTOR: string;
    TITLE_SELECTOR: string;
};

class MDCToolbar extends MDCComponent<MDCToolbarFoundation> {}

fixedAdjustElement: HTMLElement;

protected root_: HTMLElement;

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

destroy: () => void;

getDefaultFoundation: () => MDCToolbarFoundation;

initialize: () => void;

class MDCToolbarFoundation extends MDCFoundation<MDCToolbarAdapter> {}

constructor(adapter?: Partial<MDCToolbarAdapter>);

static readonly cssClasses: {
    FIXED: string;
    FIXED_AT_LAST_ROW: string;
    FIXED_LASTROW: string;
    FLEXIBLE_DEFAULT_BEHAVIOR: string;
    FLEXIBLE_MAX: string;
    FLEXIBLE_MIN: string;
    TOOLBAR_ROW_FLEXIBLE: string;
};

static readonly defaultAdapter: MDCToolbarAdapter;

static readonly numbers: {
    MAX_TITLE_SIZE: number;
    MIN_TITLE_SIZE: number;
    TOOLBAR_MOBILE_BREAKPOINT: number;
    TOOLBAR_ROW_HEIGHT: number;
    TOOLBAR_ROW_MOBILE_HEIGHT: number;
};

static readonly strings: {
    CHANGE_EVENT: string;
    FIRST_ROW_SELECTOR: string;
    ICON_SELECTOR: string;
    TITLE_SELECTOR: string;
};

destroy: () => void;

init: () => void;

updateAdjustElementStyles: () => void;

interface MDCToolbarAdapter {}

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

addClass: (className: string) => void;

deregisterResizeHandler: (handler: SpecificEventListener<'resize'>) => void;

deregisterScrollHandler: (handler: SpecificEventListener<'scroll'>) => void;

getFirstRowElementOffsetHeight: () => number;

getOffsetHeight: () => number;

getViewportScrollY: () => number;

getViewportWidth: () => number;

hasClass: (className: string) => boolean;

notifyChange: (evtData: MDCToolbarEventDetail) => void;

registerResizeHandler: (handler: SpecificEventListener<'resize'>) => void;

registerScrollHandler: (handler: SpecificEventListener<'scroll'>) => void;

removeClass: (className: string) => void;

setStyle: (property: string, value: string) => void;

setStyleForFixedAdjustElement: (property: string, value: string) => void;

setStyleForFlexibleRowElement: (property: string, value: string) => void;

setStyleForTitleElement: (property: string, value: string) => void;

interface MDCToolbarEvent extends Event {}

readonly detail: MDCToolbarEventDetail;

interface MDCToolbarEventDetail {}

Copyright 2019 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.

flexibleExpansionRatio: number;

module '@material/toolbar/adapter' {}

interface MDCToolbarAdapter {}

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

addClass: (className: string) => void;

deregisterResizeHandler: (handler: SpecificEventListener<'resize'>) => void;

deregisterScrollHandler: (handler: SpecificEventListener<'scroll'>) => void;

getFirstRowElementOffsetHeight: () => number;

getOffsetHeight: () => number;

getViewportScrollY: () => number;

getViewportWidth: () => number;

hasClass: (className: string) => boolean;

notifyChange: (evtData: MDCToolbarEventDetail) => void;

registerResizeHandler: (handler: SpecificEventListener<'resize'>) => void;

registerScrollHandler: (handler: SpecificEventListener<'scroll'>) => void;

removeClass: (className: string) => void;

setStyle: (property: string, value: string) => void;

setStyleForFixedAdjustElement: (property: string, value: string) => void;

setStyleForFlexibleRowElement: (property: string, value: string) => void;

setStyleForTitleElement: (property: string, value: string) => void;

module '@material/toolbar/component' {}

class MDCToolbar extends MDCComponent<MDCToolbarFoundation> {}

fixedAdjustElement: HTMLElement;

protected root_: HTMLElement;

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

destroy: () => void;

getDefaultFoundation: () => MDCToolbarFoundation;

initialize: () => void;

module '@material/toolbar/constants' {}

const cssClasses: {
    FIXED: string;
    FIXED_AT_LAST_ROW: string;
    FIXED_LASTROW: string;
    FLEXIBLE_DEFAULT_BEHAVIOR: string;
    FLEXIBLE_MAX: string;
    FLEXIBLE_MIN: string;
    TOOLBAR_ROW_FLEXIBLE: string;
};

Copyright 2017 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.

const numbers: {
    MAX_TITLE_SIZE: number;
    MIN_TITLE_SIZE: number;
    TOOLBAR_MOBILE_BREAKPOINT: number;
    TOOLBAR_ROW_HEIGHT: number;
    TOOLBAR_ROW_MOBILE_HEIGHT: number;
};

const strings: {
    CHANGE_EVENT: string;
    FIRST_ROW_SELECTOR: string;
    ICON_SELECTOR: string;
    TITLE_SELECTOR: string;
};

module '@material/toolbar/foundation' {}

class MDCToolbarFoundation extends MDCFoundation<MDCToolbarAdapter> {}

constructor(adapter?: Partial<MDCToolbarAdapter>);

static readonly cssClasses: {
    FIXED: string;
    FIXED_AT_LAST_ROW: string;
    FIXED_LASTROW: string;
    FLEXIBLE_DEFAULT_BEHAVIOR: string;
    FLEXIBLE_MAX: string;
    FLEXIBLE_MIN: string;
    TOOLBAR_ROW_FLEXIBLE: string;
};

static readonly defaultAdapter: MDCToolbarAdapter;

static readonly numbers: {
    MAX_TITLE_SIZE: number;
    MIN_TITLE_SIZE: number;
    TOOLBAR_MOBILE_BREAKPOINT: number;
    TOOLBAR_ROW_HEIGHT: number;
    TOOLBAR_ROW_MOBILE_HEIGHT: number;
};

static readonly strings: {
    CHANGE_EVENT: string;
    FIRST_ROW_SELECTOR: string;
    ICON_SELECTOR: string;
    TITLE_SELECTOR: string;
};

destroy: () => void;

init: () => void;

updateAdjustElementStyles: () => void;

module '@material/toolbar/types' {}

interface MDCToolbarEvent extends Event {}

readonly detail: MDCToolbarEventDetail;

interface MDCToolbarEventDetail {}

Copyright 2019 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.

flexibleExpansionRatio: number;

Package Files (1)

dist/mdc.toolbar.d.ts

Dependencies (7)

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/toolbar.

Markdown

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

HTML

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

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

@material/toolbar

Install

Overview

Index

Namespaces

Namespaces

namespace @material/toolbar

variable cssClasses

variable numbers

variable strings

class MDCToolbar

property fixedAdjustElement

property root_

method attachTo

method destroy

method getDefaultFoundation

method initialize

class MDCToolbarFoundation

constructor

property cssClasses

property defaultAdapter

property numbers

property strings

method destroy

method init

method updateAdjustElementStyles

interface MDCToolbarAdapter

property addClass

property deregisterResizeHandler

property deregisterScrollHandler

property getFirstRowElementOffsetHeight

property getOffsetHeight

property getViewportScrollY

property getViewportWidth

property hasClass

property notifyChange

property registerResizeHandler

property registerScrollHandler

property removeClass

property setStyle

property setStyleForFixedAdjustElement

property setStyleForFlexibleRowElement

property setStyleForTitleElement

interface MDCToolbarEvent

property detail

interface MDCToolbarEventDetail

property flexibleExpansionRatio

namespace @material/toolbar/adapter

interface MDCToolbarAdapter

property addClass

property deregisterResizeHandler

property deregisterScrollHandler

property getFirstRowElementOffsetHeight

property getOffsetHeight

property getViewportScrollY

property getViewportWidth

property hasClass

property notifyChange

property registerResizeHandler

property registerScrollHandler

property removeClass

property setStyle

property setStyleForFixedAdjustElement

property setStyleForFlexibleRowElement

property setStyleForTitleElement

namespace @material/toolbar/component

class MDCToolbar

property fixedAdjustElement

property root_

method attachTo

method destroy

method getDefaultFoundation

method initialize

namespace @material/toolbar/constants

variable cssClasses

variable numbers

variable strings

namespace @material/toolbar/foundation

class MDCToolbarFoundation

constructor