@jupyter/web-components
Version:
A component library for building extensions in Jupyter frontends.
143 lines (142 loc) • 6.52 kB
TypeScript
import { FoundationElementDefinition, PickerMenu, Picker, PickerList, PickerListItem, PickerMenuOption } from '@microsoft/fast-foundation';
import { pickerStyles } from './picker.styles.js';
import { pickerMenuStyles } from './picker-menu.styles.js';
import { pickerMenuOptionStyles } from './picker-menu-option.styles.js';
import { pickerListItemStyles } from './picker-list-item.styles.js';
/**
* Picker class
* @alpha
* @public
* @tagname jp-draft-picker
*/
declare class JupyterPicker extends Picker {
}
/**
* The FAST Picker Custom Element. Implements {@link @microsoft/fast-foundation#Picker},
* {@link @microsoft/fast-foundation#PickerTemplate}
*
*
* @alpha
* @remarks
* * Generates HTML Element: `<jp-draft-picker>`
*/
export declare const jpPicker: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof Picker;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<Picker, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
shadowOptions: {};
}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
baseName: string;
baseClass: typeof Picker;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<Picker, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
shadowOptions: {};
}, typeof JupyterPicker>;
/**
* Picker menu class
*
* @alpha
* @public
* @tagname jp-draft-picker-menu
*/
declare class JupyterPickerMenu extends PickerMenu {
/**
* @public
*/
connectedCallback(): void;
}
/**
* Component that displays the list of available picker options
*
*
* @alpha
* @remarks
* HTML Element: \<jp-draft-picker-menu\>
*/
export declare const jpPickerMenu: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<FoundationElementDefinition> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<FoundationElementDefinition, import("@microsoft/fast-element").Constructable<import("@microsoft/fast-foundation").FoundationElement>>;
/**
* Picker menu options class
*
* @alpha
* @public
* @tagname jp-draft-picker-menu-option
*/
declare class JupyterPickerMenuOption extends PickerMenuOption {
}
/**
* Component that displays available picker menu options
*
*
* @alpha
* @remarks
* HTML Element: \<jp-draft-picker-menu-option\>
*/
export declare const jpPickerMenuOption: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof PickerMenuOption;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<PickerMenuOption, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
baseName: string;
baseClass: typeof PickerMenuOption;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<PickerMenuOption, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
}, typeof JupyterPickerMenuOption>;
/**
* Picker list class
*
* @alpha
* @public
* @tagname jp-draft-picker-list
*/
declare class JupyterPickerList extends PickerList {
}
/**
* Component that displays the list of selected picker items along
* with the input combobox
*
* @alpha
* @remarks
* HTML Element: \<jp-draft-picker-list\>
*
*/
export declare const jpPickerList: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof PickerList;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<PickerList, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
baseName: string;
baseClass: typeof PickerList;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<PickerList, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
}, typeof JupyterPickerList>;
/**
* Picker list item class
*
* @alpha
* @public
* @tagname jp-draft-picker-list-item
*/
declare class JupyterPickerListItem extends PickerListItem {
}
/**
* Component that displays selected items
*
* @alpha
* @remarks
* HTML Element: \<jp-draft-picker-list-item\>
*/
export declare const jpPickerListItem: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
baseName: string;
baseClass: typeof PickerListItem;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<PickerListItem, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
}> | undefined) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
baseName: string;
baseClass: typeof PickerListItem;
template: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ViewTemplate<PickerListItem, any>, FoundationElementDefinition>;
styles: import("@microsoft/fast-foundation").FoundationElementTemplate<import("@microsoft/fast-element").ElementStyles>;
}, typeof JupyterPickerListItem>;
export { JupyterPicker as Picker, JupyterPickerMenu as PickerMenu, JupyterPickerMenuOption as PickerMenuOption, JupyterPickerList as PickerList, JupyterPickerListItem as PickerListItem, pickerStyles, pickerListItemStyles, pickerMenuOptionStyles, pickerMenuStyles };