@kizmann/pico-js 1.0.13 → 2.0.0

package/types/dom/DomGlobal.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @memberof PicoDom
+ */
+export class PicoDomGlobalStatic {
+    /**
+     * Get document ready state
+     *
+     * @example Dom.getDomState() // => "complete"
+     *
+     * @returns {string} State string
+     */
+    static getDomState(): string;
+    /**
+     * Check if DOM is ready
+     *
+     * @example Dom.isDomReady() // => true
+     *
+     * @returns {boolean} True if ready
+     */
+    static isDomReady(): boolean;
+    /**
+     * Check if DOM is complete
+     *
+     * @example Dom.isDomComplete() // => true
+     *
+     * @returns {boolean} True if complete
+     */
+    static isDomComplete(): boolean;
+    /**
+     * Run callback when ready
+     *
+     * @example Dom.ready(cb)
+     *
+     * @param {function} cb Callback fn
+     * @param {number} [delay] Execution delay
+     * @param {number} [limit] Wait limit
+     * @returns {this} Static class
+     */
+    static ready(cb: Function, delay?: number, limit?: number): this;
+    /**
+     * Run callback when complete
+     *
+     * @example Dom.complete(cb)
+     *
+     * @param {function} cb Callback fn
+     * @param {number} [delay] Execution delay
+     * @param {number} [limit] Wait limit
+     * @returns {this} Static class
+     */
+    static complete(cb: Function, delay?: number, limit?: number): this;
+}
+export namespace PicoDomGlobalStatic {
+    function required(): void;
+}
+/**
+ * @memberof PicoDom
+ * @extends {PicoDom}
+ */
+export class PicoDomGlobalInstance {
+    /**
+     * Check if node is complete
+     *
+     * @example Dom.find("img").isNodeComplete() // => true
+     *
+     * @returns {boolean} True if complete
+     */
+    isNodeComplete(): boolean;
+    /**
+     * Run callback when loaded
+     *
+     * @example Dom.find("img").loaded(cb)
+     *
+     * @param {function} cb Callback fn
+     * @param {number} [limit] Wait limit
+     * @returns {this} Current instance
+     */
+    loaded(cb: Function, limit?: number): this;
+}
+export function PicoDomGlobalPlugin(self: any): typeof import("#src/utils/Dom.js").PicoDom;

package/types/dom/DomInview.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @memberof PicoDom
+ */
+export class PicoDomInviewStatic {
+    /**
+     * Get first inview element Y
+     *
+     * @example Dom.inviewMaxY(".item")
+     *
+     * @param {any} options Find options
+     * @param {function} [cb] Success callback
+     * @returns {any} Found element
+     */
+    static inviewMaxY(options: any, cb?: Function): any;
+    /**
+     * Get first inview element X
+     *
+     * @example Dom.inviewMaxX(".item")
+     *
+     * @param {any} options Find options
+     * @param {function} [cb] Success callback
+     * @returns {any} Found element
+     */
+    static inviewMaxX(options: any, cb?: Function): any;
+}
+/**
+ * @memberof PicoDom
+ * @extends {PicoDom}
+ */
+export class PicoDomInviewInstance {
+    /**
+     * Get X view offset
+     *
+     * @example Dom.find("div").viewoffX()
+     *
+     * @returns {any} Offset object
+     */
+    viewoffX(): any;
+    /**
+     * Get X inview pixels
+     *
+     * @example Dom.find("div").inviewX()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Inview pixels
+     */
+    inviewX(boundry?: any): number;
+    /**
+     * Get X inview ratio
+     *
+     * @example Dom.find("div").inratioX()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Inview ratio
+     */
+    inratioX(boundry?: any): number;
+    /**
+     * Check if is inview X
+     *
+     * @example Dom.find("div").isInviewX(0.5)
+     *
+     * @param {number} [threshold] View threshold
+     * @param {string} [mode] View mode
+     * @param {any} [boundry] View boundry
+     * @returns {boolean} True if inview
+     */
+    isInviewX(threshold?: number, mode?: string, boundry?: any): boolean;
+    /**
+     * Get Y view offset
+     *
+     * @example Dom.find("div").viewoffY()
+     *
+     * @returns {any} Offset object
+     */
+    viewoffY(): any;
+    /**
+     * Get Y inview pixels
+     *
+     * @example Dom.find("div").inviewY()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Inview pixels
+     */
+    inviewY(boundry?: any): number;
+    /**
+     * Get Y inview ratio
+     *
+     * @example Dom.find("div").inratioY()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Inview ratio
+     */
+    inratioY(boundry?: any): number;
+    /**
+     * Check if is inview Y
+     *
+     * @example Dom.find("div").isInviewY(0.5)
+     *
+     * @param {number} [threshold] View threshold
+     * @param {string} [mode] View mode
+     * @param {any} [boundry] View boundry
+     * @returns {boolean} True if inview
+     */
+    isInviewY(threshold?: number, mode?: string, boundry?: any): boolean;
+    /**
+     * @see PicoDom.inviewY
+     */
+    inviewHeight(...args: any[]): number;
+    /**
+     * @see PicoDom.inviewX
+     */
+    inviewWidth(...args: any[]): number;
+}
+export function PicoDomInviewPlugin(self: any): typeof import("#src/utils/Dom.js").PicoDom;

