@jupyter/web-components
Version:
A component library for building extensions in Jupyter frontends.
55 lines (54 loc) • 2.29 kB
TypeScript
import { TextField } from '@microsoft/fast-foundation';
import { textFieldStyles as styles } from './text-field.styles.js';
/**
* Text field appearances
* @public
*/
export type TextFieldAppearance = 'filled' | 'outline';
/**
* Text field class
*
* @public
* @tagname jp-text-field
*
* @fires select - Emits a custom 'select' event when the textarea emits a select event
*/
declare class JupyterTextField extends TextField {
/**
* The appearance of the element.
*
* @public
* @remarks
* HTML Attribute: appearance
*/
appearance: TextFieldAppearance;
}
/**
* A function that returns a {@link @microsoft/fast-foundation#TextField} registration for configuring the component with a DesignSystem.
* Implements {@link @microsoft/fast-foundation#textFieldTemplate}
*
*
* @public
* @remarks
* Generates HTML Element: `<jp-text-field>`
*
* {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}
*/
export declare const jpTextField: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof TextField;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<TextField, any>, import("@microsoft/fast-foundation").TextFieldOptions>;
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 TextField;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<TextField, any>, import("@microsoft/fast-foundation").TextFieldOptions>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles, import("@microsoft/fast-foundation").TextFieldOptions>;
shadowOptions: {
delegatesFocus: true;
};
}, typeof JupyterTextField>;
export { JupyterTextField as TextField, styles as textFieldStyles };