@jupyterlab/ui-components/lib/components/search.d.ts

JupyterLab - UI components written in React

import { ReactWidget } from './vdom';
import React from 'react';
import { ISignal } from '@lumino/signaling';
/**
 * The class name added to the filebrowser crumbs node.
 */
export interface IFilterBoxProps {
    /**
     * Whether to use case-sensitive search
     */
    caseSensitive?: boolean;
    /**
     * Whether the search box is disabled or not.
     */
    disabled?: boolean;
    /**
     * Whether to force a refresh.
     */
    forceRefresh?: boolean;
    /**
     * An optional initial search value.
     */
    initialQuery?: string;
    /**
     * Pass a ref to the input element
     */
    inputRef?: React.RefObject<HTMLInputElement>;
    /**
     * Optional placeholder for the search box.
     */
    placeholder?: string;
    /**
     * Whether to show a search icon in the box.
     */
    showIcon?: boolean;
    /**
     * A function to callback when filter is updated.
     */
    updateFilter: (filterFn: (item: string) => Partial<IScore> | null, query?: string) => void;
    /**
     * Whether to use the fuzzy filter.
     */
    useFuzzyFilter?: boolean;
    /**
     * Signal emitted when filter settings change
     */
    filterSettingsChanged?: ISignal<unknown, {
        [P in keyof IFilterBoxProps]?: IFilterBoxProps[P];
    }>;
}
/**
 * A text match score with associated content item.
 */
export interface IScore {
    /**
     * The numerical score for the text match.
     */
    score: number;
    /**
     * The indices of the text matches.
     */
    indices: number[] | null;
}
/**
 * Perform a fuzzy search on a single item.
 */
export declare function fuzzySearch(source: string, query: string): IScore | null;
export declare const updateFilterFunction: (value: string, useFuzzyFilter?: boolean, caseSensitive?: boolean) => (item: string) => Partial<IScore> | null;
export declare const FilterBox: (props: IFilterBoxProps) => JSX.Element;
/**
 * Function which returns a widget that hosts an input textbox to filter on file names.
 */
export declare const FilenameSearcher: (props: IFilterBoxProps) => ReactWidget;