package/types/dom/DomMeta.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @memberof PicoDom
+ */
+export class PicoDomMetaStatic {
+    static $meta: {};
+    /**
+     * Set document title
+     *
+     * @example Dom.setMetaTitle("Home")
+     *
+     * @param {string} value New title
+     * @param {string} [glue] Title glue
+     * @returns {this} Static class
+     */
+    static setMetaTitle(value: string, glue?: string): this;
+}
+export namespace PicoDomMetaStatic {
+    /**
+     * @see PicoDom.setMetaTitle
+     */
+    function title(value: any): any;
+}
+/**
+ * @memberof PicoDom
+ * @extends {PicoDom}
+ */
+export class PicoDomMetaInstance {
+}
+export function PicoDomMetaPlugin(self: any): typeof import("#src/utils/Dom.js").PicoDom;

package/types/dom/DomObserver.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @memberof PicoDom
+ */
+export class PicoDomObserverStatic {
+}
+/**
+ * @memberof PicoDom
+ * @extends {PicoDom}
+ */
+export class PicoDomObserverInstance {
+    /**
+     * Get or set element value
+     *
+     * @example Dom.find("input").value("hello")
+     *
+     * @param {any} [value] New value
+     * @returns {any|this} Value or instance
+     */
+    value(value?: any): any | this;
+}
+export function PicoDomObserverPlugin(self: any): typeof import("#src/utils/Dom.js").PicoDom;

package/types/dom/DomRectangle.d.ts

