uni-shared.d.ts 10.0 KB
Newer Older
fxy060608's avatar
fxy060608 已提交
1 2 3
import { FontFaceDescriptors } from 'css-font-loading-module';

export declare function addFont(family: string, source: string, desc?: FontFaceDescriptors): Promise<void>;
fxy060608's avatar
fxy060608 已提交
4 5 6

export declare const BUILT_IN_TAGS: string[];

fxy060608's avatar
fxy060608 已提交
7 8
export declare const cacheStringFunction: <T extends (str: string) => string>(fn: T) => T;

Q
qiang 已提交
9 10 11 12 13 14 15
export declare function callOptions(options: Options, errMsg: string): void;

export declare function callOptions(options: Options, data: {
    [key: string]: any;
    errMsg: string;
}): void;

fxy060608's avatar
fxy060608 已提交
16 17
export declare const COMPONENT_NAME_PREFIX = "VUni";

fxy060608's avatar
fxy060608 已提交
18 19 20
export declare const COMPONENT_PREFIX: string;

export declare const COMPONENT_SELECTOR_PREFIX = "uni-";
fxy060608's avatar
fxy060608 已提交
21

fxy060608's avatar
fxy060608 已提交
22 23
export declare function createRpx2Unit(unit: string, unitRatio: number, unitPrecision: number): (val: string) => string;

fxy060608's avatar
fxy060608 已提交
24 25
export declare const DATA_RE: RegExp;

fxy060608's avatar
fxy060608 已提交
26 27 28 29 30
export declare function debounce(fn: Function, delay: number): {
    (this: any): void;
    cancel(): void;
};

fxy060608's avatar
fxy060608 已提交
31 32 33 34 35 36 37 38 39
/**
 * Decode text using `decodeURIComponent`. Returns the original text if it
 * fails.
 *
 * @param text - string to decode
 * @returns decoded string
 */
export declare function decode(text: string | number): string;

fxy060608's avatar
fxy060608 已提交
40
export declare function decodeAttr(name: string): any;
fxy060608's avatar
fxy060608 已提交
41

fxy060608's avatar
fxy060608 已提交
42 43
export declare function decodedQuery(query?: Record<string, any>): Record<string, string>;

fxy060608's avatar
fxy060608 已提交
44 45
export declare function decodeTag(tag: string | number): string | number;

fxy060608's avatar
fxy060608 已提交
46 47 48 49 50 51
export declare const defaultRpx2Unit: {
    unit: string;
    unitRatio: number;
    unitPrecision: number;
};

fxy060608's avatar
fxy060608 已提交
52 53 54 55
export declare function encodeAttr(name: string): string;

export declare function encodeTag(tag: string): string | number;

D
DCloud_LXH 已提交
56 57 58 59 60
export declare function formatDateTime({ date, mode }: {
    date?: Date | undefined;
    mode?: string | undefined;
}): string;

Q
qiang 已提交
61
export declare function getCustomDataset(el: HTMLElement | HTMLElementWithDataset): DOMStringMap & Record<string, any>;
Q
qiang 已提交
62

fxy060608's avatar
fxy060608 已提交
63 64
export declare function getEnvLocale(): string;

fxy060608's avatar
fxy060608 已提交
65 66
export declare function getLen(str?: string): number;

Q
qiang 已提交
67 68 69 70
declare interface HTMLElementWithDataset extends HTMLElement {
    __uniDataset?: Record<string, any>;
}

Q
qiang 已提交
71
export declare function initCustomDataset(): void;
Q
qiang 已提交
72

fxy060608's avatar
fxy060608 已提交
73 74
export declare const invokeArrayFns: (fns: Function[], arg?: any) => any;

fxy060608's avatar
fxy060608 已提交
75 76 77 78 79 80
export declare function isBuiltInComponent(tag: string): boolean;

export declare function isCustomElement(tag: string): boolean;

export declare function isNativeTag(tag: string): boolean;

