@layoutaid/core
Version:
Dev tool that adds visual layout aid for integrating web pages
48 lines (44 loc) • 1.12 kB
text/typescript
interface ColumnsConfig {
/**
* The number of columns to create.
* @default 14
*/
count?: number;
/**
* The color of the columns.
* @default a light blue 0.6 opacity
*/
color?: string;
/**
* Whether to persist the columns state between page loads.
* @default true
*/
persist?: boolean;
}
declare function columns(config: ColumnsConfig): void;
interface OutlineConfig {
/**
* The color of the outline.
* @default red
*/
color?: string;
/**
* Whether to persist the outline state between page loads.
* @default true
*/
persist?: boolean;
}
declare function outline(config: OutlineConfig): void;
interface LayoutaidConfig {
/**
* The configuration for the columns module.
* Can be set to false to disable it.
*/
columns: ColumnsConfig | false;
/**
* The configuration for the outline module.
* Can be set to false to disable it.
*/
outline: OutlineConfig | false;
}
export { type ColumnsConfig, type LayoutaidConfig, type OutlineConfig, columns, outline };