@@ -0,0 +1,270 @@
+/**
+ * @memberof PicoDom
+ */
+export class PicoDomRectangleStatic {
+    /**
+     * Cast value to number
+     *
+     * @example Dom.num("10px") // => 10
+     *
+     * @param {any} value Input value
+     * @returns {number} Number value
+     */
+    static num(value: any): number;
+}
+/**
+ * @memberof PicoDom
+ * @extends {PicoDom}
+ */
+export class PicoDomRectangleInstance {
+    /**
+     * Get margin values
+     *
+     * @example Dom.find("div").margin()
+     *
+     * @param {string} [key] Margin key
+     * @param {number} [fallback] Fallback value
+     * @returns {any} Margin values
+     */
+    margin(key?: string, fallback?: number): any;
+    /**
+     * Get padding values
+     *
+     * @example Dom.find("div").padding()
+     *
+     * @param {string} [key] Padding key
+     * @param {number} [fallback] Fallback value
+     * @returns {any} Padding values
+     */
+    padding(key?: string, fallback?: number): any;
+    /**
+     * Get element height
+     *
+     * @example Dom.find("div").height() // => 100
+     *
+     * @returns {number} Height value
+     */
+    height(): number;
+    /**
+     * Get client height
+     *
+     * @example Dom.find("div").clientHeight()
+     *
+     * @returns {number} Height value
+     */
+    clientHeight(): number;
+    /**
+     * Get scroll height
+     *
+     * @example Dom.find("div").scrollHeight()
+     *
+     * @returns {number} Height value
+     */
+    scrollHeight(): number;
+    /**
+     * Get inner height
+     *
+     * @example Dom.find("div").innerHeight()
+     *
+     * @returns {number} Height value
+     */
+    innerHeight(): number;
+    /**
+     * Get real height
+     *
+     * @example Dom.find("div").realHeight({ display: "block" })
+     *
+     * @param {any} [style] Temp style
+     * @returns {number} Height value
+     */
+    realHeight(style?: any): number;
+    /**
+     * Evaluate target height
+     *
+     * @example Dom.find("div").evaluateHeight(".container")
+     *
+     * @param {any} [target] Target element
+     * @param {boolean} [apply] Apply style
+     * @returns {number} Height value
+     */
+    evaluateHeight(target?: any, apply?: boolean): number;
+    /**
+     * Get element width
+     *
+     * @example Dom.find("div").width() // => 100
+     *
+     * @returns {number} Width value
+     */
+    width(): number;
+    /**
+     * Get client width
+     *
+     * @example Dom.find("div").clientWidth()
+     *
+     * @returns {number} Width value
+     */
+    clientWidth(): number;
+    /**
+     * Get scroll width
+     *
+     * @example Dom.find("div").scrollWidth()
+     *
+     * @returns {number} Width value
+     */
+    scrollWidth(): number;
+    /**
+     * Get inner width
+     *
+     * @example Dom.find("div").innerWidth()
+     *
+     * @returns {number} Width value
+     */
+    innerWidth(): number;
+    /**
+     * Get real width
+     *
+     * @example Dom.find("div").realWidth({ display: "block" })
+     *
+     * @param {any} [style] Temp style
+     * @returns {number} Width value
+     */
+    realWidth(style?: any): number;
+    /**
+     * Evaluate target width
+     *
+     * @example Dom.find("div").evaluateWidth(".container")
+     *
+     * @param {any} [target] Target element
+     * @param {boolean} [apply] Apply style
+     * @returns {number} Width value
+     */
+    evaluateWidth(target?: any, apply?: boolean): number;
+    /**
+     * Get element offset
+     *
+     * @example Dom.find("div").offset()
+     *
+     * @param {string} [key] Offset key
+     * @param {any} [boundry] View boundry
+     * @returns {any} Offset values
+     */
+    offset(key?: string, boundry?: any): any;
+    /**
+     * Get top offset
+     *
+     * @example Dom.find("div").offsetTop()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Top offset
+     */
+    offsetTop(boundry?: any): number;
+    /**
+     * Get bottom offset
+     *
+     * @example Dom.find("div").offsetBottom()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Bottom offset
+     */
+    offsetBottom(boundry?: any): number;
+    /**
+     * Get left offset
+     *
+     * @example Dom.find("div").offsetLeft()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Left offset
+     */
+    offsetLeft(boundry?: any): number;
+    /**
+     * Get right offset
+     *
+     * @example Dom.find("div").offsetRight()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {number} Right offset
+     */
+    offsetRight(boundry?: any): number;
+    /**
+     * Loop through offset parents
+     *
+     * @example Dom.find("div").loopOffset((el) => console.log(el))
+     *
+     * @param {function} cb Callback fn
+     * @param {any} [boundry] Loop limit
+     * @returns {this} Current instance
+     */
+    loopOffset(cb: Function, boundry?: any): this;
+    /**
+     * Calculate relative offset
+     *
+     * @example Dom.calcOffset(offset, 100, 100)
+     *
+     * @param {any} offset Base offset
+     * @param {number} width Element width
+     * @param {number} height Element height
+     * @returns {any} Calculated offset
+     */
+    calcOffset(offset: any, width: number, height: number): any;
+    /**
+     * Get relative offset
+     *
+     * @example Dom.find("div").getOffset()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {any} Offset values
+     */
+    getOffset(boundry?: any): any;
+    /**
+     * Get element scroll
+     *
+     * @example Dom.find("div").scroll()
+     *
+     * @param {any} [key] Scroll key
+     * @param {any} [boundry] View boundry
+     * @returns {any} Scroll values
+     */
+    scroll(key?: any, boundry?: any): any;
+    /**
+     * Get or set scroll top
+     *
+     * @example Dom.find("div").scrollTop(100)
+     *
+     * @param {any} [value] Scroll value
+     * @param {any} [boundry] View boundry
+     * @returns {number|this} Value or instance
+     */
+    scrollTop(value?: any, boundry?: any): number | this;
+    /**
+     * Get or set scroll left
+     *
+     * @example Dom.find("div").scrollLeft(100)
+     *
+     * @param {any} [value] Scroll value
+     * @param {any} [boundry] View boundry
+     * @returns {number|this} Value or instance
+     */
+    scrollLeft(value?: any, boundry?: any): number | this;
+    /**
+     * Get relative scroll
+     *
+     * @example Dom.find("div").getScroll()
+     *
+     * @param {any} [boundry] View boundry
+     * @returns {any} Scroll values
+     */
+    getScroll(boundry?: any): any;
+    /**
+     * @see PicoDom.loopOffsetParent
+     */
+    loopOffsetParent(...args: any[]): PicoDomRectangleInstance;
+    /**
+     * @see PicoDom.scrollTopGlobal
+     */
+    scrollTopGlobal(): any;
+    /**
+     * @see PicoDom.scrollLeftGlobal
+     */
+    scrollLeftGlobal(): any;
+}
+export function PicoDomRectanglePlugin(self: any): typeof import("#src/utils/Dom.js").PicoDom;