fxy060608's avatar
fxy060608 已提交
81 82 83 84
export declare function isServiceCustomElement(_tag: string): boolean;

export declare function isServiceNativeTag(tag: string): boolean;

fxy060608's avatar
fxy060608 已提交
85 86
export declare interface IUniPageNode {
    pageId: number;
fxy060608's avatar
fxy060608 已提交
87
    pageNode: IUniPageNode | null;
fxy060608's avatar
fxy060608 已提交
88 89
    genId: () => number;
    push: (...args: any[]) => void;
fxy060608's avatar
fxy060608 已提交
90 91 92 93 94 95 96
    onCreate: (thisNode: UniNode, nodeName: string | number) => UniNode;
    onInsertBefore: (thisNode: UniNode, newChild: UniNode, index: number) => UniNode;
    onRemoveChild: (thisNode: UniNode, oldChild: UniNode) => UniNode;
    onSetAttribute: (thisNode: UniNode, qualifiedName: string, value: unknown) => void;
    onRemoveAttribute: (thisNode: UniNode, qualifiedName: string) => void;
    onTextContent: (thisNode: UniNode, text: string) => void;
    onNodeValue: (thisNode: UniNode, val: string | null) => void;
fxy060608's avatar
fxy060608 已提交
97 98
}

fxy060608's avatar
fxy060608 已提交
99 100
export declare const NAVBAR_HEIGHT = 44;

fxy060608's avatar
fxy060608 已提交
101 102 103 104 105 106 107 108
export declare const NODE_TYPE_COMMENT = 8;

export declare const NODE_TYPE_ELEMENT = 1;

export declare const NODE_TYPE_PAGE = 0;

export declare const NODE_TYPE_TEXT = 3;

fxy060608's avatar
fxy060608 已提交
109 110
export declare function normalizeDataset(el: Element): any;

fxy060608's avatar
fxy060608 已提交
111 112
export declare function normalizeTarget(el: HTMLElement): {
    id: string;
Q
qiang 已提交
113
    dataset: DOMStringMap & Record<string, any>;
fxy060608's avatar
fxy060608 已提交
114 115 116 117
    offsetTop: number;
    offsetLeft: number;
};

fxy060608's avatar
fxy060608 已提交
118 119
export declare const ON_REACH_BOTTOM_DISTANCE = 50;

fxy060608's avatar
fxy060608 已提交
120
export declare function once<T extends (...args: any[]) => any>(fn: T, ctx?: unknown): T;
fxy060608's avatar
fxy060608 已提交
121

Q
qiang 已提交
122 123 124 125 126 127
declare interface Options {
    success?: (res: any) => void;
    fail?: (res: any) => void;
    complete?: (res: any) => void;
}

fxy060608's avatar
fxy060608 已提交
128 129 130 131 132 133 134 135 136
/**
 * https://github.com/vuejs/vue-router-next/blob/master/src/query.ts
 * @internal
 *
 * @param search - search string to parse
 * @returns a query object
 */
export declare function parseQuery(search: string): Record<string, any>;

fxy060608's avatar
fxy060608 已提交
137 138 139 140
export declare function passive(passive: boolean): {
    passive: boolean;
};

fxy060608's avatar
fxy060608 已提交
141 142
export declare const PLUS_RE: RegExp;

fxy060608's avatar
fxy060608 已提交
143 144
export declare function plusReady(callback: () => void): void;

fxy060608's avatar
fxy060608 已提交
145 146
export declare const PRIMARY_COLOR = "#007aff";

fxy060608's avatar
fxy060608 已提交
147 148
export declare function removeLeadingSlash(str: string): string;

fxy060608's avatar
fxy060608 已提交
149 150
export declare const RESPONSIVE_MIN_WIDTH = 768;

fxy060608's avatar
fxy060608 已提交
151 152
export declare type Rpx2UnitOptions = typeof defaultRpx2Unit;

