x4js 1.5.21 → 1.5.23

package/lib/types/svgcomponent.d.ts

@@ -0,0 +1,215 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file svgcomponent.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, CProps } from './component';
+/**
+ *
+ */
+declare abstract class SVGItem {
+    private m_tag;
+    private m_attrs;
+    private m_style;
+    constructor(tag: string);
+    /**
+     * render the item
+     * @returns
+     */
+    render(): string;
+    /**
+     * change the stroke color
+     * @param color
+     */
+    stroke(color: string, width?: number): this;
+    /**
+     * change the stroke width
+     * @param width
+     */
+    strokeWidth(width: number): this;
+    /**
+     * change the fill color
+     * @param color
+     */
+    fill(color: string): this;
+    /**
+     * define a new attribute
+     * @param name attibute name
+     * @param value attribute value
+     * @returns this
+     */
+    attr(name: string, value: string): this;
+    style(name: string, value: string | number): this;
+    /**
+     * add a class
+     * @param name class name to add
+     */
+    class(name: string): this;
+    /**
+     *
+     */
+    renderAttrs(): string;
+    /**
+     *
+     */
+    renderStyle(): string;
+    /**
+     *
+     */
+    renderContent(): string;
+    /**
+     *
+     */
+    clip(id: string): this;
+    /**
+     *
+     */
+    transform(tr: string): void;
+    /**
+     *
+     */
+    rotate(deg: number, cx: number, cy: number): void;
+    translate(dx: number, dy: number): void;
+    scale(x: number): void;
+}
+/**
+ *
+ */
+declare class SVGPath extends SVGItem {
+    private m_path;
+    constructor();
+    renderAttrs(): string;
+    /**
+     * move the current pos
+     * @param x new pos x
+     * @param y new pos y
+     * @returns this
+     */
+    moveTo(x: number, y: number): this;
+    /**
+     * draw aline to the given point
+     * @param x end x
+     * @param y end y
+     * @returns this
+     */
+    lineTo(x: number, y: number): this;
+    /**
+     * close the currentPath
+     */
+    closePath(): this;
+    /**
+     * draw an arc
+     * @param x center x
+     * @param y center y
+     * @param r radius
+     * @param start angle start in degrees
+     * @param end angle end in degrees
+     * @returns this
+     */
+    arc(x: number, y: number, r: number, start: number, end: number): this;
+}
+/**
+ *
+ */
+declare class SVGText extends SVGItem {
+    private m_text;
+    constructor(x: number, y: number, txt: string);
+    font(font: string): this;
+    fontSize(size: number | string): this;
+    fontWeight(weight: 'light' | 'normal' | 'bold'): this;
+    textAlign(align: 'left' | 'center' | 'right'): this;
+    verticalAlign(align: 'top' | 'center' | 'bottom'): this;
+    renderContent(): any;
+}
+/**
+ *
+ */
+declare class SVGShape extends SVGItem {
+    constructor(tag: string);
+}
+/**
+ *
+ */
+type number_or_perc = number | `${string}%`;
+declare class SVGGradient extends SVGItem {
+    private static g_id;
+    private m_id;
+    private m_stops;
+    constructor(x1: number_or_perc, y1: number_or_perc, x2: number_or_perc, y2: number_or_perc);
+    get id(): string;
+    addStop(offset: number_or_perc, color: string): this;
+    renderContent(): string;
+}
+/**
+ *
+ */
+declare class SVGGroup extends SVGItem {
+    protected m_items: SVGItem[];
+    constructor(tag?: string);
+    path(): SVGPath;
+    text(x: any, y: any, txt: any): SVGText;
+    ellipse(x: any, y: any, r1: any, r2?: any): SVGShape;
+    rect(x: any, y: any, w: any, h: any): SVGShape;
+    /**
+     *
+     * example
+     * ```ts
+     * const g = c.linear_gradient( '0%', '0%', '0%', '100%' )
+     * 				.addStop( 0, 'red' )
+     * 				.addStop( 100, 'green' );
+     *
+     * p.rect( 0, 0, 100, 100 )
+     * 		.stroke( g.id );
+     *
+     * ```
+     */
+    linear_gradient(x1: number_or_perc, y1: number_or_perc, x2: number_or_perc, y2: number_or_perc): SVGGradient;
+    /**
+     * clear
+     */
+    clear(): void;
+    renderContent(): string;
+}
+/**
+ *
+ */
+export declare class SVGPathBuilder extends SVGGroup {
+    private static g_clip_id;
+    constructor();
+    addClip(x: number, y: number, w: number, h: number): string;
+    render(): string;
+}
+/**
+ *
+ */
+export interface SVGProps extends CProps {
+    viewBox?: string;
+    path?: string;
+}
+export declare class SVGComponent<P extends SVGProps = SVGProps> extends Component<P> {
+    constructor(props: P);
+}
+export {};

