@api-client/ui 0.0.9 → 0.0.11

package/dist/elements/layout/LayoutManager.d.ts

@@ -1,327 +0,0 @@
-import { TemplateResult } from 'lit';
-import LayoutPanelElement from './LayoutPanelElement.js';
-import '../../define/layout/layout-panel.js';
-import { IconType } from '../../ui/icons/Icons.js';
-export type Direction = 'horizontal' | 'vertical';
-export type DropRegion = 'center' | 'east' | 'west' | 'north' | 'south';
-declare enum PanelState {
-    Idle = 0,
-    Busy = 1
-}
-export interface ILayoutItem {
-    /**
-     * The kind of opened item
-     */
-    kind: string;
-    /**
-     * The key of the opened item
-     */
-    key: string;
-    /**
-     * Optional parent information that helps locating this object.
-     */
-    parent?: string;
-    /**
-     * The label to render in the tab.
-     */
-    label: string;
-    /**
-     * Whether the tab is pinned (cannot be closed or moved).
-     */
-    pinned?: boolean;
-    /**
-     * The tab index.
-     */
-    index?: number;
-    /**
-     * The icon defined in the internal library to render with the tab.
-     */
-    icon?: IconType;
-    /**
-     * A tab that is always present in the layout. The user can't close this tab.
-     */
-    persistent?: boolean;
-    /**
-     * A property to be used by the screen to indicate the property is being loaded
-     * (from a data store, file, etc).
-     */
-    loading?: boolean;
-    /**
-     * Indicates the item has been changed and is out of sync with the data store.
-     */
-    isDirty?: boolean;
-}
-export interface ILayoutOptions {
-    /**
-     * The list of DataTransfer types to test against when handling drag and drop.
-     * When set it checks whether all types are set on the dragged item.
-     * If not set all items are allowed.
-     */
-    dragTypes?: string[];
-    /**
-     * The local store key to use with `autoStore`,
-     */
-    storeKey?: string;
-    /**
-     * Uses application's internal events system to store the layout data
-     * in the local store, when anything change.
-     * This must be set with the `storeKey` property.
-     *
-     * When this is set it also restores the state during initialization.
-     */
-    autoStore?: boolean;
-    /**
-     * When set it adds the `overflow` hidden on the container that holds the tab contents.
-     */
-    constrain?: boolean;
-}
-export interface IPanelSplitOptions {
-    layout?: Direction;
-    itemsTarget?: 0 | 1;
-}
-export type ItemRenderCallback = (item: ILayoutItem, visible: boolean) => TemplateResult;
-export interface ILayoutPanelState {
-    id: number;
-    layout: Direction;
-    panels?: ILayoutPanelState[];
-    items?: ILayoutItem[];
-    selected?: string;
-}
-export interface ILayoutState {
-    panels: ILayoutPanelState[];
-}
-export interface ILayoutItemAddOptions {
-    /**
-     * The region to add the item.
-     * When other than `center` it splits the panel.
-     */
-    region?: DropRegion;
-    /**
-     * The index at which to put the item.
-     * By default it is added as a last item.
-     */
-    index?: number;
-}
-export declare class LayoutPanel {
-    id: number;
-    parent?: LayoutPanel;
-    manager: LayoutManager;
-    layout: Direction;
-    panels: LayoutPanel[];
-    items: ILayoutItem[];
-    /**
-     * The current state of the panel.
-     */
-    state: PanelState;
-    /**
-     * The item being rendered in the panel.
-     */
-    selected?: string;
-    /**
-     * The computed size value for each item.
-     * The value of `undefined` means "auto".
-     */
-    sizes: string[];
-    get hasPanels(): boolean;
-    get hasItems(): boolean;
-    static fromSchema(state: ILayoutPanelState, manager: LayoutManager, parent?: LayoutPanel): LayoutPanel;
-    constructor(manager: LayoutManager, parent?: LayoutPanel);
-    /**
-     * @returns Returns a **copy** of the items array sorted by index.
-     */
-    sortedItems(): ILayoutItem[];
-    /**
-     * @returns True when the panel accepts drop events.
-     */
-    canDrop(): boolean;
-    nextIndex(): number;
-    /**
-     * Adds an item to the layout.
-     *
-     * @param item The item to add
-     * @param opts Layout adding item options
-     * @returns Whether a new item was added to the layout. false when the item is already in the layout panel.
-     */
-    addItem(item: ILayoutItem, opts?: ILayoutItemAddOptions): boolean;
-    /**
-     * Splits this panel into 2 panels.
-     * This to be used when the panel has no other panels. Only items are allowed.
-     * It produces 2 new panels and moves the items to the first one leaving the other one available.
-     */
-    split(opts?: IPanelSplitOptions): LayoutPanel[];
-    unsplit(): void;
-    /**
-     * Decreases items index by 1 to all items with index at least equal to `fromIndex`.
-     * @param fromIndex The minimal index to affect.
-     */
-    decreaseIndex(fromIndex: number): void;
-    /**
-     * Increases items index by 1 to all items with index at least equal to `fromIndex`.
-     * @param fromIndex The minimal index to affect.
-     */
-    increaseIndex(fromIndex: number): void;
-    /**
-     * Removes an item from the layout
-     * @param key The key of the item.
-     * @returns The removed item, if any.
-     */
-    removeItem(key: string): ILayoutItem | undefined;
-    /**
-     * @param key The key of the item to perform a relative operation from.
-     * @param dir The direction to which close other items. Default to both directions leaving only the `key` item
-     */
-    relativeClose(key: string, dir?: 'left' | 'right' | 'both'): void;
-    removePanel(id: number): void;
-    /**
-     * Moves an item to a new index.
-     *
-     * @param key The item key
-     * @param toIndex The new index. When not set it moves the item to the end.
-     */
-    moveItem(key: string, toIndex?: number): void;
-    rename(key: string, label: string): void;
-    toJSON(): ILayoutPanelState;
-    panelTemplate(panel: LayoutPanel, itemCallback: ItemRenderCallback): TemplateResult | undefined;
-    itemTemplate(item: ILayoutItem, visible: boolean, itemCallback: ItemRenderCallback): TemplateResult;
-    render(itemCallback: ItemRenderCallback): TemplateResult | undefined;
-}
-/**
- * Layout manager for API Client apps.
- *
- * Supports:
- * - layout splitting depending on the selected region (east, west, north, south)
- * - drag and drop of items into the layout
- * - auto storing and restoring layout state from the application local storage.
- * - adding items to the last focused panel
- *
- * Limitations
- * - the rendered content has to be focusable (tabindex must be set) in order to detect active panel
- */
-export declare class LayoutManager extends EventTarget {
-    opts: ILayoutOptions;
-    panels: LayoutPanel[];
-    protected isDirty: boolean;
-    protected storing: boolean;
-    private _activePanel?;
-    /**
-     * An active panel
-     */
-    get activePanel(): LayoutPanel | undefined;
-    constructor(opts?: ILayoutOptions);
-    /**
-     * @param itemCallback The callback called when rendering an item in layout view.
-     * @returns The template for the page layout.
-     */
-    render(itemCallback: ItemRenderCallback): TemplateResult[];
-    /**
-     * Initializes the manager.
-     *
-     * @param restore Previously stored layout state, if any.
-     */
-    initialize(restore?: ILayoutState): Promise<void>;
-    protected restore(restore: ILayoutState): void;
-    /**
-     * Informs the screen that something has changed
-     */
-    changed(): void;
-    /**
-     * Dispatches the `nameitem` event.
-     * The detail object has the item to be added to the items.
-     * The event handler can manipulate properties of the item, except for the index which will be set by the manager.
-     *
-     * @param item The item to notify.
-     */
-    nameItem(item: ILayoutItem): void;
-    /**
-     * Serializes the layout state to a JSON safe object.
-     * This is automatically called when passing this object to `JSON.stringify()`.
-     */
-    toJSON(): ILayoutState;
-    protected autoStore(): void;
-    protected storeLayout(key: string): Promise<void>;
-    protected restoreLayout(key: string): Promise<void>;
-    protected _focusInHandler(e: Event): void;
-    protected findLayout(e: Event, last?: boolean): LayoutPanelElement | undefined;
-    /**
-     * Finds a panel by id.
-     *
-     * @param id The id of the panel.
-     * @param parent THe parent panel to start searching from
-     * @returns The panel if found
-     */
-    findPanel(id: number, parent?: LayoutPanel): LayoutPanel | undefined;
-    /**
-     * Finds a first panel that can accept items.
-     * This will be a panel that has no other panels.
-     */
-    findFirstItemsPanel(parent?: LayoutPanel): LayoutPanel | undefined;
-    /**
-     * Finds a panel for the item.
-     * @param key the key of the item to find.
-     */
-    findItemPanel(key: string, parent?: LayoutPanel): LayoutPanel | undefined;
-    /**
-     * Finds a layout item.
-     * @param key the key of the item to find.
-     */
-    findItem(key: string, parent?: LayoutPanel): ILayoutItem | undefined;
-    parentItemIterator(key: string, parent?: LayoutPanel): Generator<ILayoutItem>;
-    /**
-     * Adds an item to the active panel.
-     *
-     * @param item The item to add.
-     */
-    addItem(item: ILayoutItem): void;
-    /**
-     * Removes an item from layout.
-     * @param key The key of the item to remove.
-     */
-    removeItem(key: string): void;
-    /**
-     * @param key The key of the item to perform a relative operation from.
-     * @param dir The direction to which close other items. Default to both directions leaving only the `key` item
-     */
-    relativeClose(key: string, dir?: 'left' | 'right' | 'both'): void;
-    /**
-     * Requests an update on a layout.
-     *
-     * @param id The id of the panel. When not set it uses the active panel
-     */
-    forceUpdateLayout(id?: number): void;
-    /**
-     * Moves a tab between panels or inside a panel
-     *
-     * @param fromPanel The id of the source panel of the item
-     * @param toPanel The id of the target panel of the item
-     * @param key The key of the item
-     * @param toIndex The index to which add the item. Default as the last.
-     */
-    moveTab(fromPanel: number, toPanel: number, key: string, toIndex?: number): void;
-    /**
-     * Finds the item's panel and renames the item.
-     *
-     * @param key The item's key
-     * @param label The new label
-     */
-    rename(key: string, label: string): void;
-    /**
-     * Requests to dispatch the `nameitem` event so the application can update the name of the tab.
-     *
-     * @param key The key of the item.
-     */
-    requestNameUpdate(key: string): void;
-    /**
-     * Requests to dispatch the `nameitem` event so the application can update the name of a tab
-     * that has a parent.
-     *
-     * @param parent The key of the parent.
-     */
-    parentNameUpdate(parent: string): void;
-    /**
-     * Finds all items in all panels that have specified parent.
-     * @param key The key of the parent to search for.
-     */
-    removeByParent(key: string): void;
-}
-export {};
-//# sourceMappingURL=LayoutManager.d.ts.map