fxy060608's avatar
fxy060608 已提交
153 154
export declare const sanitise: (val: unknown) => any;

fxy060608's avatar
fxy060608 已提交
155 156
export declare const SCHEME_RE: RegExp;

fxy060608's avatar
fxy060608 已提交
157 158 159
declare function scrollTo_2(scrollTop: number | string, duration: number): void;
export { scrollTo_2 as scrollTo }

fxy060608's avatar
fxy060608 已提交
160 161
export declare const SELECTED_COLOR = "#0062cc";

fxy060608's avatar
fxy060608 已提交
162 163 164 165 166 167
export declare function stringifyQuery(obj?: Record<string, any>, encodeStr?: typeof encodeURIComponent): string;

export declare const TABBAR_HEIGHT = 50;

export declare const TAGS: string[];

fxy060608's avatar
fxy060608 已提交
168 169 170 171 172 173
export declare const UNI_SSR = "__uniSSR";

export declare const UNI_SSR_DATA = "data";

export declare const UNI_SSR_GLOBAL_DATA = "globalData";

fxy060608's avatar
fxy060608 已提交
174 175
export declare const UNI_SSR_STORE = "store";

fxy060608's avatar
fxy060608 已提交
176 177
export declare const UNI_SSR_TITLE = "title";

fxy060608's avatar
fxy060608 已提交
178 179 180 181
export declare class UniBaseNode extends UniNode {
    attributes: Record<string, unknown>;
    style: UniCSSStyleDeclaration;
    protected _html: string | null;
fxy060608's avatar
fxy060608 已提交
182
    constructor(nodeType: UniNodeType, nodeName: string, container: UniElement | IUniPageNode);
fxy060608's avatar
fxy060608 已提交
183 184 185 186 187 188 189 190 191
    get className(): string;
    set className(val: string);
    get innerHTML(): string;
    set innerHTML(html: string);
    addEventListener(type: string, listener: UniEventListener, options?: AddEventListenerOptions): void;
    removeEventListener(type: string, callback: UniEventListener, options?: EventListenerOptions): void;
    getAttribute(qualifiedName: string): unknown;
    removeAttribute(qualifiedName: string): void;
    setAttribute(qualifiedName: string, value: unknown): void;
fxy060608's avatar
fxy060608 已提交
192 193 194 195
    toJSON(opts?: {
        attr?: boolean;
        children?: boolean;
    }): Partial<UniNodeJSON>;
fxy060608's avatar
fxy060608 已提交
196 197 198
}

export declare class UniCommentNode extends UniNode {
fxy060608's avatar
fxy060608 已提交
199 200 201 202 203 204 205 206 207 208
    constructor(text: string, container: UniElement | IUniPageNode);
    toJSON(opts?: {
        attr?: boolean;
    }): {
        t: string;
        i?: undefined;
    } | {
        i: number;
        t: string;
    };
fxy060608's avatar
fxy060608 已提交
209 210 211 212 213 214 215 216 217 218 219
}

declare class UniCSSStyleDeclaration {
    [name: string]: string | unknown;
    private _cssText;
    private _value;
    setProperty(property: string, value: string | null): void;
    getPropertyValue(property: string): string | string[];
    removeProperty(property: string): string;
    get cssText(): string;
    set cssText(cssText: string);
fxy060608's avatar
fxy060608 已提交
220
    toJSON(): UniCSSStyleDeclarationJSON | undefined;
fxy060608's avatar
fxy060608 已提交
221 222 223 224 225 226
}

declare type UniCSSStyleDeclarationJSON = string | null | Record<string, string | string[]> | [string, Record<string, string | string[]>];

export declare class UniElement extends UniBaseNode {
    tagName: string;
fxy060608's avatar
fxy060608 已提交
227
    constructor(nodeName: string, container: UniElement | IUniPageNode);
fxy060608's avatar
fxy060608 已提交
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
}

