converse.js
Version:
Browser based XMPP chat client
75 lines • 2.6 kB
TypeScript
/**
* Given an HTMLElement representing a form field, return it's name and value.
* @param {HTMLInputElement|HTMLSelectElement} field
* @returns {{[key:string]:string|number|string[]}|null}
*/
export function getNameAndValue(field: HTMLInputElement | HTMLSelectElement): {
[key: string]: string | number | string[];
} | null;
/**
* @param {string} url
*/
export function getFileName(url: string): string;
/**
* Has an element a class?
* @param {string} className
* @param {Element} el
*/
export function hasClass(className: string, el: Element): boolean;
/**
* Add a class to an element.
* @param {string} className
* @param {Element} el
*/
export function addClass(className: string, el: Element): Element;
/**
* Remove a class from an element.
* @param {string} className
* @param {Element} el
*/
export function removeClass(className: string, el: Element): Element;
/**
* Remove an element from its parent
* @param {Element} el
*/
export function removeElement(el: Element): Element;
/**
* @param {HTMLElement} el
* @param {String} selector
*/
export function ancestor(el: HTMLElement, selector: string): HTMLElement;
/**
* @param {string} url
* @returns {TemplateResult|string}
*/
export function getHyperlinkTemplate(url: string): TemplateResult | string;
/**
* Shows/expands an element by sliding it out of itself
* @param {HTMLElement} el - The HTML string
* @param {Number} duration - The duration amount in milliseconds
*/
export function slideOut(el: HTMLElement, duration?: number): Promise<any>;
/**
* Hides/contracts an element by sliding it into itself
* @param {HTMLElement} el - The HTML string
* @param {Number} duration - The duration amount in milliseconds
*/
export function slideIn(el: HTMLElement, duration?: number): Promise<any>;
/**
* Takes an XML field in XMPP XForm (XEP-004: Data Forms) format returns a
* [TemplateResult](https://lit.polymer-project.org/api/classes/_lit_html_.templateresult.html).
* @param {import('@converse/headless/shared/types').XFormField} xfield - the field to convert
* @param {Object} options
* @returns {TemplateResult}
*/
export function xFormField2TemplateResult(xfield: import("@converse/headless/shared/types").XFormField, options?: any): TemplateResult;
/**
* @param {HTMLElement} el
* @param {boolean} include_margin
*/
export function getOuterWidth(el: HTMLElement, include_margin?: boolean): number;
export function getRootElement(): any;
export default u;
export type TemplateResult = import("lit").TemplateResult;
import { u } from '@converse/headless';
//# sourceMappingURL=html.d.ts.map