package/dist/elements/layout/LayoutManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LayoutManager.d.ts","sourceRoot":"","sources":["../../../src/elements/layout/LayoutManager.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAQ,MAAM,KAAK,CAAC;AAG3C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAEnD,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,UAAU,CAAC;AAClD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAExE,aAAK,UAAU;IACd,IAAI,IAAA;IACJ,IAAI,IAAA;CACJ;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,WAAW,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;CACrB;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,KAAK,cAAc,CAAC;AAEzF,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,CAAC;IAClB,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,iBAAiB,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAID,qBAAa,WAAW;IACtB,EAAE,SAAa;IAEf,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB,OAAO,EAAE,aAAa,CAAA;IAEtB,MAAM,EAAE,SAAS,CAAgB;IAEjC,MAAM,EAAE,WAAW,EAAE,CAAM;IAE3B,KAAK,EAAE,WAAW,EAAE,CAAM;IAE1B;;OAEG;IACH,KAAK,EAAE,UAAU,CAAmB;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,KAAK,EAAE,MAAM,EAAE,CAAM;IAErB,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW;gBAc1F,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,WAAW;IAMxD;;OAEG;IACH,WAAW,IAAI,WAAW,EAAE;IAK5B;;OAEG;IACH,OAAO,IAAI,OAAO;IAOlB,SAAS,IAAI,MAAM;IAcnB;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,GAAE,qBAA0B,GAAG,OAAO;IAiDrE;;;;OAIG;IACH,KAAK,CAAC,IAAI,GAAE,kBAAuB,GAAG,WAAW,EAAE;IAkBnD,OAAO,IAAI,IAAI;IAQf;;;OAGG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAStC;;;OAGG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAStC;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAmChD;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,GAAE,MAAM,GAAG,OAAO,GAAG,MAAe,GAAG,IAAI;IAoBzE,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAa7B;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAyB7C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAUxC,MAAM,IAAI,iBAAiB;IAiB3B,aAAa,CAAC,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,kBAAkB,GAAG,cAAc,GAAG,SAAS;IA2B/F,YAAY,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,kBAAkB,GAAG,cAAc;IAInG,MAAM,CAAC,YAAY,EAAE,kBAAkB,GAAG,cAAc,GAAG,SAAS;CAGrE;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C,IAAI,EAAE,cAAc,CAAC;IAErB,MAAM,EAAE,WAAW,EAAE,CAAM;IAE3B,SAAS,CAAC,OAAO,UAAS;IAE1B,SAAS,CAAC,OAAO,UAAS;IAE1B,OAAO,CAAC,YAAY,CAAC,CAAc;IAEnC;;OAEG;IACH,IAAI,WAAW,IAAI,WAAW,GAAG,SAAS,CAKzC;gBAEW,IAAI,GAAE,cAAmB;IAKrC;;;OAGG;IACH,MAAM,CAAC,YAAY,EAAE,kBAAkB,GAAG,cAAc,EAAE;IAY1D;;;;OAIG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvD,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAM9C;;OAEG;IACH,OAAO,IAAI,IAAI;IAKf;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAMjC;;;OAGG;IACH,MAAM,IAAI,YAAY;IAOtB,SAAS,CAAC,SAAS,IAAI,IAAI;cAQX,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAiBvC,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWzD,SAAS,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAYzC,SAAS,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,UAAK,GAAG,kBAAkB,GAAG,SAAS;IAiBzE;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS;IAgBpE;;;OAGG;IACH,mBAAmB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS;IAgBlE;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS;IAmBzE;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS;IAmBlE,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;IAe/E;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAShC;;;OAGG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAO7B;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,GAAE,MAAM,GAAG,OAAO,GAAG,MAAe,GAAG,IAAI;IAOzE;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAkBpC;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAsBhF;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IASxC;;;;OAIG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAepC;;;;;OAKG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAatC;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAKlC"}