@jupyter/web-components
Version:
A component library for building extensions in Jupyter frontends.
57 lines (56 loc) • 2.29 kB
TypeScript
import { ElementStyles } from '@microsoft/fast-element';
import { ListboxElement } from '@microsoft/fast-foundation';
import { listboxStyles as styles } from './listbox.styles.js';
/**
* Listbox class
*
* @public
* @tagname jp-listbox
*
* @fires change - Fires a custom 'change' event when the value has changed
*/
declare class JupyterListbox extends ListboxElement {
/**
* An internal stylesheet to hold calculated CSS custom properties.
*
* @internal
*/
private computedStylesheet?;
/**
* Updates the component dimensions when the size property is changed.
*
* @param prev - the previous size value
* @param next - the current size value
*
* @internal
*/
protected sizeChanged(prev: number | undefined, next: number): void;
/**
* Updates an internal stylesheet with calculated CSS custom properties.
*
* @internal
*/
protected updateComputedStylesheet(): void;
}
/**
* A function that returns a {@link @microsoft/fast-foundation#ListboxElement} registration for configuring the component with a DesignSystem.
* Implements {@link @microsoft/fast-foundation#listboxTemplate}
*
* @remarks
* Generates HTML Element: `<jp-listbox>`
*
* @public
*
*/
export declare const jpListbox: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof ListboxElement;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<ListboxElement, any>, import("@microsoft/fast-foundation").FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<ElementStyles>;
}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
baseName: string;
baseClass: typeof ListboxElement;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<ListboxElement, any>, import("@microsoft/fast-foundation").FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<ElementStyles>;
}, typeof JupyterListbox>;
export { JupyterListbox as Listbox, styles as listboxStyles };