package/lib/types/tabbar.d.ts

@@ -0,0 +1,58 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file tabbar.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, Container, ContainerEventMap, CProps, EventHandler } from './component';
+import { EvChange } from './x4events';
+import { IconID } from './icon.js';
+interface TabBarEventMap extends ContainerEventMap {
+    change: EvChange;
+}
+interface TabBarProps extends CProps<TabBarEventMap> {
+    pages?: ITabPage[];
+    default?: string;
+    vertical?: boolean;
+    change: EventHandler<EvChange>;
+}
+export interface ITabPage {
+    id: string;
+    title?: string;
+    icon?: IconID;
+    page: Component;
+}
+export declare class TabBar extends Container<TabBarProps, TabBarEventMap> {
+    private m_pages;
+    private m_curPage;
+    constructor(props: TabBarProps);
+    componentCreated(): void;
+    addPage(page: ITabPage): void;
+    render(): void;
+    select(id: string | null, notify?: boolean): boolean;
+    private _select;
+    get selection(): Component;
+}
+export {};

package/lib/types/tabview.d.ts

@@ -0,0 +1,49 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file tabview.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component } from './component';
+import { CardView, CardViewProps, ICardViewItem } from './cardview';
+import { MenuItem } from './menu';
+interface TabProps extends CardViewProps {
+    tab_selector?: boolean;
+    menu?: MenuItem;
+}
+/**
+ * Standard TabView class
+ */
+export declare class TabView extends CardView<TabProps> {
+    protected m_tab_selector: boolean;
+    protected m_menu: MenuItem;
+    constructor(props: TabProps);
+    /** @ignore */
+    render(): void;
+    protected _updateSelector(): void;
+    protected _prepareSelector(card: ICardViewItem): Component;
+    protected _preparePage(page: Component): void;
+}
+export {};

package/lib/types/textarea.d.ts

@@ -0,0 +1,77 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file textarea.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, CProps, CEventMap } from './component';
+import { EvChange, EventCallback } from './x4events';
+interface TextAreaEventMap extends CEventMap {
+    change: EvChange;
+}
+interface Selection {
+    start: number;
+    end: number;
+}
+export interface TextAreaProps extends CProps {
+    text?: string;
+    readOnly?: boolean;
+    tabIndex?: number;
+    placeHolder?: string;
+    name?: string;
+    rows?: number;
+    autoGrow?: boolean;
+    autoFocus?: boolean;
+    spellcheck?: boolean;
+    change?: EventCallback<EvChange>;
+}
+export declare class TextArea extends Component<TextAreaProps, TextAreaEventMap> {
+    constructor(props: TextAreaProps);
+    /** @ignore */
+    render(props: TextAreaProps): void;
+    private _change;
+    componentCreated(): void;
+    get value(): string;
+    set value(t: string);
+    get text(): string;
+    set text(text: string);
+    private _calcHeight;
+    private _updateHeight;
+    /**
+     * @deprected use appendText
+     * insert text at cursor position
+     */
+    insertText(text: any): void;
+    /**
+     * append the text
+     */
+    appendText(text: any): void;
+    replaceText(text: any): void;
+    getSelection(): Selection;
+    setSelection(sel: Selection): void;
+    getStoreValue(): any;
+    setStoreValue(value: any): void;
+}
+export {};

