apisearch-ui/src/widgets/Widget.ts

Javascript User Interface of Apisearch.

import {Repository} from "apisearch";
import Store from "../Store";

/**
 * Widget
 */
export default abstract class Widget {

    protected target;
    protected component: any;
    protected config: any;

    public withConfig(config: any) {
        if ("withConfig" in this.component) {
            this.component.withConfig(config);
        }
    }

    /**
     * @param environmentId
     * @param store
     * @param repository
     * @param dictionary
     */
    public abstract render(
        environmentId: string,
        store: Store,
        repository: Repository,
        dictionary: { [key: string]: string; },
    );

    /**
     * @param query
     * @param object
     */
    public toUrlObject(
        query: any,
        object: any,
    ) {

    }

    /**
     * @param object
     * @param query
     */
    public fromUrlObject(
        object: any,
        query: any,
    ) {

    }

    /**
     * @param query
     */
    public reset(query: any) {
    }

    /**
     * @param environmentId
     * @param query
     */
    public normalizeQuery(
        environmentId: string,
        query: any,
    ) {

    }

    /**
     * @param environmentId
     * @param store
     * @param repository
     */
    public initialSetup(
        environmentId: string,
        store: Store,
        repository: Repository,
    ) {

    }
}