gd-sprest-bs/src/webparts/listFields/types.d.ts

SharePoint JavaScript, TypeScript and Web Components designed using the Bootstrap framework.

import { IWPList, IWPListCfg, IWPListEditForm, IWPListInfo, IWPListProps } from "../list/types";

/**
 * ### List Fields WebPart
 * 
 * The list fields webpart should be used when targeting a list and fields as a datasource.
 * 
 * ```ts
 * import { WebParts } from "gd-sprest-bs";
 * 
 * // Create the webpart
 * WebParts.WebPart({
 *     elementId: "my-wpList",
 *     cfgElementId: "my-wpList-cfg",
 *     onRenderItems: (wpInfo, items) => {
 *         // Render the display element
 *         wpInfo.el.innerHTML = [
 *             '<h1>List: ' + wpInfo.ListName + '</h1>',
 *             '<h5>List Items: ' + items.length + '</h5>'
 *         ].join('\n');
 *     }
 * });
 * ```
 */
export const WPListFields: (props: IWPListFieldsProps) => IWPListFields;

/**
 * List Fields WebPart Edit Form
 */
export const WPListFieldsEditForm: (props: IWPListFieldsEditForm) => IWPListFieldsEditForm;

/**
 * List Fields WebPart
 */
export interface IWPListFields<IListFieldsCfg = IWPListFieldsCfg, IListFieldsInfo = IWPListFieldsInfo> extends IWPList<IListFieldsCfg, IListFieldsInfo> { }

/**
 * List Fields WebPart Information
 */
export interface IWPListFieldsInfo<IListFieldsCfg = IWPListFieldsCfg> extends IWPListInfo<IListFieldsCfg> { }

/**
 * List Fields WebPart Properties
 */
export interface IWPListFieldsProps<IListFieldsInfo = IWPListFieldsInfo, IListFieldsEditForm = IWPListFieldsEditForm> extends IWPListProps<IListFieldsInfo, IListFieldsEditForm> { }

/**
 * WebPart Configuration List Field
 */
export interface IWPListField {
    // The internal field name
    Name: string;

    // The display name of the field
    Title: string
}

/**
 * List Fields WebPart Configuration
 */
export interface IWPListFieldsCfg extends IWPListCfg {
    /** The selected fields */
    Fields: Array<IWPListField>;
}

/**
 * List Fields WebPart Edit Form
 */
export interface IWPListFieldsEditForm<IListFieldsCfg = IWPListFieldsCfg, IListFieldsInfo = IWPListFieldsInfo> extends IWPListEditForm<IListFieldsCfg, IListFieldsInfo> { }