Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
package.index.d.ts Maven / Gradle / Ivy
Web's fastest template library to build user interfaces.
declare class Mikado {
constructor(template: Template|TemplateName, options?: MikadoOptions);
name: TemplateName;
root: HTMLElement|null;
state: Object;
length: number;
mount(target: HTMLElement, hydrate?: boolean): Mikado;
render(data?: Object|Array, state?: Object, callback?: Function): Mikado;
render(data?: Object|Array, state?: Object, callback?: true): Promise;
render(data?: Object|Array, callback?: Function): Mikado;
render(data?: Object|Array, callback?: true): Promise;
add(data: Object, state?: Object, position?: number): Mikado;
add(data: Object, position?: number): Mikado;
append(data: Array, state?: Object, position?: number): Mikado;
append(data: Array, position?: number): Mikado;
update(node: HTMLElement|number, data?: Object, state?: Object): Mikado;
replace(node: HTMLElement|number, data: Object, state?: Object): Mikado;
remove(index: HTMLElement|number, count?: number): Mikado;
create(data: Object, state?: Object, index?: number): HTMLElement;
cancel(): Mikado;
clear(): Mikado;
destroy(): void;
flush(): void;
index(node: HTMLElement): number;
node(index: number): HTMLElement;
route(name: string, fn: Function|null, options?: RouteOptions): Mikado;
listen(event: string, options?: EventListenerOptions|boolean): Mikado;
unlisten(event: string): Mikado;
dispatch(name: string, target?: HTMLElement, event?: Event): Mikado;
move(node: HTMLElement|number, index: number): Mikado;
before(node_a: HTMLElement|number, node_b: HTMLElement|number): Mikado;
after(node_a: HTMLElement|number, node_b: HTMLElement|number): Mikado;
up(node: HTMLElement|number, offset?: number): Mikado;
down(node: HTMLElement|number, offset?: number): Mikado;
shift(node: HTMLElement|number, offset: number, state?: Object): Mikado;
swap(node_a: HTMLElement|number, node_b: HTMLElement|number, state?: Object): Mikado;
first(a: HTMLElement|number): Mikado;
last(a: HTMLElement|number): Mikado;
}
declare namespace Mikado {
const eventCache: boolean;
const eventBubble: boolean;
function once(root: HTMLElement, template: Template|TemplateName, data?: Object|Array, state?: Object, callback?: Function): Mikado;
function once(root: HTMLElement, template: Template|TemplateName, data?: Object|Array, state?: Object, callback?: true): Promise;
function once(root: HTMLElement, template: Template|TemplateName, data?: Object|Array, callback?: Function): Mikado;
function once(root: HTMLElement, template: Template|TemplateName, data?: Object|Array, callback?: true): Promise;
function once(root: HTMLElement, template: Template|TemplateName, callback?: Function): Mikado;
function once(root: HTMLElement, template: Template|TemplateName, callback?: true): Promise;
function compile(node: HTMLTemplateElement|HTMLElement|string): Template;
function route(name: string, fn: Function|null, options?: RouteOptions): Mikado;
function listen(event: string, options?: EventListenerOptions|boolean): Mikado;
function unlisten(event: string): Mikado;
function dispatch(route: string, target?: HTMLElement, event?: Event): Mikado;
function register(template: Template|TemplateName, options: MikadoOptions): Mikado;
function unregister(template: TemplateName|Template): Mikado;
class array {
constructor(array?: Array);
length: number;
mount(mikado: Mikado): array;
concat(array: Array): array;
filter(handler: Function, self?: any): array;
forEach(handler: Function): void;
indexOf(search: Object): number;
lastIndexOf(search: Object): number;
includes(search: Object): boolean;
map(handler: Function, self?: any): array;
pop(): Object;
push(data: Object): void;
reverse(): array;
set(array?: Array): array;
shift(): Object;
slice(index?: number): Array;
sort(handler: Function): array;
splice(start?: number, count?: number, insert?: Object): Array;
swap(index_a: number, index_b: number): array;
unshift(data: Object): void;
transaction(fn: Function): array;
}
function getClass(target: HTMLElement): Array;
function setClass(target: HTMLElement, classname: string|Array): Mikado;
function hasClass(target: HTMLElement, classname: string): boolean;
function toggleClass(target: HTMLElement, classname: string|Array, state?: boolean): Mikado;
function toggleClass(target: HTMLElement, classnames: {[classname: string]: boolean}): Mikado;
function removeClass(target: HTMLElement, classname: string|Array): Mikado;
function addClass(target: HTMLElement, classname: string|Array): Mikado;
function getAttribute(target: HTMLElement, attribute: string): string;
function hasAttribute(target: HTMLElement, attribute: string): boolean;
function removeAttribute(target: HTMLElement, attribute: string|Array): Mikado;
function setAttribute(target: HTMLElement, attribute: string, value: string): Mikado;
function setAttribute(target: HTMLElement, attributes: {[attribute: string]: string}): Mikado;
function setHtml(target: HTMLElement, html: string): Mikado;
function getHtml(target: HTMLElement): string;
function setText(target: HTMLElement, text: string): Mikado;
function getText(target: HTMLElement): string;
function setCss(target: HTMLElement, style: string): Mikado;
function getCss(target: HTMLElement): string;
function setStyle(target: HTMLElement, property: string, value: string): Mikado;
function setStyle(target: HTMLElement, styles: {[property: string]: string}): Mikado;
function getStyle(target: HTMLElement, property: string): string;
function escape(text: string): string;
function sanitize(text: string): string;
}
type TemplateName = string;
type Template = {
name: TemplateName;
tpl: TemplateDOM;
cmp?: TemplateDOM;
fn: Array|null;
key?: string;
cache?: boolean;
}
type TemplateDOM = {
tag?: string;
style?: string|[string];
class?: string|[string];
text?: string|[string];
html?: string|[string];
attr?: {[attribute: string]: string|[string]};
event?: {[event: string]: string|[string]};
child?: TemplateDOM|Array;
inc?: string|number;
key?: string;
cache?: boolean;
svg?: 1;
}
type MikadoOptions = {
root?: HTMLElement;
mount?: HTMLElement;
cache?: boolean;
recycle?: boolean;
hydrate?: boolean;
async?: boolean;
pool?: boolean;
state?: Object;
observe?: Mikado.array;
shadow?: boolean;
on?: MikadoCallbacks;
}
type MikadoCallbacks = {
create?: Function;
update?: Function;
replace?: Function;
recycle?: Function;
insert?: Function;
remove?: Function;
mount?: Function;
unmount?: Function;
}
type RouteOptions = {
prevent?: boolean;
stop?: boolean;
cancel?: boolean;
once?: boolean;
}
export = Mikado;
