mirror of
https://github.com/home-assistant/frontend.git
synced 2025-11-08 02:19:43 +00:00
Add ha-data-table (#3647)
* Work in progress * add sorting implemented in unused entities to try it * implement sorting * fix * Refactor * Default sort, filterable, id * Fix * Add local mdc-data-table + comments + fixes * Move mdc-data-tabel So our linters won't complain...
This commit is contained in:
committed by
Paulus Schoutsen
parent
9f213cf055
commit
b46c9406ff
161
mdc-data-table/adapter.ts
Normal file
161
mdc-data-table/adapter.ts
Normal file
@@ -0,0 +1,161 @@
|
||||
/**
|
||||
* @license
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
import { MDCDataTableRowSelectionChangedEventDetail } from "./types";
|
||||
|
||||
export interface MDCDataTableAdapter {
|
||||
/**
|
||||
* Adds a class name to row element at given row index excluding header row.
|
||||
*
|
||||
* @param rowIndex Index of row element excluding header row.
|
||||
* @param cssClasses CSS Class string to add.
|
||||
*/
|
||||
addClassAtRowIndex(rowIndex: number, cssClasses: string): void;
|
||||
|
||||
/**
|
||||
* @return Row count excluding header row.
|
||||
*/
|
||||
getRowCount(): number;
|
||||
|
||||
/**
|
||||
* @return Array of row elements excluding header row.
|
||||
*/
|
||||
getRowElements(): Element[];
|
||||
|
||||
/**
|
||||
* Returns row id of row element at given row index based on `data-row-id` attribute on row element `tr`.
|
||||
*
|
||||
* @param rowIndex Index of row element.
|
||||
* @return Row id of row element, returns `null` in absence of `data-row-id` attribute on row element.
|
||||
*/
|
||||
getRowIdAtIndex(rowIndex: number): string | null;
|
||||
|
||||
/**
|
||||
* Returns index of row element that contains give child element. Returns -1 if element is not child of any row
|
||||
* element.
|
||||
*
|
||||
* @param el Child element of row element.
|
||||
* @return Index of row element.
|
||||
*/
|
||||
getRowIndexByChildElement(el: Element): number;
|
||||
|
||||
/**
|
||||
* @return Selected row count.
|
||||
*/
|
||||
getSelectedRowCount(): number;
|
||||
|
||||
/**
|
||||
* @param rowIndex Index of row element.
|
||||
* @return True if row checkbox at given row index is checked.
|
||||
*/
|
||||
isCheckboxAtRowIndexChecked(rowIndex: number): boolean;
|
||||
|
||||
/**
|
||||
* @return True if header row checkbox is checked.
|
||||
*/
|
||||
isHeaderRowCheckboxChecked(): boolean;
|
||||
|
||||
/**
|
||||
* @return True if table rows are selectable.
|
||||
*/
|
||||
isRowsSelectable(): boolean;
|
||||
|
||||
/**
|
||||
* Notifies when row selection is changed.
|
||||
*
|
||||
* @param data Event detail data for row selection changed event.
|
||||
*/
|
||||
notifyRowSelectionChanged(
|
||||
data: MDCDataTableRowSelectionChangedEventDetail
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Notifies when header row is checked.
|
||||
*/
|
||||
notifySelectedAll(): void;
|
||||
|
||||
/**
|
||||
* Notifies when header row is unchecked.
|
||||
*/
|
||||
notifyUnselectedAll(): void;
|
||||
|
||||
/**
|
||||
* Initializes header row checkbox. Destroys previous header row checkbox instance if any.
|
||||
* @return Can return Promise only if registering checkbox is asynchronous.
|
||||
*/
|
||||
registerHeaderRowCheckbox(): Promise<void> | void;
|
||||
|
||||
/**
|
||||
* Initializes all row checkboxes. Destroys previous row checkbox instances if any. This is usually called when row
|
||||
* checkboxes are added or removed from table.
|
||||
* @return Can return Promise only if registering checkbox is asynchronous.
|
||||
*/
|
||||
registerRowCheckboxes(): Promise<void> | void;
|
||||
|
||||
/**
|
||||
* Removes class name from row element at give row index.
|
||||
*
|
||||
* @param rowIndex Index of row element excluding header row element.
|
||||
* @param cssClasses Class name string.
|
||||
*/
|
||||
removeClassAtRowIndex(rowIndex: number, cssClasses: string): void;
|
||||
|
||||
/**
|
||||
* Sets attribute to row element at given row index.
|
||||
*
|
||||
* @param rowIndex Index of row element excluding header row element.
|
||||
* @param attr Name of attribute.
|
||||
* @param value Value of attribute.
|
||||
*/
|
||||
setAttributeAtRowIndex(rowIndex: number, attr: string, value: string): void;
|
||||
|
||||
/**
|
||||
* Sets header row checkbox checked or unchecked.
|
||||
*
|
||||
* @param checked True to set header row checkbox checked.
|
||||
*/
|
||||
setHeaderRowCheckboxChecked(checked: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets header row checkbox to indeterminate.
|
||||
*
|
||||
* @param indeterminate True to set header row checkbox indeterminate.
|
||||
*/
|
||||
setHeaderRowCheckboxIndeterminate(indeterminate: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets row checkbox to checked or unchecked at given row index.
|
||||
*
|
||||
* @param rowIndex Index of row element excluding header row element.
|
||||
* @param checked True to set checked.
|
||||
*/
|
||||
setRowCheckboxCheckedAtIndex(rowIndex: number, checked: boolean): void;
|
||||
}
|
||||
Reference in New Issue
Block a user