bitandblack-rows
Version:
A small and simple CSS gutter to create rows and cells using the flexbox model.
107 lines (106 loc) • 2.94 kB
TypeScript
/**
* Bit&Black Rows
*
* @copyright Copyright (c) Bit&Black
* @author Tobias Köngeter <hello@bitandblack.com>
* @link https://www.bitandblack.com
*/
/**
* Receiving information about the cell positions in the grid.
*/
declare class Position {
private _resizeObserver;
private _addCssClassesForOutsideCells;
private _addDataAttributesAboutCellPositions;
private _cssClassFirstOfRow;
private _cssClassLastOfRow;
private _cssClassFirstOfColumn;
private _cssClassLastOfColumn;
constructor();
/**
* Add a rows-container element.
*
* @param element {HTMLElement}
* @return self
*/
add(element: HTMLElement): this;
/**
* Removes a rows-container element from observing.
*
* @param element {HTMLElement}
* @return self
*/
remove(element: HTMLElement): this;
/**
* Tells if adding CSS classes to outside laying cells has been enabled or disabled.
*/
addCssClassesForOutsideCells(): boolean;
/**
* Enable or disable adding CSS classes to outside laying cells.
*
* @param addCssClassesForOutsideCells {boolean}
*/
setAddCssClassesForOutsideCells(addCssClassesForOutsideCells: boolean): this;
/**
* Tells if adding data attributes to each cell with information about its position has been enabled or disabled.
*/
addDataAttributesAboutCellPositions(): boolean;
/**
* Enable or disable adding data attributes to each cell with information about its position.
*
* @param addDataAttributesAboutCellPositions {boolean}
*/
setAddDataAttributesAboutCellPositions(addDataAttributesAboutCellPositions: boolean): this;
/**
* @return {string}
*/
getCssClassFirstOfRow(): string;
/**
* @param cssClassFirstOfRow {string}
* @return self
*/
setCssClassFirstOfRow(cssClassFirstOfRow: string): this;
/**
* @return {string}
*/
getCssClassLastOfRow(): string;
/**
* @param cssClassLastOfRow {string}
* @return self
*/
setCssClassLastOfRow(cssClassLastOfRow: string): this;
/**
* @return {string}
*/
getCssClassFirstOfColumn(): string;
/**
* @param cssClassFirstOfColumn {string}
* @return self
*/
setCssClassFirstOfColumn(cssClassFirstOfColumn: string): this;
/**
* @return {string}
*/
getCssClassLastOfColumn(): string;
/**
* @param cssClassLastOfColumn {string}
* @return self
*/
setCssClassLastOfColumn(cssClassLastOfColumn: string): this;
/**
* @param resizeObserverEntries {ResizeObserverEntry[]}
* @private
*/
private resizeObserverCallback;
/**
* @param resizeObserverEntry {ResizeObserverEntry}
* @private
*/
private handleEntry;
/**
* @param rowElement {HTMLElement}
* @private
*/
private removeElement;
}
export { Position };