package/types/format/FormatFile.d.ts

@@ -0,0 +1,18 @@
+export const FILE_UNITS: string[];
+/**
+ * @memberof PicoFormat
+ * @extends {PicoFormat}
+ */
+export class PicoFormatFileStatic {
+    /**
+     * Format file size
+     *
+     * @example Format.filesize(1000) // => "1.0 KB"
+     *
+     * @param {any} value Bytes value
+     * @param {number} [decimals] Decimal points
+     * @returns {string} Formatted size
+     */
+    static filesize(value: any, decimals?: number): string;
+}
+export function PicoFormatFilePlugin(self: any): typeof import("#src/utils/Format.js").PicoFormat;

package/types/format/FormatOption.d.ts

@@ -0,0 +1,40 @@
+export namespace OPTION_REGEX {
+    let entry: RegExp;
+}
+/**
+ * @memberof PicoFormat
+ */
+export class PicoFormatOptionStatic {
+    /**
+     * Cast object to options string
+     *
+     * @example Format.castOptions({ a: 1 }) // => "a: 1;"
+     *
+     * @param {any} [options] Input options
+     * @param {boolean} [space] Add space
+     * @returns {string} Options string
+     */
+    static castOptions(options?: any, space?: boolean): string;
+    /**
+     * Cast single option to string
+     *
+     * @example Format.castOption("a", 1) // => "a: 1"
+     *
+     * @param {string} key Option key
+     * @param {any} value Option value
+     * @param {string} [path] Key path
+     * @param {boolean} [space] Add space
+     * @returns {string} Option string
+     */
+    static castOption(key: string, value: any, path?: string, space?: boolean): string;
+    /**
+     * Parse options string
+     *
+     * @example Format.parseOptions("a: 1;") // => { a: 1 }
+     *
+     * @param {string} value Options string
+     * @returns {any} Options object
+     */
+    static parseOptions(value: string): any;
+}
+export function PicoFormatOptionPlugin(self: any): typeof import("#src/utils/Format.js").PicoFormat;

