@jupyterlab/ui-components

  • Version 3.5.1
  • Published
  • 299 kB
  • 15 dependencies
  • BSD-3-Clause license

Install

npm i @jupyterlab/ui-components
yarn add @jupyterlab/ui-components
pnpm add @jupyterlab/ui-components

Overview

ui-components

Index

Variables

Functions

Classes

Interfaces

Namespaces

Variables

variable addAboveIcon

const addAboveIcon: LabIcon;

    variable addBelowIcon

    const addBelowIcon: LabIcon;

      variable addIcon

      const addIcon: LabIcon;

        variable badIcon

        const badIcon: LabIcon;

          variable blankIcon

          const blankIcon: LabIcon;

            variable bugDotIcon

            const bugDotIcon: LabIcon;

              variable bugIcon

              const bugIcon: LabIcon;

                variable buildIcon

                const buildIcon: LabIcon;

                  variable caretDownEmptyIcon

                  const caretDownEmptyIcon: LabIcon;

                    variable caretDownEmptyThinIcon

                    const caretDownEmptyThinIcon: LabIcon;

                      variable caretDownIcon

                      const caretDownIcon: LabIcon;

                        variable caretLeftIcon

                        const caretLeftIcon: LabIcon;

                          variable caretRightIcon

                          const caretRightIcon: LabIcon;

                            variable caretUpEmptyThinIcon

                            const caretUpEmptyThinIcon: LabIcon;

                              variable caretUpIcon

                              const caretUpIcon: LabIcon;

                                variable caseSensitiveIcon

                                const caseSensitiveIcon: LabIcon;

                                  variable checkIcon

                                  const checkIcon: LabIcon;

                                    variable circleEmptyIcon

                                    const circleEmptyIcon: LabIcon;

                                      variable circleIcon

                                      const circleIcon: LabIcon;

                                        variable clearIcon

                                        const clearIcon: LabIcon;

                                          variable closeIcon

                                          const closeIcon: LabIcon;

                                            variable codeIcon

                                            const codeIcon: LabIcon;

                                              variable consoleIcon

                                              const consoleIcon: LabIcon;

                                                variable copyIcon

                                                const copyIcon: LabIcon;

                                                  variable copyrightIcon

                                                  const copyrightIcon: LabIcon;

                                                    variable cutIcon

                                                    const cutIcon: LabIcon;

                                                      variable DEFAULT_STYLE_CLASS

                                                      const DEFAULT_STYLE_CLASS: string;

                                                        variable deleteIcon

                                                        const deleteIcon: LabIcon;

                                                          variable downloadIcon

                                                          const downloadIcon: LabIcon;

                                                            variable duplicateIcon

                                                            const duplicateIcon: LabIcon;

                                                              variable editIcon

                                                              const editIcon: LabIcon;

                                                                variable ellipsesIcon

                                                                const ellipsesIcon: LabIcon;

                                                                  variable extensionIcon

                                                                  const extensionIcon: LabIcon;

                                                                    variable fastForwardIcon

                                                                    const fastForwardIcon: LabIcon;

                                                                      variable fileIcon

                                                                      const fileIcon: LabIcon;

                                                                        variable fileUploadIcon

                                                                        const fileUploadIcon: LabIcon;

                                                                          variable filterListIcon

                                                                          const filterListIcon: LabIcon;

                                                                            variable folderFavoriteIcon

                                                                            const folderFavoriteIcon: LabIcon;

                                                                              variable folderIcon

                                                                              const folderIcon: LabIcon;

                                                                                variable homeIcon

                                                                                const homeIcon: LabIcon;

                                                                                  variable HTML_SELECT_CLASS

                                                                                  const HTML_SELECT_CLASS: string;

                                                                                    variable html5Icon

                                                                                    const html5Icon: LabIcon;

                                                                                      variable IFormComponentRegistry

                                                                                      const IFormComponentRegistry: Token<IFormComponentRegistry>;

                                                                                        variable ILabIconManager

                                                                                        const ILabIconManager: Token<ILabIconManager>;
                                                                                        • The ILabIconManager token.

                                                                                        variable imageIcon

                                                                                        const imageIcon: LabIcon;

                                                                                          variable inspectorIcon

                                                                                          const inspectorIcon: LabIcon;

                                                                                            variable jsonIcon

                                                                                            const jsonIcon: LabIcon;

                                                                                              variable juliaIcon

                                                                                              const juliaIcon: LabIcon;

                                                                                                variable jupyterFaviconIcon

                                                                                                const jupyterFaviconIcon: LabIcon;

                                                                                                  variable jupyterIcon

                                                                                                  const jupyterIcon: LabIcon;

                                                                                                    variable jupyterlabWordmarkIcon

                                                                                                    const jupyterlabWordmarkIcon: LabIcon;

                                                                                                      variable kernelIcon

                                                                                                      const kernelIcon: LabIcon;

                                                                                                        variable keyboardIcon

                                                                                                        const keyboardIcon: LabIcon;

                                                                                                          variable launcherIcon

                                                                                                          const launcherIcon: LabIcon;

                                                                                                            variable launchIcon

                                                                                                            const launchIcon: LabIcon;

                                                                                                              variable lineFormIcon

                                                                                                              const lineFormIcon: LabIcon;

                                                                                                                variable linkIcon

                                                                                                                const linkIcon: LabIcon;

                                                                                                                  variable listIcon

                                                                                                                  const listIcon: LabIcon;

                                                                                                                    variable listingsInfoIcon

                                                                                                                    const listingsInfoIcon: LabIcon;

                                                                                                                      variable markdownIcon

                                                                                                                      const markdownIcon: LabIcon;

                                                                                                                        variable moveDownIcon

                                                                                                                        const moveDownIcon: LabIcon;

                                                                                                                          variable moveUpIcon

                                                                                                                          const moveUpIcon: LabIcon;

                                                                                                                            variable newFolderIcon

                                                                                                                            const newFolderIcon: LabIcon;

                                                                                                                              variable notebookIcon

                                                                                                                              const notebookIcon: LabIcon;

                                                                                                                                variable notTrustedIcon

                                                                                                                                const notTrustedIcon: LabIcon;

                                                                                                                                  variable numberingIcon

                                                                                                                                  const numberingIcon: LabIcon;

                                                                                                                                    variable offlineBoltIcon

                                                                                                                                    const offlineBoltIcon: LabIcon;

                                                                                                                                      variable paletteIcon

                                                                                                                                      const paletteIcon: LabIcon;

                                                                                                                                        variable pasteIcon

                                                                                                                                        const pasteIcon: LabIcon;

                                                                                                                                          variable pdfIcon

                                                                                                                                          const pdfIcon: LabIcon;

                                                                                                                                            variable pythonIcon

                                                                                                                                            const pythonIcon: LabIcon;

                                                                                                                                              variable reactIcon

                                                                                                                                              const reactIcon: LabIcon;

                                                                                                                                                variable redoIcon

                                                                                                                                                const redoIcon: LabIcon;

                                                                                                                                                  variable refreshIcon

                                                                                                                                                  const refreshIcon: LabIcon;

                                                                                                                                                    variable regexIcon

                                                                                                                                                    const regexIcon: LabIcon;

                                                                                                                                                      variable rKernelIcon

                                                                                                                                                      const rKernelIcon: LabIcon;

                                                                                                                                                        variable runIcon

                                                                                                                                                        const runIcon: LabIcon;

                                                                                                                                                          variable runningIcon

                                                                                                                                                          const runningIcon: LabIcon;

                                                                                                                                                            variable saveIcon

                                                                                                                                                            const saveIcon: LabIcon;

                                                                                                                                                              variable searchIcon

                                                                                                                                                              const searchIcon: LabIcon;

                                                                                                                                                                variable settingsIcon

                                                                                                                                                                const settingsIcon: LabIcon;

                                                                                                                                                                  variable spreadsheetIcon

                                                                                                                                                                  const spreadsheetIcon: LabIcon;

                                                                                                                                                                    variable stopIcon

                                                                                                                                                                    const stopIcon: LabIcon;

                                                                                                                                                                      variable tabIcon

                                                                                                                                                                      const tabIcon: LabIcon;

                                                                                                                                                                        variable tableRowsIcon

                                                                                                                                                                        const tableRowsIcon: LabIcon;

                                                                                                                                                                          variable tagIcon

                                                                                                                                                                          const tagIcon: LabIcon;

                                                                                                                                                                            variable terminalIcon

                                                                                                                                                                            const terminalIcon: LabIcon;

                                                                                                                                                                              variable textEditorIcon

                                                                                                                                                                              const textEditorIcon: LabIcon;

                                                                                                                                                                                variable tocIcon

                                                                                                                                                                                const tocIcon: LabIcon;

                                                                                                                                                                                  variable treeViewIcon

                                                                                                                                                                                  const treeViewIcon: LabIcon;

                                                                                                                                                                                    variable trustedIcon

                                                                                                                                                                                    const trustedIcon: LabIcon;

                                                                                                                                                                                      variable undoIcon

                                                                                                                                                                                      const undoIcon: LabIcon;

                                                                                                                                                                                        variable vegaIcon

                                                                                                                                                                                        const vegaIcon: LabIcon;

                                                                                                                                                                                          variable yamlIcon

                                                                                                                                                                                          const yamlIcon: LabIcon;

                                                                                                                                                                                            Functions

                                                                                                                                                                                            function Button

                                                                                                                                                                                            Button: (props: IButtonProps & CommonProps<any>) => JSX.Element;

                                                                                                                                                                                              function Checkbox

                                                                                                                                                                                              Checkbox: (props: ICheckboxProps & CommonProps<any>) => JSX.Element;

                                                                                                                                                                                                function classes

                                                                                                                                                                                                classes: (
                                                                                                                                                                                                ...classes: (string | false | { [className: string]: any })[]
                                                                                                                                                                                                ) => string;
                                                                                                                                                                                                • Combines classNames.

                                                                                                                                                                                                  Parameter classes

                                                                                                                                                                                                  A list of classNames

                                                                                                                                                                                                  Returns

                                                                                                                                                                                                  A single string with the combined className

                                                                                                                                                                                                function classesDedupe

                                                                                                                                                                                                classesDedupe: (
                                                                                                                                                                                                ...classes: (string | false | { [className: string]: any })[]
                                                                                                                                                                                                ) => string;
                                                                                                                                                                                                • Combines classNames. Removes all duplicates

                                                                                                                                                                                                  Parameter classes

                                                                                                                                                                                                  A list of classNames

                                                                                                                                                                                                  Returns

                                                                                                                                                                                                  A single string with the combined className

                                                                                                                                                                                                function Collapse

                                                                                                                                                                                                Collapse: (props: ICollapseProps & CommonProps<any>) => JSX.Element;

                                                                                                                                                                                                  function getReactAttrs

                                                                                                                                                                                                  getReactAttrs: (elem: Element, { ignore }?: { ignore?: string[] }) => any;
                                                                                                                                                                                                  • Translates the attributes of a DOM element into attributes that can be understood by React. Currently not comprehensive, we will add special cases as they become relevant.

                                                                                                                                                                                                    Parameter elem

                                                                                                                                                                                                    A DOM element

                                                                                                                                                                                                    Parameter ignore

                                                                                                                                                                                                    An optional list of attribute names to ignore

                                                                                                                                                                                                    Returns

                                                                                                                                                                                                    An object with key:value pairs that are the React-friendly translation of elem's attributes

                                                                                                                                                                                                  function InputGroup

                                                                                                                                                                                                  InputGroup: (props: IInputGroupProps & CommonProps<any>) => JSX.Element;

                                                                                                                                                                                                    function Select

                                                                                                                                                                                                    Select: (props: ISelectProps<any> & CommonProps<any>) => JSX.Element;

                                                                                                                                                                                                      Classes

                                                                                                                                                                                                      class ContextMenuSvg

                                                                                                                                                                                                      class ContextMenuSvg extends ContextMenu implements IDisposable {}
                                                                                                                                                                                                      • An object which implements a universal context menu. Tweaked to use inline svg icons

                                                                                                                                                                                                      constructor

                                                                                                                                                                                                      constructor(options: ContextMenu.IOptions);
                                                                                                                                                                                                      • Construct a new context menu.

                                                                                                                                                                                                        Parameter options

                                                                                                                                                                                                        The options for initializing the menu.

                                                                                                                                                                                                      property isDisposed

                                                                                                                                                                                                      readonly isDisposed: boolean;
                                                                                                                                                                                                      • Test whether the context menu is disposed.

                                                                                                                                                                                                      property menu

                                                                                                                                                                                                      readonly menu: MenuSvg;

                                                                                                                                                                                                        property opened

                                                                                                                                                                                                        readonly opened: ISignal<ContextMenu, void>;
                                                                                                                                                                                                        • A signal fired when the context menu is opened.

                                                                                                                                                                                                        method dispose

                                                                                                                                                                                                        dispose: () => void;
                                                                                                                                                                                                        • Dispose of the resources held by the context menu.

                                                                                                                                                                                                        method open

                                                                                                                                                                                                        open: (event: MouseEvent) => boolean;
                                                                                                                                                                                                        • Open the context menu in response to a 'contextmenu' event.

                                                                                                                                                                                                          Parameter event

                                                                                                                                                                                                          The 'contextmenu' event of interest.

                                                                                                                                                                                                          Returns

                                                                                                                                                                                                          true if the menu was opened, or false if no items matched the event and the menu was not opened.

                                                                                                                                                                                                          #### Notes This method will populate the context menu with items which match the propagation path of the event, then open the menu at the mouse position indicated by the event.

                                                                                                                                                                                                        class DockPanelSvg

                                                                                                                                                                                                        class DockPanelSvg extends DockPanel {}
                                                                                                                                                                                                        • a widget which provides a flexible docking area for widgets. Tweaked to use an inline svg as the close icon

                                                                                                                                                                                                        constructor

                                                                                                                                                                                                        constructor(options?: DockPanelSvg.IOptions);
                                                                                                                                                                                                        • Construct a new dock panel.

                                                                                                                                                                                                          Parameter options

                                                                                                                                                                                                          The options for initializing the panel.

                                                                                                                                                                                                        class FormComponentRegistry

                                                                                                                                                                                                        class FormComponentRegistry implements IFormComponentRegistry {}
                                                                                                                                                                                                        • A registry for rendering fields used in the FormEditor component.

                                                                                                                                                                                                        property renderers

                                                                                                                                                                                                        readonly renderers: { [id: string]: Field };
                                                                                                                                                                                                        • Returns all registered renderers in dictionary form.

                                                                                                                                                                                                          Returns

                                                                                                                                                                                                          - A dictionary that maps an id to a renderer.

                                                                                                                                                                                                        method addRenderer

                                                                                                                                                                                                        addRenderer: (id: string, renderer: Field) => boolean;
                                                                                                                                                                                                        • Adds a renderer for a given id - if the id is already in use, returns false. Otherwise, returns true.

                                                                                                                                                                                                          Parameter id

                                                                                                                                                                                                          Unique ID for the given renderer.

                                                                                                                                                                                                          Parameter renderer

                                                                                                                                                                                                          A function that takes props and returns a rendered component

                                                                                                                                                                                                          Returns

                                                                                                                                                                                                          - Whether the renderer was added successfully. False if the id is already in use.

                                                                                                                                                                                                        method getRenderer

                                                                                                                                                                                                        getRenderer: (id: string) => Field;
                                                                                                                                                                                                        • Returns the renderer for the given id

                                                                                                                                                                                                          Parameter id

                                                                                                                                                                                                          The unique id for the renderer.

                                                                                                                                                                                                          Returns

                                                                                                                                                                                                          - A function that takes props and returns a rendered component.

                                                                                                                                                                                                        class HTMLSelect

                                                                                                                                                                                                        class HTMLSelect extends React.Component<IHTMLSelectProps> {}

                                                                                                                                                                                                          method render

                                                                                                                                                                                                          render: () => JSX.Element;

                                                                                                                                                                                                            class LabIcon

                                                                                                                                                                                                            class LabIcon implements LabIcon.ILabIcon, VirtualElement.IRenderer {}

                                                                                                                                                                                                              constructor

                                                                                                                                                                                                              constructor({
                                                                                                                                                                                                              name,
                                                                                                                                                                                                              svgstr,
                                                                                                                                                                                                              render,
                                                                                                                                                                                                              unrender,
                                                                                                                                                                                                              _loading,
                                                                                                                                                                                                              }: LabIcon.IOptions & { _loading?: boolean });
                                                                                                                                                                                                              • ********* members * *********

                                                                                                                                                                                                              property name

                                                                                                                                                                                                              readonly name: string;

                                                                                                                                                                                                                property react

                                                                                                                                                                                                                readonly react: React.ForwardRefExoticComponent<any>;
                                                                                                                                                                                                                • A React component that will create the icon.

                                                                                                                                                                                                                  Parameter className

                                                                                                                                                                                                                  a string that will be used as the class of the container element. Overrides any existing class

                                                                                                                                                                                                                  Parameter container

                                                                                                                                                                                                                  a preexisting DOM element that will be used as the container for the svg element

                                                                                                                                                                                                                  Parameter label

                                                                                                                                                                                                                  text that will be displayed adjacent to the icon

                                                                                                                                                                                                                  Parameter title

                                                                                                                                                                                                                  a tooltip for the icon

                                                                                                                                                                                                                  Parameter tag

                                                                                                                                                                                                                  if container is not explicitly provided, this tag will be used when creating the container

                                                                                                                                                                                                                  Parameter stylesheet

                                                                                                                                                                                                                  optional string naming a builtin icon stylesheet, for example 'menuItem' or statusBar. Can also be an object defining a custom icon stylesheet, or a list of builtin stylesheet names and/or custom stylesheet objects. If array, the given stylesheets will be merged.

                                                                                                                                                                                                                  See @jupyterlab/ui-components/src/style/icon.ts for details

                                                                                                                                                                                                                  Parameter elementPosition

                                                                                                                                                                                                                  optional position for the inner svg element

                                                                                                                                                                                                                  Parameter elementSize

                                                                                                                                                                                                                  optional size for the inner svg element. Set to 'normal' to get a standard 16px x 16px icon

                                                                                                                                                                                                                  Parameter

                                                                                                                                                                                                                  ...elementCSS - all additional args are treated as overrides for the CSS props applied to the inner svg element

                                                                                                                                                                                                                  Parameter ref

                                                                                                                                                                                                                  forwarded to the ref prop of the icon's svg element

                                                                                                                                                                                                                property svgElement

                                                                                                                                                                                                                readonly svgElement: HTMLElement;

                                                                                                                                                                                                                  property svgInnerHTML

                                                                                                                                                                                                                  readonly svgInnerHTML: string;

                                                                                                                                                                                                                    property svgReactAttrs

                                                                                                                                                                                                                    readonly svgReactAttrs: any;

                                                                                                                                                                                                                      property svgstr

                                                                                                                                                                                                                      svgstr: string;

                                                                                                                                                                                                                        method bindprops

                                                                                                                                                                                                                        bindprops: (props?: LabIcon.IProps) => any;
                                                                                                                                                                                                                        • Get a view of this icon that is bound to the specified icon/style props

                                                                                                                                                                                                                          Parameter optional

                                                                                                                                                                                                                          icon/style props (same as args for .element and .react methods). These will be bound to the resulting view

                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                          a view of this LabIcon instance

                                                                                                                                                                                                                        method element

                                                                                                                                                                                                                        element: (props?: LabIcon.IProps) => HTMLElement;
                                                                                                                                                                                                                        • Create an icon as a DOM element

                                                                                                                                                                                                                          Parameter className

                                                                                                                                                                                                                          a string that will be used as the class of the container element. Overrides any existing class

                                                                                                                                                                                                                          Parameter container

                                                                                                                                                                                                                          a preexisting DOM element that will be used as the container for the svg element

                                                                                                                                                                                                                          Parameter label

                                                                                                                                                                                                                          text that will be displayed adjacent to the icon

                                                                                                                                                                                                                          Parameter title

                                                                                                                                                                                                                          a tooltip for the icon

                                                                                                                                                                                                                          Parameter tag

                                                                                                                                                                                                                          if container is not explicitly provided, this tag will be used when creating the container

                                                                                                                                                                                                                          Parameter stylesheet

                                                                                                                                                                                                                          optional string naming a builtin icon stylesheet, for example 'menuItem' or statusBar. Can also be an object defining a custom icon stylesheet, or a list of builtin stylesheet names and/or custom stylesheet objects. If array, the given stylesheets will be merged.

                                                                                                                                                                                                                          See @jupyterlab/ui-components/src/style/icon.ts for details

                                                                                                                                                                                                                          Parameter elementPosition

                                                                                                                                                                                                                          optional position for the inner svg element

                                                                                                                                                                                                                          Parameter elementSize

                                                                                                                                                                                                                          optional size for the inner svg element. Set to 'normal' to get a standard 16px x 16px icon

                                                                                                                                                                                                                          Parameter

                                                                                                                                                                                                                          ...elementCSS - all additional args are treated as overrides for the CSS props applied to the inner svg element

                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                          A DOM element that contains an (inline) svg element that displays an icon

                                                                                                                                                                                                                        method remove

                                                                                                                                                                                                                        static remove: (container: HTMLElement) => HTMLElement;
                                                                                                                                                                                                                        • Remove any rendered icon from the element that contains it

                                                                                                                                                                                                                          Parameter container

                                                                                                                                                                                                                          a DOM node into which an icon was previously rendered

                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                          the cleaned container

                                                                                                                                                                                                                        method render

                                                                                                                                                                                                                        render: (container: HTMLElement, options?: LabIcon.IRendererOptions) => void;

                                                                                                                                                                                                                          method resolve

                                                                                                                                                                                                                          static resolve: ({ icon }: { icon: LabIcon.IResolvable }) => LabIcon;
                                                                                                                                                                                                                          • Resolve an icon name or a {name, svgstr} pair into an actual LabIcon.

                                                                                                                                                                                                                            Parameter icon

                                                                                                                                                                                                                            either a string with the name of an existing icon or an object with {name: string, svgstr: string} fields.

                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                            a LabIcon instance

                                                                                                                                                                                                                          method resolveElement

                                                                                                                                                                                                                          static resolveElement: ({
                                                                                                                                                                                                                          icon,
                                                                                                                                                                                                                          iconClass,
                                                                                                                                                                                                                          fallback,
                                                                                                                                                                                                                          ...props
                                                                                                                                                                                                                          }: Partial<LabIcon.IResolverProps> & LabIcon.IProps) => HTMLElement;
                                                                                                                                                                                                                          • Resolve an icon name or a {name, svgstr} pair into a DOM element. If icon arg is undefined, the function will fall back to trying to render the icon as a CSS background image, via the iconClass arg. If both icon and iconClass are undefined, this function will return an empty div.

                                                                                                                                                                                                                            Parameter icon

                                                                                                                                                                                                                            optional, either a string with the name of an existing icon or an object with {name: string, svgstr: string} fields

                                                                                                                                                                                                                            Parameter iconClass

                                                                                                                                                                                                                            optional, if the icon arg is not set, the iconClass arg should be a CSS class associated with an existing CSS background-image

                                                                                                                                                                                                                            Parameter props

                                                                                                                                                                                                                            any additional args are passed though to the element method of the resolved icon on render

                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                            a DOM node with the resolved icon rendered into it

                                                                                                                                                                                                                            Deprecated

                                                                                                                                                                                                                            fallback - don't use, optional, a LabIcon instance that will be used if neither icon nor iconClass are defined

                                                                                                                                                                                                                          method resolveReact

                                                                                                                                                                                                                          static resolveReact: ({
                                                                                                                                                                                                                          icon,
                                                                                                                                                                                                                          iconClass,
                                                                                                                                                                                                                          fallback,
                                                                                                                                                                                                                          ...props
                                                                                                                                                                                                                          }: Partial<LabIcon.IResolverProps> & LabIcon.IReactProps) => JSX.Element;
                                                                                                                                                                                                                          • Resolve an icon name or a {name, svgstr} pair into a React component. If icon arg is undefined, the function will fall back to trying to render the icon as a CSS background image, via the iconClass arg. If both icon and iconClass are undefined, the returned component will simply render an empty div.

                                                                                                                                                                                                                            Parameter icon

                                                                                                                                                                                                                            optional, either a string with the name of an existing icon or an object with {name: string, svgstr: string} fields

                                                                                                                                                                                                                            Parameter iconClass

                                                                                                                                                                                                                            optional, if the icon arg is not set, the iconClass arg should be a CSS class associated with an existing CSS background-image

                                                                                                                                                                                                                            Parameter props

                                                                                                                                                                                                                            any additional args are passed though to the React component of the resolved icon on render

                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                            a React component that will render the resolved icon

                                                                                                                                                                                                                            Deprecated

                                                                                                                                                                                                                            fallback - don't use, optional, a LabIcon instance that will be used if neither icon nor iconClass are defined

                                                                                                                                                                                                                          method resolveSvg

                                                                                                                                                                                                                          static resolveSvg: ({ name, svgstr }: LabIcon.IIcon) => HTMLElement | null;
                                                                                                                                                                                                                          • Resolve a {name, svgstr} pair into an actual svg node.

                                                                                                                                                                                                                          method toggleDebug

                                                                                                                                                                                                                          static toggleDebug: (debug?: boolean) => void;
                                                                                                                                                                                                                          • Toggle icon debug from off-to-on, or vice-versa.

                                                                                                                                                                                                                            Parameter debug

                                                                                                                                                                                                                            optional boolean to force debug on or off

                                                                                                                                                                                                                          method unrender

                                                                                                                                                                                                                          unrender: (container: HTMLElement, options?: LabIcon.IRendererOptions) => void;
                                                                                                                                                                                                                            class MenuSvg extends Menu {}
                                                                                                                                                                                                                            • a widget which displays items as a canonical menu. Tweaked to use inline svg icons

                                                                                                                                                                                                                            constructor(options: Menu.IOptions);
                                                                                                                                                                                                                            • construct a new menu. Overrides the default renderer

                                                                                                                                                                                                                              Parameter options

                                                                                                                                                                                                                              The options for initializing the tab bar.

                                                                                                                                                                                                                            insertItem: (index: number, options: Menu.IItemOptions) => Menu.IItem;
                                                                                                                                                                                                                            • insert a menu item into the menu at the specified index. Replaces the default renderer for submenus

                                                                                                                                                                                                                              Parameter index

                                                                                                                                                                                                                              The index at which to insert the item.

                                                                                                                                                                                                                              Parameter options

                                                                                                                                                                                                                              The options for creating the menu item.

                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                              The menu item added to the menu.

                                                                                                                                                                                                                              #### Notes The index will be clamped to the bounds of the items.

                                                                                                                                                                                                                            class RankedMenu

                                                                                                                                                                                                                            class RankedMenu extends Menu implements IRankedMenu {}
                                                                                                                                                                                                                            • An extensible menu for JupyterLab application menus.

                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                            constructor(options: IRankedMenu.IOptions);
                                                                                                                                                                                                                            • Construct a new menu.

                                                                                                                                                                                                                              Parameter options

                                                                                                                                                                                                                              Options for the lumino menu.

                                                                                                                                                                                                                            property menu

                                                                                                                                                                                                                            readonly menu: Menu;
                                                                                                                                                                                                                            • The underlying Lumino menu.

                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                              since v3.1 RankMenu inherits from Menu since v3.1

                                                                                                                                                                                                                            property rank

                                                                                                                                                                                                                            readonly rank: number;
                                                                                                                                                                                                                            • Menu rank.

                                                                                                                                                                                                                            method addGroup

                                                                                                                                                                                                                            addGroup: (items: IRankedMenu.IItemOptions[], rank?: number) => IDisposable;
                                                                                                                                                                                                                            • Add a group of menu items specific to a particular plugin.

                                                                                                                                                                                                                              The rank can be set for all items in the group using the function argument or per item.

                                                                                                                                                                                                                              Parameter items

                                                                                                                                                                                                                              the list of menu items to add.

                                                                                                                                                                                                                              Parameter rank

                                                                                                                                                                                                                              the default rank in the menu in which to insert the group.

                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                              Disposable of the group

                                                                                                                                                                                                                            method addItem

                                                                                                                                                                                                                            addItem: (options: IRankedMenu.IItemOptions) => IDisposableMenuItem;
                                                                                                                                                                                                                            • Add a menu item to the end of the menu.

                                                                                                                                                                                                                              Parameter options

                                                                                                                                                                                                                              The options for creating the menu item.

                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                              The menu item added to the menu.

                                                                                                                                                                                                                            method clearItems

                                                                                                                                                                                                                            clearItems: () => void;
                                                                                                                                                                                                                            • Remove all menu items from the menu.

                                                                                                                                                                                                                            method dispose

                                                                                                                                                                                                                            dispose: () => void;
                                                                                                                                                                                                                            • Dispose of the resources held by the menu.

                                                                                                                                                                                                                            method getRankAt

                                                                                                                                                                                                                            getRankAt: (index: number) => number;
                                                                                                                                                                                                                            • Get the rank of the item at index.

                                                                                                                                                                                                                              Parameter index

                                                                                                                                                                                                                              Item index.

                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                              Rank of the item.

                                                                                                                                                                                                                            method insertItem

                                                                                                                                                                                                                            insertItem: (
                                                                                                                                                                                                                            index: number,
                                                                                                                                                                                                                            options: IRankedMenu.IItemOptions
                                                                                                                                                                                                                            ) => IDisposableMenuItem;
                                                                                                                                                                                                                            • Insert a menu item into the menu at the specified index.

                                                                                                                                                                                                                              Parameter index

                                                                                                                                                                                                                              The index at which to insert the item.

                                                                                                                                                                                                                              Parameter options

                                                                                                                                                                                                                              The options for creating the menu item.

                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                              The menu item added to the menu.

                                                                                                                                                                                                                              #### Notes The index will be clamped to the bounds of the items.

                                                                                                                                                                                                                            method removeItemAt

                                                                                                                                                                                                                            removeItemAt: (index: number) => void;
                                                                                                                                                                                                                            • Remove the item at a given index from the menu.

                                                                                                                                                                                                                              Parameter index

                                                                                                                                                                                                                              The index of the item to remove.

                                                                                                                                                                                                                              #### Notes This is a no-op if the index is out of range.

                                                                                                                                                                                                                            class Switch

                                                                                                                                                                                                                            class Switch extends Widget {}
                                                                                                                                                                                                                            • A Switch widget

                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                            constructor();

                                                                                                                                                                                                                              property caption

                                                                                                                                                                                                                              caption: string;
                                                                                                                                                                                                                              • The caption (title) of the switch.

                                                                                                                                                                                                                              property label

                                                                                                                                                                                                                              label: string;
                                                                                                                                                                                                                              • The visible label of the switch.

                                                                                                                                                                                                                              property value

                                                                                                                                                                                                                              value: boolean;
                                                                                                                                                                                                                              • The value of the switch.

                                                                                                                                                                                                                              property valueChanged

                                                                                                                                                                                                                              readonly valueChanged: ISignal<this, IChangedArgs<boolean, boolean, 'value'>>;
                                                                                                                                                                                                                              • A signal emitted when the value changes.

                                                                                                                                                                                                                              method handleEvent

                                                                                                                                                                                                                              handleEvent: (event: Event) => void;

                                                                                                                                                                                                                                method onAfterAttach

                                                                                                                                                                                                                                protected onAfterAttach: () => void;

                                                                                                                                                                                                                                  method onBeforeDetach

                                                                                                                                                                                                                                  protected onBeforeDetach: () => void;

                                                                                                                                                                                                                                    class TabBarSvg

                                                                                                                                                                                                                                    class TabBarSvg<T> extends TabBar<T> {}
                                                                                                                                                                                                                                    • a widget which displays titles as a single row or column of tabs. Tweaked to use an inline svg as the close icon

                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                    constructor(options?: TabBarSvg.IOptions<T>);
                                                                                                                                                                                                                                    • Construct a new tab bar. Overrides the default renderer.

                                                                                                                                                                                                                                      Parameter options

                                                                                                                                                                                                                                      The options for initializing the tab bar.

                                                                                                                                                                                                                                    class TabPanelSvg

                                                                                                                                                                                                                                    class TabPanelSvg extends TabPanel {}
                                                                                                                                                                                                                                    • A widget which combines a TabBar and a StackedPanel. Tweaked to use an inline svg as the close icon

                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                    constructor(options?: TabPanel.IOptions);
                                                                                                                                                                                                                                    • Construct a new tab panel.

                                                                                                                                                                                                                                      Parameter options

                                                                                                                                                                                                                                      The options for initializing the tab panel.

                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                    interface IDisposableMenuItem

                                                                                                                                                                                                                                    interface IDisposableMenuItem extends IDisposable, Menu.IItem {}
                                                                                                                                                                                                                                    • Interface for disposable item menu

                                                                                                                                                                                                                                    interface IElementRefProps

                                                                                                                                                                                                                                    interface IElementRefProps<E extends HTMLElement> {}

                                                                                                                                                                                                                                      property elementRef

                                                                                                                                                                                                                                      elementRef?: (ref: E | null) => void;
                                                                                                                                                                                                                                      • Ref handler to access the instance of the internal HTML element.

                                                                                                                                                                                                                                      interface IFormComponentRegistry

                                                                                                                                                                                                                                      interface IFormComponentRegistry {}
                                                                                                                                                                                                                                      • A registry for rendering fields used in the FormEditor component.

                                                                                                                                                                                                                                      property addRenderer

                                                                                                                                                                                                                                      addRenderer: (id: string, renderer: Field) => void;
                                                                                                                                                                                                                                      • Adds a renderer for a given id - if the id is already in use, returns false. Otherwise, returns true.

                                                                                                                                                                                                                                        Parameter id

                                                                                                                                                                                                                                        Unique ID for the given renderer.

                                                                                                                                                                                                                                        Parameter renderer

                                                                                                                                                                                                                                        A function that takes props and returns a rendered component

                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                        - Whether the renderer was added successfully. False if the id is already in use.

                                                                                                                                                                                                                                      property getRenderer

                                                                                                                                                                                                                                      getRenderer: (id: string) => Field;
                                                                                                                                                                                                                                      • Returns the renderer for the given id

                                                                                                                                                                                                                                        Parameter id

                                                                                                                                                                                                                                        The unique id for the renderer.

                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                        - A function that takes props and returns a rendered component.

                                                                                                                                                                                                                                      property renderers

                                                                                                                                                                                                                                      renderers: {
                                                                                                                                                                                                                                      [id: string]: Field;
                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                      • Returns all registered renderers in dictionary form.

                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                        - A dictionary that maps an id to a renderer.

                                                                                                                                                                                                                                      interface IHTMLSelectProps

                                                                                                                                                                                                                                      interface IHTMLSelectProps
                                                                                                                                                                                                                                      extends IElementRefProps<HTMLSelectElement>,
                                                                                                                                                                                                                                      React.SelectHTMLAttributes<HTMLSelectElement> {}

                                                                                                                                                                                                                                        property defaultStyle

                                                                                                                                                                                                                                        defaultStyle?: boolean;

                                                                                                                                                                                                                                          property icon

                                                                                                                                                                                                                                          icon?: LabIcon;

                                                                                                                                                                                                                                            property iconProps

                                                                                                                                                                                                                                            iconProps?: LabIcon.IProps;

                                                                                                                                                                                                                                              property options

                                                                                                                                                                                                                                              options?: Array<string | number | IOptionProps>;

                                                                                                                                                                                                                                                interface ILabIconManager

                                                                                                                                                                                                                                                interface ILabIconManager {}
                                                                                                                                                                                                                                                • Placeholder for future icon manager class to assist with overriding/replacing particular sets of icons

                                                                                                                                                                                                                                                interface IOptionProps

                                                                                                                                                                                                                                                interface IOptionProps {}

                                                                                                                                                                                                                                                  property className

                                                                                                                                                                                                                                                  className?: string;
                                                                                                                                                                                                                                                  • A space-delimited list of class names

                                                                                                                                                                                                                                                  property disabled

                                                                                                                                                                                                                                                  disabled?: boolean;
                                                                                                                                                                                                                                                  • Whether this option is non-interactive.

                                                                                                                                                                                                                                                  property label

                                                                                                                                                                                                                                                  label?: string;
                                                                                                                                                                                                                                                  • Label text for this option. If omitted, value is used as the label.

                                                                                                                                                                                                                                                  property value

                                                                                                                                                                                                                                                  value: string | number;
                                                                                                                                                                                                                                                  • Value of this option.

                                                                                                                                                                                                                                                  interface IRankedMenu

                                                                                                                                                                                                                                                  interface IRankedMenu extends IDisposable {}
                                                                                                                                                                                                                                                  • A common interface for extensible JupyterLab application menus.

                                                                                                                                                                                                                                                    Plugins are still free to define their own menus in any way they like. However, JupyterLab defines a few top-level application menus that may be extended by plugins as well, such as "Edit" and "View"

                                                                                                                                                                                                                                                  property items

                                                                                                                                                                                                                                                  readonly items: ReadonlyArray<Menu.IItem>;
                                                                                                                                                                                                                                                  • A read-only array of the menu items in the menu.

                                                                                                                                                                                                                                                  property menu

                                                                                                                                                                                                                                                  readonly menu: Menu;
                                                                                                                                                                                                                                                  • The underlying Lumino menu.

                                                                                                                                                                                                                                                    Deprecated

                                                                                                                                                                                                                                                    will be removed in v4

                                                                                                                                                                                                                                                  property rank

                                                                                                                                                                                                                                                  readonly rank?: number;
                                                                                                                                                                                                                                                  • Menu rank

                                                                                                                                                                                                                                                  method addGroup

                                                                                                                                                                                                                                                  addGroup: (items: Menu.IItemOptions[], rank?: number) => IDisposable;
                                                                                                                                                                                                                                                  • Add a group of menu items specific to a particular plugin.

                                                                                                                                                                                                                                                    The rank can be set for all items in the group using the function argument or per item.

                                                                                                                                                                                                                                                    Parameter items

                                                                                                                                                                                                                                                    the list of menu items to add.

                                                                                                                                                                                                                                                    Parameter rank

                                                                                                                                                                                                                                                    the default rank in the menu in which to insert the group.

                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                    Disposable of the group

                                                                                                                                                                                                                                                  method addItem

                                                                                                                                                                                                                                                  addItem: (options: IRankedMenu.IItemOptions) => Menu.IItem;
                                                                                                                                                                                                                                                  • Add a menu item to the end of the menu.

                                                                                                                                                                                                                                                    Parameter options

                                                                                                                                                                                                                                                    The options for creating the menu item.

                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                    The menu item added to the menu.

                                                                                                                                                                                                                                                    Deprecated

                                                                                                                                                                                                                                                    It will return a IDisposable object in v4

                                                                                                                                                                                                                                                  Namespaces

                                                                                                                                                                                                                                                  namespace CommandPaletteSvg

                                                                                                                                                                                                                                                  namespace CommandPaletteSvg {}

                                                                                                                                                                                                                                                    variable defaultRenderer

                                                                                                                                                                                                                                                    const defaultRenderer: Renderer;

                                                                                                                                                                                                                                                      class Renderer

                                                                                                                                                                                                                                                      class Renderer extends CommandPalette.Renderer {}
                                                                                                                                                                                                                                                      • a modified implementation of the CommandPalette Renderer

                                                                                                                                                                                                                                                      method createIconClass

                                                                                                                                                                                                                                                      createIconClass: (data: CommandPalette.IItemRenderData) => string;
                                                                                                                                                                                                                                                      • Create the class name for the command item icon.

                                                                                                                                                                                                                                                        Parameter data

                                                                                                                                                                                                                                                        The data to use for the class name.

                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                        The full class name for the item icon.

                                                                                                                                                                                                                                                      method renderHeader

                                                                                                                                                                                                                                                      renderHeader: (data: CommandPalette.IHeaderRenderData) => VirtualElement;
                                                                                                                                                                                                                                                      • Render the virtual element for a command palette header.

                                                                                                                                                                                                                                                        Parameter data

                                                                                                                                                                                                                                                        The data to use for rendering the header.

                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                        A virtual element representing the header.

                                                                                                                                                                                                                                                      method renderItemIcon

                                                                                                                                                                                                                                                      renderItemIcon: (data: CommandPalette.IItemRenderData) => VirtualElement;
                                                                                                                                                                                                                                                      • Render the icon for a command palette item.

                                                                                                                                                                                                                                                        Parameter data

                                                                                                                                                                                                                                                        The data to use for rendering the icon.

                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                        A virtual element representing the icon.

                                                                                                                                                                                                                                                      namespace DockPanelSvg

                                                                                                                                                                                                                                                      namespace DockPanelSvg {}

                                                                                                                                                                                                                                                        variable defaultRenderer

                                                                                                                                                                                                                                                        const defaultRenderer: Renderer;

                                                                                                                                                                                                                                                          class Renderer

                                                                                                                                                                                                                                                          class Renderer extends DockPanel.Renderer {}
                                                                                                                                                                                                                                                          • A modified implementation of the DockPanel Renderer.

                                                                                                                                                                                                                                                          method createTabBar

                                                                                                                                                                                                                                                          createTabBar: () => TabBarSvg<Widget>;
                                                                                                                                                                                                                                                          • Create a new tab bar (with inline svg icons enabled for use with a dock panel.

                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                            A new tab bar for a dock panel.

                                                                                                                                                                                                                                                          interface IOptions

                                                                                                                                                                                                                                                          interface IOptions extends DockPanel.IOptions {}

                                                                                                                                                                                                                                                            property translator

                                                                                                                                                                                                                                                            translator?: ITranslator;
                                                                                                                                                                                                                                                            • The application language translator.

                                                                                                                                                                                                                                                            namespace IRankedMenu

                                                                                                                                                                                                                                                            namespace IRankedMenu {}
                                                                                                                                                                                                                                                            • Namespace for JupyterLabMenu interfaces

                                                                                                                                                                                                                                                            variable DEFAULT_RANK

                                                                                                                                                                                                                                                            const DEFAULT_RANK: number;
                                                                                                                                                                                                                                                            • Default menu item rank

                                                                                                                                                                                                                                                            interface IItemOptions

                                                                                                                                                                                                                                                            interface IItemOptions extends Menu.IItemOptions {}
                                                                                                                                                                                                                                                            • An options object for creating a menu item.

                                                                                                                                                                                                                                                            property rank

                                                                                                                                                                                                                                                            rank?: number;
                                                                                                                                                                                                                                                            • Menu item rank

                                                                                                                                                                                                                                                            interface IOptions

                                                                                                                                                                                                                                                            interface IOptions extends Menu.IOptions {}
                                                                                                                                                                                                                                                            • An options object for creating a JupyterLab menu.

                                                                                                                                                                                                                                                            property includeSeparators

                                                                                                                                                                                                                                                            includeSeparators?: boolean;
                                                                                                                                                                                                                                                            • Whether to include separators between the groups that are added to the menu.

                                                                                                                                                                                                                                                              Default: true

                                                                                                                                                                                                                                                            property rank

                                                                                                                                                                                                                                                            rank?: number;
                                                                                                                                                                                                                                                            • Menu rank

                                                                                                                                                                                                                                                            namespace LabIcon

                                                                                                                                                                                                                                                            namespace LabIcon {}
                                                                                                                                                                                                                                                            • A namespace for LabIcon statics.

                                                                                                                                                                                                                                                            interface IIcon

                                                                                                                                                                                                                                                            interface IIcon {}
                                                                                                                                                                                                                                                            • The simplest possible interface for defining a generic icon.

                                                                                                                                                                                                                                                            property name

                                                                                                                                                                                                                                                            readonly name: string;
                                                                                                                                                                                                                                                            • The name of the icon. By convention, the icon name will be namespaced as so:

                                                                                                                                                                                                                                                              "pkg-name:icon-name"

                                                                                                                                                                                                                                                            property svgstr

                                                                                                                                                                                                                                                            svgstr: string;
                                                                                                                                                                                                                                                            • A string containing the raw contents of an svg file.

                                                                                                                                                                                                                                                            interface ILabIcon

                                                                                                                                                                                                                                                            interface ILabIcon extends IIcon, VirtualElement.IRenderer {}
                                                                                                                                                                                                                                                            • The ILabIcon interface. Outside of this interface the actual implementation of LabIcon may vary

                                                                                                                                                                                                                                                            interface IOptions

                                                                                                                                                                                                                                                            interface IOptions extends IIcon, Partial<VirtualElement.IRenderer> {}
                                                                                                                                                                                                                                                            • Interface defining the parameters to be passed to the LabIcon constructor

                                                                                                                                                                                                                                                            interface IProps

                                                                                                                                                                                                                                                            interface IProps extends LabIconStyle.IProps {}
                                                                                                                                                                                                                                                            • The input props for creating a new LabIcon

                                                                                                                                                                                                                                                            property className

                                                                                                                                                                                                                                                            className?: string;
                                                                                                                                                                                                                                                            • Extra classNames. Used in addition to the typestyle className to set the className of the icon's outermost container node

                                                                                                                                                                                                                                                            property container

                                                                                                                                                                                                                                                            container?: HTMLElement;
                                                                                                                                                                                                                                                            • The icon's outermost node, which acts as a container for the actual svg node. If container is not supplied, it will be created

                                                                                                                                                                                                                                                            property label

                                                                                                                                                                                                                                                            label?: string;
                                                                                                                                                                                                                                                            • Optional text label that will be added as a sibling to the icon's svg node

                                                                                                                                                                                                                                                            property tag

                                                                                                                                                                                                                                                            tag?: 'div' | 'span';
                                                                                                                                                                                                                                                            • HTML element tag used to create the icon's outermost container node, if no container is passed in

                                                                                                                                                                                                                                                            property title

                                                                                                                                                                                                                                                            title?: string;
                                                                                                                                                                                                                                                            • Optional title that will be set on the icon's outermost container node

                                                                                                                                                                                                                                                            interface IRendererOptions

                                                                                                                                                                                                                                                            interface IRendererOptions {}

                                                                                                                                                                                                                                                              property attrs

                                                                                                                                                                                                                                                              attrs?: ElementAttrs;

                                                                                                                                                                                                                                                                property children

                                                                                                                                                                                                                                                                children?: ReadonlyArray<VirtualNode>;

                                                                                                                                                                                                                                                                  property props

                                                                                                                                                                                                                                                                  props?: IProps;

                                                                                                                                                                                                                                                                    interface IResolverProps

                                                                                                                                                                                                                                                                    interface IResolverProps {}

                                                                                                                                                                                                                                                                      property fallback

                                                                                                                                                                                                                                                                      fallback?: LabIcon;

                                                                                                                                                                                                                                                                        property icon

                                                                                                                                                                                                                                                                        icon?: IMaybeResolvable;

                                                                                                                                                                                                                                                                          property iconClass

                                                                                                                                                                                                                                                                          iconClass?: string;

                                                                                                                                                                                                                                                                            type IMaybeResolvable

                                                                                                                                                                                                                                                                            type IMaybeResolvable = IResolvable | VirtualElement.IRenderer | undefined;
                                                                                                                                                                                                                                                                            • A type that maybe can be resolved to a LabIcon instance.

                                                                                                                                                                                                                                                                            type IReact

                                                                                                                                                                                                                                                                            type IReact = React.ForwardRefExoticComponent<IReactProps>;
                                                                                                                                                                                                                                                                            • The complete type of the React component stored in the .react field of a LabIcon.

                                                                                                                                                                                                                                                                            type IReactProps

                                                                                                                                                                                                                                                                            type IReactProps = IProps & React.RefAttributes<SVGElement>;
                                                                                                                                                                                                                                                                            • The properties that can be passed into the React component stored in the .react field of a LabIcon.

                                                                                                                                                                                                                                                                            type IReactRef

                                                                                                                                                                                                                                                                            type IReactRef = React.RefObject<SVGElement>;
                                                                                                                                                                                                                                                                            • The type of the svg node ref that can be passed into icon React components

                                                                                                                                                                                                                                                                            type IResolvable

                                                                                                                                                                                                                                                                            type IResolvable = string | (IIcon & Partial<VirtualElement.IRenderer>);
                                                                                                                                                                                                                                                                            • A type that can be resolved to a LabIcon instance.

                                                                                                                                                                                                                                                                            namespace MenuSvg {}
                                                                                                                                                                                                                                                                              const defaultRenderer: Renderer;
                                                                                                                                                                                                                                                                                overrideDefaultRenderer: (menu: Menu) => void;
                                                                                                                                                                                                                                                                                  class Renderer extends Menu.Renderer {}
                                                                                                                                                                                                                                                                                  • a modified implementation of the Menu Renderer

                                                                                                                                                                                                                                                                                  createIconClass: (data: Menu.IRenderData) => string;
                                                                                                                                                                                                                                                                                  • Create the class name for the menu item icon.

                                                                                                                                                                                                                                                                                    Parameter data

                                                                                                                                                                                                                                                                                    The data to use for the class name.

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    The full class name for the item icon.

                                                                                                                                                                                                                                                                                  renderIcon: (data: Menu.IRenderData) => VirtualElement;
                                                                                                                                                                                                                                                                                  • Render the icon element for a menu item.

                                                                                                                                                                                                                                                                                    Parameter data

                                                                                                                                                                                                                                                                                    The data to use for rendering the icon.

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    A virtual element representing the item icon.

                                                                                                                                                                                                                                                                                  renderSubmenu: (data: Menu.IRenderData) => VirtualElement;
                                                                                                                                                                                                                                                                                  • Render the submenu icon element for a menu item.

                                                                                                                                                                                                                                                                                    Parameter data

                                                                                                                                                                                                                                                                                    The data to use for rendering the submenu icon.

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    A virtual element representing the submenu icon.

                                                                                                                                                                                                                                                                                  namespace TabBarSvg

                                                                                                                                                                                                                                                                                  namespace TabBarSvg {}

                                                                                                                                                                                                                                                                                    variable defaultRenderer

                                                                                                                                                                                                                                                                                    const defaultRenderer: Renderer;

                                                                                                                                                                                                                                                                                      class Renderer

                                                                                                                                                                                                                                                                                      class Renderer extends TabBar.Renderer {}
                                                                                                                                                                                                                                                                                      • A modified implementation of the TabBar Renderer.

                                                                                                                                                                                                                                                                                      method renderCloseIcon

                                                                                                                                                                                                                                                                                      renderCloseIcon: (data: TabBar.IRenderData<any>) => VirtualElement;
                                                                                                                                                                                                                                                                                      • Render the close icon element for a tab.

                                                                                                                                                                                                                                                                                        Parameter data

                                                                                                                                                                                                                                                                                        The data to use for rendering the tab.

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        A virtual element representing the tab close icon.

                                                                                                                                                                                                                                                                                      interface IOptions

                                                                                                                                                                                                                                                                                      interface IOptions<T> extends TabBar.IOptions<T> {}

                                                                                                                                                                                                                                                                                        property translator

                                                                                                                                                                                                                                                                                        translator?: ITranslator;
                                                                                                                                                                                                                                                                                        • The application language translator.

                                                                                                                                                                                                                                                                                        Package Files (14)

                                                                                                                                                                                                                                                                                        Dependencies (15)

                                                                                                                                                                                                                                                                                        Dev Dependencies (15)

                                                                                                                                                                                                                                                                                        Peer Dependencies (1)

                                                                                                                                                                                                                                                                                        Badge

                                                                                                                                                                                                                                                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                                                                                                                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@jupyterlab/ui-components.

                                                                                                                                                                                                                                                                                        • Markdown
                                                                                                                                                                                                                                                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@jupyterlab/ui-components)
                                                                                                                                                                                                                                                                                        • HTML
                                                                                                                                                                                                                                                                                          <a href="https://www.jsdocs.io/package/@jupyterlab/ui-components"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>