@jupyter/web-components
Version:
A component library for building extensions in Jupyter frontends.
56 lines (55 loc) • 2.28 kB
TypeScript
import { Search } from '@microsoft/fast-foundation';
import { searchStyles as styles } from './search.styles.js';
/**
* Search appearances
* @public
*/
export type SearchAppearance = 'filled' | 'outline';
/**
* Search field class
*
* @public
* @tagname jp-search
*
* @fires input - Fires a custom 'input' event when the value has changed
* @fires change - Fires a custom 'change' event when the value has changed
*/
declare class JupyterSearch extends Search {
/**
* The appearance of the element.
*
* @public
* @remarks
* HTML Attribute: appearance
*/
appearance: SearchAppearance;
}
/**
* A function that returns a {@link @microsoft/fast-foundation#Search} registration for configuring the component with a DesignSystem.
* Implements {@link @microsoft/fast-foundation#searchTemplate}
*
*
* @public
* @remarks
* Generates HTML Element: `<jp-search>`
*
* {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}
*/
export declare const jpSearch: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof Search;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<Search, any>, import("@microsoft/fast-foundation").SearchOptions>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles, import("@microsoft/fast-foundation").TextFieldOptions>;
shadowOptions: {
delegatesFocus: true;
};
}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
baseName: string;
baseClass: typeof Search;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<Search, any>, import("@microsoft/fast-foundation").SearchOptions>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles, import("@microsoft/fast-foundation").TextFieldOptions>;
shadowOptions: {
delegatesFocus: true;
};
}, typeof JupyterSearch>;
export { JupyterSearch as Search, styles as searchStyles };