package/types/format/FormatParam.d.ts

@@ -0,0 +1,39 @@
+export namespace PARAM_REGEX {
+    let entry: RegExp;
+}
+/**
+ * @memberof PicoFormat
+ * @extends {PicoFormat}
+ */
+export class PicoFormatParamStatic {
+    /**
+     * Cast object to params string
+     *
+     * @example Format.castParams({ a: 1 }) // => "a=1"
+     *
+     * @param {any} [params] Input params
+     * @returns {string} Params string
+     */
+    static castParams(params?: any): string;
+    /**
+     * Cast single param to string
+     *
+     * @example Format.castParam("a", 1) // => "a=1"
+     *
+     * @param {string} key Param key
+     * @param {any} value Param value
+     * @param {string} [path] Key path
+     * @returns {string} Param string
+     */
+    static castParam(key: string, value: any, path?: string): string;
+    /**
+     * Parse params string
+     *
+     * @example Format.parseParams("a=1") // => { a: 1 }
+     *
+     * @param {string} value Params string
+     * @returns {any} Params object
+     */
+    static parseParams(value: string): any;
+}
+export function PicoFormatParamPlugin(self: any): typeof import("#src/utils/Format.js").PicoFormat;

package/types/format/FormatParser.d.ts

@@ -0,0 +1,46 @@
+export const TYPE_PARSERS: {
+    match: (val: any) => boolean;
+    parse: (val: any) => any;
+}[];
+export const TYPE_CASTERS: {
+    match: (val: any) => boolean;
+    parse: (val: any) => string;
+}[];
+/**
+ * @memberof PicoFormat
+ */
+export class PicoFormatParserStatic {
+    /**
+     * Convert key path format
+     *
+     * @example Format.keyed("a[b]") // => "a.b"
+     *
+     * @param {any} value Input key
+     * @param {any} [fallback] Fallback value
+     * @returns {string} Keyed string
+     */
+    static keyed(value: any, fallback?: any): string;
+    /**
+     * Parse value by type
+     *
+     * @example Format.parsed("true") // => true
+     *
+     * @param {any} value Input value
+     * @param {any} [fallback] Fallback value
+     * @param {Array<any>} [parsers] Custom parsers
+     * @returns {any} Parsed value
+     */
+    static parsed(value: any, fallback?: any, parsers?: Array<any>): any;
+    /**
+     * Cast value to string
+     *
+     * @example Format.casted(true) // => "true"
+     *
+     * @param {any} value Input value
+     * @param {boolean} [encode] Encode value
+     * @param {Array<any>} [casters] Custom casters
+     * @returns {string} Casted string
+     */
+    static casted(value: any, encode?: boolean, casters?: Array<any>): string;
+}
+export function PicoFormatParserPlugin(self: any): typeof import("#src/utils/Format.js").PicoFormat;

package/types/format/FormatUrl.d.ts

@@ -0,0 +1,17 @@
+export const SLUG_CONVERT: string[][];
+/**
+ * @memberof PicoFormat
+ * @extends {PicoFormat}
+ */
+export class PicoFormatUrlStatic {
+    /**
+     * Create slug from string
+     *
+     * @example Format.slugify("Hello World") // => "hello-world"
+     *
+     * @param {any} value Input string
+     * @returns {string} Slug string
+     */
+    static slugify(value: any): string;
+}
+export function PicoFormatUrlPlugin(self: any): typeof import("#src/utils/Format.js").PicoFormat;

package/types/index.browser.d.ts

@@ -0,0 +1 @@
+export {};