package/lib/types/textedit.d.ts

@@ -0,0 +1,123 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file textedit.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, EvFocus, HtmlString } from './component';
+import { Input, InputProps, InputEventMap, EditType } from './input';
+import { IconID } from './icon';
+import { EvClick, EvChange, EventCallback } from './x4events';
+type ValidationFunction = (value: string) => string;
+interface TextEditEventMap extends InputEventMap {
+    click: EvClick;
+    change: EvChange;
+    focus: EvFocus;
+}
+export interface TextEditProps extends InputProps<TextEditEventMap> {
+    label?: string | HtmlString;
+    labelWidth?: number;
+    labelAlign?: 'left' | 'right' | 'top';
+    required?: boolean;
+    spellcheck?: boolean;
+    icon?: IconID;
+    pattern?: string;
+    uppercase?: boolean;
+    format?: string | 'native';
+    autosel?: boolean;
+    gadgets?: Component[];
+    validator?: ValidationFunction;
+    change?: EventCallback<EvChange>;
+    click?: EventCallback<EvClick>;
+    focus?: EventCallback<EvFocus>;
+}
+/**
+ * TextEdit is a single line editor, it can have a label and an error descriptor.
+ */
+export declare class TextEdit<T extends TextEditProps = TextEditProps, E extends TextEditEventMap = TextEditEventMap> extends Component<T, E> {
+    private m_cal_popup;
+    protected m_ui_input: Input;
+    private m_error_tip;
+    constructor(props: T);
+    componentCreated(): void;
+    componentDisposed(): void;
+    focus(): void;
+    /** @ignore */
+    render(props: TextEditProps): void;
+    enable(ena?: boolean): void;
+    disable(): void;
+    private _btnClick;
+    /**
+     * select the value format for input/output on textedit of type date
+     * cf. formatIntlDate / parseIntlDate
+     * @param fmt
+     */
+    setDateStoreFormat(fmt: string): void;
+    setStoreValue(value: any): void;
+    getStoreValue(): any;
+    private _date_get_hook;
+    private _date_set_hook;
+    showError(text: string): void;
+    clearError(): void;
+    get value(): string;
+    set value(value: string);
+    /**
+     * select all the text
+     */
+    selectAll(): void;
+    select(start: number, length?: number): void;
+    getSelection(): {
+        start: number;
+        length: number;
+    };
+    set readOnly(ro: boolean);
+    get label(): string | HtmlString;
+    set label(text: string | HtmlString);
+    /**
+     * content changed
+     * todo: should move into Input
+     */
+    private _change;
+    /**
+     * getting focus
+     */
+    private _focus;
+    /**
+     * loosing focus
+     * @param value
+     */
+    private _blur;
+    /**
+     * todo: should move into Input
+     * @returns
+     */
+    validate(): boolean;
+    protected _validate(value: string): boolean;
+    _date_validator(value: string): string;
+    private _showDatePicker;
+    get input(): Input;
+    get type(): EditType;
+}
+export {};

package/lib/types/toaster.d.ts

@@ -0,0 +1,42 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file toaster.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { IconID } from './icon';
+import { Popup, PopupProps } from './popup';
+export interface ToasterProps extends PopupProps {
+    message: string;
+    icon?: IconID;
+}
+export declare class Toaster extends Popup<ToasterProps> {
+    private m_message;
+    private m_icon;
+    constructor(props: ToasterProps);
+    /** @ignore */
+    render(): void;
+    show(): void;
+}