export declare class UniEvent {
    type: string;
    bubbles: boolean;
    cancelable: boolean;
    defaultPrevented: boolean;
    timeStamp: number;
    _stop: boolean;
    _end: boolean;
    constructor(type: string, opts: UniEventOptions);
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

export declare interface UniEventListener {
    (evt: UniEvent): void;
}

declare interface UniEventOptions {
    bubbles: boolean;
    cancelable: boolean;
}

declare class UniEventTarget {
    private _listeners;
    dispatchEvent(evt: UniEvent): boolean;
    addEventListener(type: string, listener: UniEventListener, options?: AddEventListenerOptions): void;
    removeEventListener(type: string, callback: UniEventListener, options?: EventListenerOptions): void;
}

export declare class UniInputElement extends UniElement {
    get value(): string | number;
    set value(val: string | number);
}

export declare class UniNode extends UniEventTarget {
    nodeId?: number;
    nodeType: UniNodeType;
    nodeName: string;
    childNodes: UniNode[];
    pageNode: IUniPageNode | null;
    parentNode: UniNode | null;
    protected _text: string | null;
fxy060608's avatar
fxy060608 已提交
273
    constructor(nodeType: UniNodeType, nodeName: string, container: UniElement | IUniPageNode);
fxy060608's avatar
fxy060608 已提交
274 275 276
    get firstChild(): UniNode | null;
    get lastChild(): UniNode | null;
    get nextSibling(): UniNode | null;
fxy060608's avatar
fxy060608 已提交
277 278
    get nodeValue(): string | null;
    set nodeValue(_val: string | null);
fxy060608's avatar
fxy060608 已提交
279 280 281 282
    get textContent(): string;
    set textContent(text: string);
    get parentElement(): UniElement | null;
    get previousSibling(): UniNode | null;
fxy060608's avatar
fxy060608 已提交
283
    appendChild(newChild: UniNode): UniNode;
fxy060608's avatar
fxy060608 已提交
284
    cloneNode(deep?: boolean): UniNode;
fxy060608's avatar
fxy060608 已提交
285 286
    insertBefore(newChild: UniNode, refChild: UniNode | null): UniNode;
    removeChild(oldChild: UniNode): UniNode;
fxy060608's avatar
fxy060608 已提交
287 288 289 290 291 292 293 294 295 296
}

export declare interface UniNodeJSON {
    /**
     * nodeId
     */
    i: number;
    /**
     * nodeName
     */
fxy060608's avatar
fxy060608 已提交
297
    n: string | number;
fxy060608's avatar
fxy060608 已提交
298 299 300 301 302 303 304
    /**
     * attributes
     */
    a: Record<string, unknown>;
    /**
     * style
     */
fxy060608's avatar
fxy060608 已提交
305
    s?: UniCSSStyleDeclarationJSON;
fxy060608's avatar
fxy060608 已提交
306 307 308 309 310 311 312 313 314 315 316 317
    /**
     * text
     */
    t?: string;
}

declare type UniNodeType = typeof NODE_TYPE_PAGE | typeof NODE_TYPE_ELEMENT | typeof NODE_TYPE_TEXT | typeof NODE_TYPE_COMMENT;

export declare class UniTextAreaElement extends UniInputElement {
}

export declare class UniTextNode extends UniBaseNode {
fxy060608's avatar
fxy060608 已提交
318
    constructor(text: string, container: UniElement | IUniPageNode);
fxy060608's avatar
fxy060608 已提交
319 320 321 322
    get nodeValue(): string;
    set nodeValue(text: string);
}

fxy060608's avatar
fxy060608 已提交
323 324
export declare function updateElementStyle(element: HTMLElement, styles: Partial<CSSStyleDeclaration>): void;

fxy060608's avatar
fxy060608 已提交
325 326
export declare const WEB_INVOKE_APPSERVICE = "WEB_INVOKE_APPSERVICE";

fxy060608's avatar
fxy060608 已提交
327
export { }